Group API documentation version v1
Application_URL/services/api/v1
About Groups
You use this feature to group together different business objects for multiple purposes
Purpose
This API allows you to create, update, retrieve, delete a group and assign,retrive business objects which are associated with the group.
/groups
This endpoint reads all the groups
This endpoint allows you to create a group.
This endpoint allows you edit group details.
This endpoint allows you to delete group(s).
get /groups
This endpoint reads all the groups
REST API supports Basic Authentication
HTTP status code 200
Successfully creates a group
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"properties": {
"creationTime": {
"id": "/items/properties/creationTime",
"type": "string"
},
"criticalityCode": {
"id": "/items/properties/criticalityCode",
"type": "string"
},
"displayId": {
"id": "/items/properties/displayId",
"type": "string"
},
"groupTypeCode": {
"id": "/items/properties/groupTypeCode",
"type": "string"
},
"groupTypeCount": {
"id": "/items/properties/groupTypeCount",
"type": "integer"
},
"id": {
"id": "/items/properties/id",
"type": "string"
},
"lastEditedTime": {
"id": "/items/properties/lastEditedTime",
"type": "string"
},
"longDescription": {
"id": "/items/properties/longDescription",
"type": "string"
},
"normalizedRiskScore": {
"id": "/items/properties/normalizedRiskScore",
"type": "integer"
},
"objectCount": {
"id": "/items/properties/objectCount",
"type": "integer"
},
"riskColorCode": {
"id": "/items/properties/riskColorCode",
"type": "string"
},
"riskValue": {
"id": "/items/properties/riskValue",
"type": "integer"
},
"shortDescription": {
"id": "/items/properties/shortDescription",
"type": "string"
},
"status": {
"id": "/items/properties/status",
"type": "integer"
},
"version": {
"id": "/items/properties/version",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"id": "8151E85F76094EC5AFA37F897A87E9BE",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "handover1",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "HC",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "handover",
"longDescription": "",
"lastEditedTime": "2017-05-09",
"creationTime": "2017-05-09"
},
{
"id": "A014EF9AFA6C4211B43745C1FD624CE5",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "Adi_test_New",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "HC",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "Adi_test_New",
"longDescription": "Adi_test_New",
"lastEditedTime": "2017-05-09",
"creationTime": "2017-05-09",
},
{
"id": "AB003753747F4432A1322DD7CB277509",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "Test_New_Adi_GRP",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "Test_New_Adi_GRP",
"longDescription": "Test_New_Adi_GRP",
"lastEditedTime": "2017-05-03",
"creationTime": "2017-05-03"
},
{
"id": "A7275A662BD4466B8DA90D4D9255AB62",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copyViaPostmanError544",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyViaPostmanError",
"longDescription": "copyViaPostmanError",
"lastEditedTime": "2017-05-02",
"creationTime": "2017-05-02"
},
{
"id": "09CE654034604101AE7727E5883AAD0E",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copyViaPostmanError5444",
"version": 1,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyViaPostmanError",
"longDescription": "copyViaPostmanError",
"lastEditedTime": "2017-05-02",
"creationTime": "2017-05-02"
},
{
"id": "6DE468682C384F5BBAF1F9C986430000",
"status": 2,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "testCreateTimeline1",
"version": 3,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "testCreateTimeline1",
"longDescription": "testCreateTimeline",
"lastEditedTime": "2017-05-02",
"creationTime": "2017-05-02"
},
{
"id": "12544D9257D645CA9CA228AB6B30A052",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "GroupTest_Group_Adi",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "GroupTest_Group_Adi",
"longDescription": "GroupTest_Group_Adi",
"lastEditedTime": "2017-05-02",
"creationTime": "2017-05-02"
},
{
"id": "DA0FD6D1A6E6473C80D4A3FAA32CD973",
"status": 2,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "Adi_test",
"version": 1,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "Adi_test",
"longDescription": "Adi_test",
"lastEditedTime": "2017-04-26",
"creationTime": "2017-04-26"
},
{
"id": "471572420793457DA4075859B7AE0847",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "TestG10P",
"version": 1,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "Testing Groups8",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "ED94B76D3A3A4519A163DEF543C6FB35",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "hello1234newtest",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "hello1234newtest",
"longDescription": "hello1234newtest",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "567ED495B9FE4606BB72C2609C467CF4",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copyViaPostmanError4",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyViaPostmanError",
"longDescription": "copyViaPostmanError",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "EA9AD17153D443C8B549110D9C8BC1A2",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copyViaPostmanError2",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyViaPostmanError",
"longDescription": "copyViaPostmanError",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "13B1E4EFBF384AE193EE572179B0B676",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copyViaPostmanError",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyViaPostmanError",
"longDescription": "copyViaPostmanError",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "8955D1BBBD4C424D98992B80238D4862",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copyViaPostman",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyViaPostman",
"longDescription": "copyViaPostman",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "8955D1BBBD4C424D98992B80238D4862",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copyViaPostman",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "GEN",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyViaPostman",
"longDescription": "copyViaPostman",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "copyGroup",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copiedGroup",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "FMEA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyingGroup",
"longDescription": "copyingViaHanaStudio",
"author": "Viji Selvarajan",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "copyGroup",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "copiedGroup",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "copyingGroup",
"longDescription": "copyingViaHanaStudio",
"lastEditedTime": "2017-04-25",
"creationTime": "2017-04-25"
},
{
"id": "4D12579A4747427B8AD766A56959E74D",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "hello1234new",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "hello1234new",
"longDescription": "hello1234new",
"lastEditedTime": "2017-04-24",
"creationTime": "2017-04-24"
},
{
"id": "2C25BFCCC8724353A3A94419ED3E3CBC",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "hello1234new",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "hello1234new",
"longDescription": "hello1234new",
"lastEditedTime": "2017-04-24",
"creationTime": "2017-04-24"
},
{
"id": "1C99AE3670F94950A08B10D78CD80287",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "hello1234new",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "hello1234new",
"longDescription": "hello1234new",
"lastEditedTime": "2017-04-24",
"creationTime": "2017-04-24"
},
{
"id": "5A962AEA4EBA4231BF6DEE130E3DEE89",
"status": 3,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "TestG9",
"version": 9,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "Testing Groups8",
"lastEditedTime": "2017-04-24",
"creationTime": "2017-04-04"
},
{
"id": "5C33E9F335E94253A0E2EC7367E7B280",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "TestG10",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "Testing Groups8",
"lastEditedTime": "2017-04-24",
"creationTime": "2017-04-21"
},
{
"id": "F5AA256AB25B46E6A4B2DF17BFD39B85",
"status": 3,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "newAAAAAAAAAAAA",
"version": 2,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "wAAAAAAAAAAAAAAAAAAA",
"lastEditedTime": "2017-04-23",
"creationTime": "2017-04-04"
},
{
"id": "5FA681D9F8E54462BC3BBBB6550CF2EF",
"status": 2,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "hello1",
"version": 1,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "hello1",
"longDescription": "hello1",
"lastEditedTime": "2017-04-21",
"creationTime": "2017-04-20"
},
{
"id": "C3F36A0E223043348A45D7E801157247",
"status": 1,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "hello123",
"version": 0,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "hello123",
"longDescription": "hello231",
"lastEditedTime": "2017-04-20",
"creationTime": "2017-04-20"
},
{
"id": "39223D4BF64C4BC1A5B0B78E710FEC07",
"status": 2,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "testforval",
"version": 1,
"groupTypeCount": 1,
"groupTypeCode": "CA",
"riskColorCode": "",
"criticalityCode": "",
"shortDescription": "testforval",
"longDescription": "testforval",
"lastEditedTime": "2017-04-19",
"creationTime": "2017-04-12"
}
]Secured by basic
post /groups
This endpoint allows you to create a group.
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"businessObjectTypes": {
"type": "array",
"id": "/properties/businessObjectTypes",
"items": {
"type": "string",
"description": "An array of business object types relevant to the group",
"enum": [
"EQU",
"FL",
"INS",
"ANN",
"DOC",
"MOD",
"PRT",
"CAT"
]
}
},
"groupType": {
"id": "/properties/groupType",
"items": {
"description": "Type for which the group is being created. A selection can be made for the enums available below",
"enum": [
"FMEA",
"CA",
"GEN",
"HC",
"PRO"
],
"id": "/properties/groupType/items",
"type": "string"
},
"type": "array"
},
"longDescription": {
"description": "Long description for the group created",
"id": "/properties/longDescription",
"maxLength": 5000,
"type": "string"
},
"shortDescription": {
"description": "Long description for the group created",
"id": "/properties/shortDescription",
"maxLength": 256,
"type": "string"
},
"descriptions": {
"type": "array",
"id":"/properties/descriptions",
"items": [
{
"type": "object",
"properties": {
"languageISOCode": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"longDescription": {
"type": "string"
}
},
"required": [
"languageISOCode",
"shortDescription"
]
},
{
"type": "object",
"properties": {
"languageISOCode": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"longDescription": {
"type": "string"
}
},
"required": [
"languageISOCode",
"shortDescription"
]
}
]
}
},
"type": "object"
}Example:
{
"shortDescription":"validationtestnew",
"longDescription":"validationtestnew",
"groupType":[
"FMEA"
],
"businessObjectTypes":[
"EQU",
"FL"
],
"descriptions":[
{
"languageISOCode":"en",
"shortDescription":"en-short",
"longDescription":"en-long"
},
{
"languageISOCode":"de",
"shortDescription":"de-short",
"longDescription":"de-long"
}
]
}HTTP status code 200
Successfully creates a group
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "ID of the group created(UUID)",
"id": "/properties/id",
"type": "string"
},
"status": {
"default": true,
"description": "Boolean value to state whether the group was successfully created",
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "C3F36A0E223043348A45D7E801157247",
"status": true
}Secured by basic
put /groups
This endpoint allows you edit group details.
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"businessObjectTypes": {
"id": "/properties/businessObjectTypes",
"items": {
"id": "/properties/businessObjectTypes/items",
"type": "string"
},
"type": "array"
},
"id": {
"id": "/properties/id",
"type": "string"
},
"longDescription": {
"id": "/properties/longDescription",
"type": "string"
},
"shortDescription": {
"id": "/properties/shortDescription",
"type": "string"
},
"descriptions": {
"type": "array",
"id":"/properties/descriptions",
"items": [
{
"type": "object",
"properties": {
"languageISOCode": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"longDescription": {
"type": "string"
}
},
"required": [
"languageISOCode",
"shortDescription"
]
},
{
"type": "object",
"properties": {
"languageISOCode": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"longDescription": {
"type": "string"
}
},
"required": [
"languageISOCode",
"shortDescription"
]
}
]
}
},
"type": "object"
}Example:
{
"id":"6DE468682C384F5BBAF1F9C986430000",
"shortDescription":"ty123",
"longDescription":"ty",
"businessObjectTypes":["EQU"],
"descriptions": [
{
"languageISOCode": "en",
"shortDescription": "en-short",
"longDescription": "en-long"
},
{
"languageISOCode": "de",
"shortDescription": "de-short",
"longDescription": "de-long"
}
]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"id": {
"id": "/properties/id",
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "6DE468682C384F5BBAF1F9C986430000",
"status": true
}HTTP status code 400
Bad request, For example when trying to update without a mandatory column.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"errorMessages": {
"id": "/properties/errorMessages",
"items": {
"id": "/properties/errorMessages/items",
"properties": {
"EntitiesNotFound": {
"id": "/properties/errorMessages/items/properties/EntitiesNotFound",
"items": {},
"type": "array"
},
"errorMessage": {
"id": "/properties/errorMessages/items/properties/errorMessage",
"type": "string"
},
"messageCode": {
"id": "/properties/errorMessages/items/properties/messageCode",
"type": "string"
},
"repeatedEntities": {
"id": "/properties/errorMessages/items/properties/repeatedEntities",
"items": {},
"type": "array"
},
"severity": {
"id": "/properties/errorMessages/items/properties/severity",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"statusCode": {
"id": "/properties/statusCode",
"type": "integer"
}
},
"type": "object"
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "displayId cannot be empty.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "REU201"
}
]
}Secured by basic
delete /groups
This endpoint allows you to delete group(s).
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"type": "string"
},
"type": "array"
}Example:
["A81713100457447B85C97F0DB5A9585"] HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"id": "/properties/id",
"type": "null"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": null,
"status": true
}HTTP status code 400
Bad Request,if groupId is invalid
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"id": {
"id": "/properties/id",
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The following group IDs do not exist: A81713100457447B85C97F0DB5A9C58.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by basic
/groups/{groupId}/assign
This endpoint allows you to add business objects to a group.
post /groups/{groupId}/assign
This endpoint allows you to add business objects to a group.
REST API supports Basic Authentication
URI Parameters
- groupId: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"properties": {
"businessObjectType": {
"description": "The business object type of the specified ID. The selection is possible from the enums given below",
"enum": [
"EQU",
"FL",
"INS",
"ANN",
"DOC",
"MOD",
"PRT",
"CAT"
],
"id": "/items/properties/businessObjectType",
"type": "string"
},
"businessObjectId": {
"description": "The ID of the business Object to be added to the group",
"id": "/items/properties/businessObjectId",
"maxLength": 32,
"type": "string"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"businessObjectType":"INS",
"businessObjectId":"371016E4F1B34FA9BCE03D2910FCFC4F"
},
{
"businessObjectType":"FL",
"businessObjectId":"371016E4F1B34FA9BCE03D2910FNFC4F"
}
]HTTP status code 200
Successfully creates a group
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "ID of the group created(UUID)",
"id": "/properties/id",
"type": "string"
},
"status": {
"default": true,
"description": "Boolean value to state whether the group was successfully created",
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "C3F36A0E223043348A45D7E801157247",
"status": true
}Secured by basic
/groups/{groupId}/dissociate
This endpoint allows you to delete business objects from a group.
put /groups/{groupId}/dissociate
This endpoint allows you to delete business objects from a group.
REST API supports Basic Authentication
URI Parameters
- groupId: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"properties": {
"businessObjectType": {
"description": "The business object type of the specified ID. The selection is possible from the enums given below",
"enum": [
"EQU",
"FL",
"INS",
"ANN",
"DOC",
"MOD",
"PRT",
"CAT"
],
"id": "/items/properties/businessObjectType",
"type": "string"
},
"businessObjectId": {
"description": "The ID of the business Object to be added to the group",
"id": "/items/properties/businessObjectId",
"maxLength": 32,
"type": "string"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"businessObjectType":"INS",
"businessObjectId":"371016E4F1B34FA9BCE03D2910FCFC4F"
},
{
"businessObjectType":"FL",
"businessObjectId":"371016E4F1B34FA9BCE03D2910FNFC4F"
}
]HTTP status code 200
Successfully creates a group
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"description": "ID of the group created(UUID)",
"id": "/properties/id",
"type": "string"
},
"status": {
"default": true,
"description": "Boolean value to state whether the group was successfully created",
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": "C3F36A0E223043348A45D7E801157247",
"status": true
}Secured by basic
/groups/{groupId}/businessobjects
This endpoint allows you to see all the valid business objects for a group.
get /groups/{groupId}/businessobjects
This endpoint allows you to see all the valid business objects for a group.
REST API supports Basic Authentication
URI Parameters
- groupId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"properties": {
"businessObjectId": {
"description": "The ID of the business Object which is part of the group",
"id": "/items/properties/businessObjectId",
"maxLength": 32,
"type": "string"
},
"businessObjectType": {
"default": "EQU",
"description": "The business object type of the business object. The business object type should be part of one of the enums below",
"enum": [
"EQU",
"FL",
"INS",
"ANN",
"DOC",
"MOD",
"PRT",
"CAT"
],
"id": "/items/properties/businessObjectType",
"type": "string"
},
"groupVersion": {
"description": "The last version of the group",
"id": "/items/properties/groupVersion",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"businessObjectType": "EQU",
"businessObjectId": "49D2719CF4AB4AA6864E8C0A4772E399",
"groupVersion": 0
},
{
"businessObjectType": "EQU",
"businessObjectId": "28D484AF6AF6422B8BFA6BA95665C59A",
"groupVersion": 0
},
{
"businessObjectType": "CAT",
"businessObjectId": "597DDEBDEEDC48228F0B5A339ADA8152",
"groupVersion": 0
},
{
"businessObjectType": "PRT",
"businessObjectId": "1283325830B86838E10000000A78416B",
"groupVersion": 0
},
{
"businessObjectType": "DOC",
"businessObjectId": "94ED84B20A934C918A540EF989F9B7E0",
"groupVersion": 0
},
{
"businessObjectType": "DOC",
"businessObjectId": "FA3AD927411F4FD38753DFD3CF574DA0",
"groupVersion": 0
}
]HTTP status code 400
The request could not be understood by the server due to malformed syntax.You SHOULD NOT repeat the request without modifications.
HTTP status code 403
User is not authorized to know information about the group
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/groups/type/{groupTypeId}/businessobjects
This endpoint allows you to see all the valid business objects for a group.
get /groups/type/{groupTypeId}/businessobjects
This endpoint allows you to see all the valid business objects for a group.
REST API supports Basic Authentication
URI Parameters
- groupTypeId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"items": {
"id": "/items",
"properties": {
"businessObjectCode": {
"id": "/items/properties/businessObjectCode",
"type": "string"
},
"businessObjectCount": {
"id": "/items/properties/businessObjectCount",
"type": "integer"
},
"businessObjectType": {
"id": "/items/properties/businessObjectType",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 0
},
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
}
]HTTP status code 400
Bad Request,if grouptype is invalid
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"errorMessages": {
"id": "/properties/errorMessages",
"items": {
"id": "/properties/errorMessages/items",
"properties": {
"EntitiesNotFound": {
"id": "/properties/errorMessages/items/properties/EntitiesNotFound",
"items": {},
"type": "array"
},
"errorMessage": {
"id": "/properties/errorMessages/items/properties/errorMessage",
"type": "string"
},
"messageCode": {
"id": "/properties/errorMessages/items/properties/messageCode",
"type": "string"
},
"repeatedEntities": {
"id": "/properties/errorMessages/items/properties/repeatedEntities",
"items": {},
"type": "array"
},
"severity": {
"id": "/properties/errorMessages/items/properties/severity",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"statusCode": {
"id": "/properties/statusCode",
"type": "integer"
}
},
"type": "object"
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "Default Error Message",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by basic
/groups/{groupId}
This endpoint allows you to see all the information about the group.
get /groups/{groupId}
This endpoint allows you to see all the information about the group.
REST API supports Basic Authentication
URI Parameters
- groupId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"author": {
"id": "/properties/author",
"type": "string"
},
"botypeCount": {
"id": "/properties/botypeCount",
"items": {
"id": "/properties/botypeCount/items",
"properties": {
"businessObjectCode": {
"id": "/properties/botypeCount/items/properties/businessObjectCode",
"type": "string"
},
"businessObjectCount": {
"id": "/properties/botypeCount/items/properties/businessObjectCount",
"type": "integer"
},
"businessObjectType": {
"id": "/properties/botypeCount/items/properties/businessObjectType",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"creationTime": {
"id": "/properties/creationTime",
"type": "string"
},
"displayId": {
"id": "/properties/displayId",
"type": "string"
},
"groupScope": {
"id": "/properties/groupScope",
"items": {
"id": "/properties/groupScope/items",
"properties": {
"groupTypeCode": {
"id": "/properties/groupScope/items/properties/groupTypeCode",
"type": "string"
},
"groupTypeDescription": {
"id": "/properties/groupScope/items/properties/groupTypeDescription",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"groupTypeCount": {
"id": "/properties/groupTypeCount",
"type": "integer"
},
"id": {
"id": "/properties/id",
"type": "string"
},
"lastChangeBy": {
"id": "/properties/lastChangeBy",
"type": "string"
},
"lastEditedTime": {
"id": "/properties/lastEditedTime",
"type": "string"
},
"longDescription": {
"id": "/properties/longDescription",
"type": "string"
},
"normalizedRiskScore": {
"id": "/properties/normalizedRiskScore",
"type": "integer"
},
"objectCount": {
"id": "/properties/objectCount",
"type": "integer"
},
"riskValue": {
"id": "/properties/riskValue",
"type": "integer"
},
"shortDescription": {
"id": "/properties/shortDescription",
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "integer"
},
"totalObjectCount": {
"id": "/properties/totalObjectCount",
"type": "integer"
},
"version": {
"id": "/properties/version",
"type": "integer"
}
},
"type": "object"
}Example:
{
"id": "A81713100457447B85C97F0DB5A9C585",
"status": 3,
"normalizedRiskScore": 0,
"riskValue": 0,
"displayId": "Criticality",
"version": 0,
"objectCount": 0,
"groupTypeCount": 0,
"shortDescription": "Criticality Assessment1",
"longDescription": "",
"author": "SACHIN KUMAR NAGARIA",
"lastChangeBy": "Palak Garg",
"totalObjectCount": 2,
"lastEditedTime": "2017-05-17",
"creationTime": "2017-05-17",
"groupScope": [
{
"groupTypeCode": "CA",
"groupTypeDescription": " Criticality Assessment"
}
],
"botypeCount": [
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
},
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
}
]
}HTTP status code 400
Bad Request,if groupId is invalid
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"errorMessages": {
"id": "/properties/errorMessages",
"items": {
"id": "/properties/errorMessages/items",
"properties": {
"EntitiesNotFound": {
"id": "/properties/errorMessages/items/properties/EntitiesNotFound",
"items": {},
"type": "array"
},
"errorMessage": {
"id": "/properties/errorMessages/items/properties/errorMessage",
"type": "string"
},
"messageCode": {
"id": "/properties/errorMessages/items/properties/messageCode",
"type": "string"
},
"repeatedEntities": {
"id": "/properties/errorMessages/items/properties/repeatedEntities",
"items": {},
"type": "array"
},
"severity": {
"id": "/properties/errorMessages/items/properties/severity",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"statusCode": {
"id": "/properties/statusCode",
"type": "integer"
}
},
"type": "object"
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The following group IDs do not exist: A81713100457447B85C97F0DB5A9C58.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by basic
/enumeration?type=GroupType
This endpoint allows you to see all the valid group types.
get /enumeration?type=GroupType
This endpoint allows you to see all the valid group types.
REST API supports Basic Authentication
HTTP status code 200
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"GroupType": {
"$id": "/properties/GroupType",
"type": "array",
"items": {
"$id": "/properties/GroupType/items",
"type": "object",
"properties": {
"type": {
"$id": "/properties/GroupType/items/properties/type",
"type": "string",
"title": "The Type Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"GroupType"
]
},
"code": {
"$id": "/properties/GroupType/items/properties/code",
"type": "string",
"title": "The Code Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"FLEET"
]
},
"languageIsoCode": {
"$id": "/properties/GroupType/items/properties/languageIsoCode",
"type": "string",
"title": "The Languageisocode Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"en"
]
},
"description": {
"$id": "/properties/GroupType/items/properties/description",
"type": "string",
"title": "The Description Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"Fleet"
]
}
}
}
}
}
}Example:
{
"GroupType":[
{
"type":"GroupType",
"code":"FLEET",
"languageIsoCode":"en",
"description":"Fleet"
},
{
"type":"GroupType",
"code":"GEN",
"languageIsoCode":"en",
"description":"Training"
},
{
"type":"GroupType",
"code":"FMEA",
"languageIsoCode":"en",
"description":"FMEA"
},
{
"type":"GroupType",
"code":"MP",
"languageIsoCode":"en",
"description":"Maintenance Planner"
},
{
"type":"GroupType",
"code":"ORG",
"languageIsoCode":"en",
"description":"Organization"
},
{
"type":"GroupType",
"code":"VAR",
"languageIsoCode":"en",
"description":"Variant"
},
{
"type":"GroupType",
"code":"HC",
"languageIsoCode":"en",
"description":"Handover and Commissioning"
},
{
"type":"GroupType",
"code":"PRO",
"languageIsoCode":"en",
"description":"Project"
},
{
"type":"GroupType",
"code":"WC",
"languageIsoCode":"en",
"description":"Work Centre"
},
{
"type":"GroupType",
"code":"CA",
"languageIsoCode":"en",
"description":"Risk and Criticality"
},
{
"type":"GroupType",
"code":"SPK",
"languageIsoCode":"en",
"description":"Spare Parts Kit"
}
]
}Secured by basic
/groups/publish
This endpoint allows you to publish group(s).
put /groups/publish
This endpoint allows you to publish group(s).
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"items": {
"id": "/items",
"type": "string"
},
"type": "array"
}Example:
["A81713100457447B85C97F0DB5A9585"] HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"id": "http://example.com/example.json",
"properties": {
"id": {
"id": "/properties/id",
"type": "null"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"id": null,
"status": true
}HTTP status code 400
Bad Request,if groupId is invalid
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"errorMessages": {
"id": "/properties/errorMessages",
"items": {
"id": "/properties/errorMessages/items",
"properties": {
"EntitiesNotFound": {
"id": "/properties/errorMessages/items/properties/EntitiesNotFound",
"items": {},
"type": "array"
},
"errorMessage": {
"id": "/properties/errorMessages/items/properties/errorMessage",
"type": "string"
},
"messageCode": {
"id": "/properties/errorMessages/items/properties/messageCode",
"type": "string"
},
"repeatedEntities": {
"id": "/properties/errorMessages/items/properties/repeatedEntities",
"items": {},
"type": "array"
},
"severity": {
"id": "/properties/errorMessages/items/properties/severity",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"statusCode": {
"id": "/properties/statusCode",
"type": "integer"
}
},
"type": "object"
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The following group IDs have already been published: B0C2B1B86256433A875DFD750DA34E49.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by basic
/groups/{groupId}/copy
This endpoint allows you to copy a group.
post /groups/{groupId}/copy
This endpoint allows you to copy a group.
REST API supports Basic Authentication
URI Parameters
- groupId: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"businessObjectTypes": {
"id": "/properties/businessObjectTypes",
"items": {
"id": "/properties/businessObjectTypes/items",
"type": "string"
},
"type": "array"
},
"groupType": {
"id": "/properties/groupType",
"items": {
"id": "/properties/groupType/items",
"type": "string"
},
"type": "array"
},
"longDescription": {
"id": "/properties/longDescription",
"type": "string"
},
"shortDescription": {
"id": "/properties/shortDescription",
"type": "string"
}
},
"type": "object"
}Example:
{
"shortDescription": "copyViaPostmanError",
"longDescription": "copyViaPostmanError",
"groupType": [
"CA"
],
"businessObjectTypes": [
"EQU"
]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"businessObjectTypes": {
"id": "/properties/businessObjectTypes",
"items": {
"id": "/properties/businessObjectTypes/items",
"type": "string"
},
"type": "array"
},
"groupType": {
"id": "/properties/groupType",
"items": {
"id": "/properties/groupType/items",
"type": "string"
},
"type": "array"
},
"longDescription": {
"id": "/properties/longDescription",
"type": "string"
},
"shortDescription": {
"id": "/properties/shortDescription",
"type": "string"
}
},
"type": "object"
}Example:
{
"id": "4448371E243E4971B062E2C639F13C40",
"status": true
}HTTP status code 400
Bad Request,if groupId is invalid
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"id": {
"id": "/properties/id",
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"statusCode": 400,
"errorMessages": [{
"severity": "ERROR",
"errorMessage": "The copying group and the copied group cannot have the same criticality assessment type.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
} ]
}Secured by basic
/groups/{groupId}/revise
This endpoint allows you to create a new revision of a group.
put /groups/{groupId}/revise
This endpoint allows you to create a new revision of a group.
REST API supports Basic Authentication
URI Parameters
- groupId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"businessObjectTypes": {
"id": "/properties/businessObjectTypes",
"items": {
"id": "/properties/businessObjectTypes/items",
"type": "string"
},
"type": "array"
},
"groupType": {
"id": "/properties/groupType",
"items": {
"id": "/properties/groupType/items",
"type": "string"
},
"type": "array"
},
"longDescription": {
"id": "/properties/longDescription",
"type": "string"
},
"shortDescription": {
"id": "/properties/shortDescription",
"type": "string"
}
},
"type": "object"
}Example:
{
"id": "4448371E243E4971B062E2C639F13C40",
"status": true
}HTTP status code 400
Bad Request,if groupId is invalid
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"id": {
"id": "/properties/id",
"type": "string"
},
"status": {
"id": "/properties/status",
"type": "boolean"
}
},
"type": "object"
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "The following group IDs do not exist: A81713100457447B85C97F0DB5A9C58.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by basic
/objects/{businessObjectId}/groups
This endpoint allows you to see all the valid groups for a business object.
get /objects/{businessObjectId}/groups
This endpoint allows you to see all the valid groups for a business object.
REST API supports Basic Authentication
URI Parameters
- businessObjectId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"items": {
"id": "/items",
"properties": {
"businessObjectCode": {
"id": "/items/properties/businessObjectCode",
"type": "string"
},
"businessObjectCount": {
"id": "/items/properties/businessObjectCount",
"type": "integer"
},
"businessObjectType": {
"id": "/items/properties/businessObjectType",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}Example:
[
{
"groupID": "9007A57E4A594E1CBA45162F34EEFB3A",
"displayID": "GR.LCL.23",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "CCB6822DE0274BFE9DD2E432314688DE",
"displayID": "GR.LCL.22",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "FD1C5EA117924C1A805560283E5807C9",
"displayID": "GR.LCL.9",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "440B59240D884748B319D4D58123A1F1",
"displayID": "GR.LCL.25",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "620AEFA38A554E19BF34B383C9C2D8C1",
"displayID": "GR.LCL.8",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-02",
"editedOn": "2017-06-02",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "91AA68800591427CABB6E6CEF4F0A268",
"displayID": "GR.LCL.24",
"shortDescription": "ty123456",
"objectCount": 3,
"createdOn": "2017-06-05",
"editedOn": "2017-07-13",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 3
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "4F2758FB4DA34E70BF745C09A7362332",
"displayID": "GR.LCL.7",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-02",
"editedOn": "2017-06-02",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "80A9F8FEA2F84D02AAE129DB1D6F4306",
"displayID": "GR.LCL.6",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-02",
"editedOn": "2017-06-02",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "926109E2254F497381AC22BF66966247",
"displayID": "GR.LCL.5",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-02",
"editedOn": "2017-12-13",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "C95319A97542476594997D72B99F0209",
"displayID": "GR.LCL.21",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2018-01-23",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "3"
},
{
"groupID": "99C14D36CA0843479209D893F16B9829",
"displayID": "GR.LCL.20",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "448002E22D204B44B84D4A9E58A784AA",
"displayID": "GR.LCL.19",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "DA1C9F5DDD7B4930BB4E21B59167B109",
"displayID": "GR.LCL.16",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "B3FCAE5932BE4E93927F9A5D3C226443",
"displayID": "GR.LCL.15",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "8DBC0AA5BBB047D688AB092D1D3190BD",
"displayID": "GR.LCL.18",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "3BC600F61F334C849A57239635C7D8F0",
"displayID": "GR.LCL.17",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "1E96B2DCC52B4D55BE189A04322D04D1",
"displayID": "GR.LCL.12",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "43E9E0874A254AF7A2C27BF326058916",
"displayID": "GR.LCL.11",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "FD036F5C99CF462C89917197C9016170",
"displayID": "GR.LCL.14",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "DF98727606A04ECE91CC3625BA4BD7A3",
"displayID": "GR.LCL.13",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "1C1F43BBE78B40E28263063C49FDFA65",
"displayID": "GR.LCL.10",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "D6A5B4E0145D47AAA5AAEAE419D9FD15",
"displayID": "GR.LCL.27",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "A808D1E8594E48EE969303683E3113C7",
"displayID": "GR.LCL.26",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "9ECFA4D8D1734341BD83EED88A38C171",
"displayID": "GR.LCL.29",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
},
{
"groupID": "C141A7D29DBF43C3945A1B6C6D0686EB",
"displayID": "GR.LCL.28",
"shortDescription": "ty123456",
"objectCount": 2,
"createdOn": "2017-06-05",
"editedOn": "2017-06-05",
"boTypeCount": [
{
"businessObjectCode": "FL",
"businessObjectType": "Locations",
"businessObjectCount": 0
},
{
"businessObjectCode": "EQU",
"businessObjectType": "Equipment",
"businessObjectCount": 2
}
],
"groupScope": [
{
"groupTypeCode": "FMEA",
"groupTypeDescription": "FMEA"
}
],
"status": "1"
}
]Secured by basic
/businessobjects/{businessObjectId}/assign?botype={boType}
This endpoint allows you to assign a business Object to multiple groups.
post /businessobjects/{businessObjectId}/assign?botype={boType}
This endpoint allows you to assign a business Object to multiple groups.
REST API supports Basic Authentication
URI Parameters
- businessObjectId: required (string)
- boType: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"items": {
"id": "/items",
"type": "string"
},
"type": "array"
}Example:
[
"D2827E3811F44EDE9BD8742D640DFAF6",
"576881D993714EC6A85DC2442BBB6178"
]HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"businessObjectTypes": {
"id": "/properties/businessObjectTypes",
"items": {
"id": "/properties/businessObjectTypes/items",
"type": "string"
},
"type": "array"
},
"groupType": {
"id": "/properties/groupType",
"items": {
"id": "/properties/groupType/items",
"type": "string"
},
"type": "array"
},
"longDescription": {
"id": "/properties/longDescription",
"type": "string"
},
"shortDescription": {
"id": "/properties/shortDescription",
"type": "string"
}
},
"type": "object"
}Example:
{
"id": "C3F36A0E223043348A45D7E801157247",
"status": true
}HTTP status code 400
Bad Request,if no groups are passed in the payload
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"statusCode": {
"$id": "/properties/statusCode",
"type": "integer",
"title": "The Statuscode Schema",
"description": "An explanation about the purpose of this instance.",
"default": 0,
"examples": [
400
]
},
"errorMessages": {
"$id": "/properties/errorMessages",
"type": "array",
"items": {
"$id": "/properties/errorMessages/items",
"type": "object",
"properties": {
"severity": {
"$id": "/properties/errorMessages/items/properties/severity",
"type": "string",
"title": "The Severity Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"ERROR"
]
},
"errorMessage": {
"$id": "/properties/errorMessages/items/properties/errorMessage",
"type": "string",
"title": "The Errormessage Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"No groups selected."
]
},
"repeatedEntities": {
"$id": "/properties/errorMessages/items/properties/repeatedEntities",
"type": "array"
},
"EntitiesNotFound": {
"$id": "/properties/errorMessages/items/properties/EntitiesNotFound",
"type": "array"
},
"messageCode": {
"$id": "/properties/errorMessages/items/properties/messageCode",
"type": "string",
"title": "The Messagecode Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"null"
]
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "No groups selected.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}Secured by basic
/objects/{businessObjectID}/unassign?botype={boType}
This endpoint allows you to remove a business Object from multiple groups.
put /objects/{businessObjectID}/unassign?botype={boType}
This endpoint allows you to remove a business Object from multiple groups.
REST API supports Basic Authentication
URI Parameters
- businessObjectID: required (string)
- boType: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"items": {
"id": "/items",
"type": "string"
},
"type": "array"
}Example:
[
"D2827E3811F44EDE9BD8742D640DFAF6",
"576881D993714EC6A85DC2442BBB6178"
]HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {},
"properties": {
"businessObjectTypes": {
"id": "/properties/businessObjectTypes",
"items": {
"id": "/properties/businessObjectTypes/items",
"type": "string"
},
"type": "array"
},
"groupType": {
"id": "/properties/groupType",
"items": {
"id": "/properties/groupType/items",
"type": "string"
},
"type": "array"
},
"longDescription": {
"id": "/properties/longDescription",
"type": "string"
},
"shortDescription": {
"id": "/properties/shortDescription",
"type": "string"
}
},
"type": "object"
}Example:
{
"id": "C3F36A0E223043348A45D7E801157247",
"status": true
}HTTP status code 400
Bad Request,if no groups are passed in the payload
Body
Type: application/json
Schema:
{
"$id": "http://example.com/example.json",
"type": "object",
"definitions": {},
"$schema": "http://json-schema.org/draft-06/schema#",
"properties": {
"statusCode": {
"$id": "/properties/statusCode",
"type": "integer",
"title": "The Statuscode Schema",
"description": "An explanation about the purpose of this instance.",
"default": 0,
"examples": [
400
]
},
"errorMessages": {
"$id": "/properties/errorMessages",
"type": "array",
"items": {
"$id": "/properties/errorMessages/items",
"type": "object",
"properties": {
"severity": {
"$id": "/properties/errorMessages/items/properties/severity",
"type": "string",
"title": "The Severity Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"ERROR"
]
},
"errorMessage": {
"$id": "/properties/errorMessages/items/properties/errorMessage",
"type": "string",
"title": "The Errormessage Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"No groups selected."
]
},
"repeatedEntities": {
"$id": "/properties/errorMessages/items/properties/repeatedEntities",
"type": "array"
},
"EntitiesNotFound": {
"$id": "/properties/errorMessages/items/properties/EntitiesNotFound",
"type": "array"
},
"messageCode": {
"$id": "/properties/errorMessages/items/properties/messageCode",
"type": "string",
"title": "The Messagecode Schema",
"description": "An explanation about the purpose of this instance.",
"default": "",
"examples": [
"null"
]
}
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "No groups selected.",
"repeatedEntities": [],
"EntitiesNotFound": [],
"messageCode": "null"
}
]
}