Equipment API documentation version v1
Application_URL/services/api/v1
About Equipment
An item of an equipment is a physical instance of a model. Additional information can be maintained specific to an item of an equipment such as installation information, installation location, attachments.
Purpose
This API allows you to create, update, retrieve and delete an Equipment
/equipment
post
This endpoint allows you to create an equipment.
get
This endpoint allows you to search for equipment based on filter query parameter.
post /equipment
This endpoint allows you to create an equipment.
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"internalId": {
"type": "string",
"maxLength": 255,
"description": "User specified Id. This replaces the 'name' field in the next release."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment. We recommend you to use 'internalId' field instead of 'name' since 'name' would be deprecated with next release."
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "Model to which equipment belongs to"
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"modelKnown": {
"type": "boolean",
"description": "This flag indicates that model is known or not. If modelId is not provided this flag should be 'false' otherwise 'true'."
},
"lifeCycle": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "The life cycle enum value of the equipment, where 1 - Planned and 2 - Actual."
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Business partner ID. Use the /organizations or /organizations/byrole API to get the ID for the business partners."
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
},
"required": ["short"]
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "This is the documentid of the image/logo which you get from the document upload service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator. Use the /organizations or /organizations/byrole API to get the ID for the operator."
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
}
},
"required": ["internalId", "sourceBPRole", "modelKnown", "lifeCycle", "description", "operatorID"]
}Example:
{
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"sourceBPRole": "1",
"modelKnown": true,
"lifeCycle": "2",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"templates": [{
"id": "9C8A17D757C940F6983E58F79A6B7035"
}, {
"id": "FFF7A2231BBE41A6A2511FCBFACCD0CC"
}],
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text"
}HTTP status code 200
Successfully creates an equipment
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"equipmentId": {
"type": "string",
"maxLength": 32,
"description": "ID of the equipment"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment"
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "ID of the model"
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"equipmentVersion": {
"type": "double",
"description": "Version of the equipment"
},
"completeness": {
"type": "integer"
},
"publishedOn": {
"type": "string",
"description": "Published On date as string format : YYYY-MM-DD"
},
"status": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "Status of the equipment : 1 - Unpublished, 2 - Published, 3 - InRevision"
},
"sectionCompleteness": {
"type": "object",
"additionalProperties": false,
"properties": {
"headerPercentage": {
"type": "double"
},
"attachmentPercentage": {
"type": "double"
},
"instructionPercentage": {
"type": "double"
},
"valuePercentage": {
"type": "double"
}
}
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"modelKnown": {
"type": "boolean",
"description": "This flag indicates that model is known or not. If modelId is not provided this flag should be 'false' otherwise 'true'."
},
"lifeCycle": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "The life cycle enum value of the equipment, where 1 - Planned and 2 - Actual."
},
"operatorName": {
"type": "string",
"maxLength": 255
},
"adminData": {
"type": "object",
"properties": {
"createdBy": {
"type": "string"
},
"createdOn": {
"type": "string",
"format": "YYYY-MM-DD"
},
"changedBy": {
"type": "string"
},
"changedOn": {
"type": "string",
"format": "YYYY-MM-DD"
}
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
},
"isOperatorValid": {
"type": "boolean"
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "Document ID of the image uploaded through document service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator."
},
"soldTo": {
"type": "string",
"description": "Name of the organization to which equipment is sold"
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
},
"source": {
"type": "string",
"maxLength": 255,
"description": "Name of the equipment's source organization."
}
}
}Example:
{
"equipmentId": "3936D8E60F394D18A033C34F51601E88",
"name": "Pump",
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"language": "en",
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"hasInrevision": true,
"equipmentVersion": 1.0,
"completeness": 39,
"publishedOn": "2016-06-01",
"status": "2",
"sectionCompleteness": {
"headerPercentage": 18.0,
"attachmentPercentage": 0.0,
"instructionPercentage": 0.0,
"valuePercentage": 0.0
},
"sourceBPRole": "1",
"modelKnown": true,
"lifeCycle": "2",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"operatorName": "E&H",
"adminData": {
"createdBy": "E736F3562D53434197433EACDCED2843",
"createdOn": "2016-05-31",
"changedBy": "5C2676AF5FD1425B96031ED0D50EE72B",
"changedOn": "2016-06-01"
},
"templates": [{
"id": "9C8A17D757C940F6983E58F79A6B7035"
}, {
"id": "FFF7A2231BBE41A6A2511FCBFACCD0CC"
}],
"isOperatorValid": true,
"soldTo": "SAP",
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text",
"source": "E&H"
}Secured by basic
get /equipment
This endpoint allows you to search for equipment based on filter query parameter.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- $filter: (string)
Retrieves equipments based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('CombustionEngine', Name) eq true)
- $top: (string)
Top 'n' models in the list. This parameter follows ODATA URL covention. You must use this query parameter with $skip, $top alone will not work. For eg $top=10.
- $skip: (string)
Number of models to be skipped in the list. This parameter follows ODATA URL covention. You must use this query parameter with $top, $skip alone will not work. For eg $skip=20
- $orderby: (string)
Order the list of models based on the fields. This parameter follows ODATA URL covention. For eg $orderby=internalId asc
HTTP status code 200
Search result based on query parameters
Body
Type: application/json
Example:
[{
"equipmentId": "BFC7EE430DA046F696593050FEE20DDB",
"name": "Pump - 01",
"status": "2",
"version": 0.0,
"hasInRevision": "0",
"modelId": "C3C2C9270B71438A95E01448F09B86E1",
"modelName": "Pump Model",
"shortDescription": "This is a pump",
"templateId": "85B4AD9C4FA54CA1B0F7A335BDD78082",
"subclass": "Pump Subclass",
"modelTemplate": "Pump Model Template",
"location": "BLR",
"criticalityCode": "1",
"criticalityDescription": "Low",
"manufacturer": "E&H",
"completeness": 5.0,
"createdOn": "2016-05-27",
"changedOn": "2016-05-27",
"publishedOn": "2016-05-27",
"serialNumber": "SER098HJ8",
"batchNumber": "OP89H6L",
"tagNumber": "78304",
"lifeCycle": "2",
"lifeCycleDescription": "Actual",
"source": "E&H",
"imageURL": "Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"operator": "E&H",
"coordinates": "79.189453125,12.854655126961683",
"installationDate": "2016-02-05",
"equipmentStatus": "1",
"buildDate": "2016-01-01",
"isOperatorValid": "true",
"modelVersion": 3.0,
"class": "Pump Class"
}, {
"equipmentId": "BFC7EE430DA046F696593050FEE20DDB",
"name": "Pump - 01",
"status": "2",
"version": 0.0,
"hasInRevision": "0",
"modelId": "C3C2C9270B71438A95E01448F09B86E1",
"modelName": "Pump Model",
"shortDescription": "This is a pump",
"templateId": "85B4AD9C4FA54CA1B0F7A335BDD78082",
"subclass": "Pump Subclass",
"modelTemplate": "Pump Model Template",
"location": "BLR",
"criticalityCode": "1",
"criticalityDescription": "Low",
"manufacturer": "E&H",
"completeness": 5.0,
"createdOn": "2016-05-27",
"changedOn": "2016-05-27",
"publishedOn": "2016-05-27",
"serialNumber": "SER098HJ8",
"batchNumber": "OP89H6L",
"tagNumber": "78304",
"lifeCycle": "2",
"lifeCycleDescription": "Actual",
"source": "E&H",
"imageURL": "Ou0hibM2xkZ1tTD6pvTsEYH2kinRsGMpeK_yHcfZ1F8",
"operator": "E&H",
"coordinates": "79.189453125,12.854655126961683",
"installationDate": "2016-02-05",
"equipmentStatus": "1",
"buildDate": "2016-01-01",
"isOperatorValid": "true",
"modelVersion": 3.0,
"class": "Pump Class"
}]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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}Secured by basic
get
This endpoint allows you to get count of equipment based on filter query
get /equipment/$count
This endpoint allows you to get count of equipment based on filter query
Secured by basic
REST API supports Basic Authentication
Query Parameters
- $filter: (string)
Retrieves number of equipments based on the value provided. This parameter follows ODATA URL covention. For eg $filter=(substringof('CombustionEngine', Name) eq true)
HTTP status code 200
Search result based on query parameters
Body
Type: application/json
Example:
20HTTP status code 400
The request could not be understood by the server due to malformed syntax.You SHOULD NOT repeat the request without modifications.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}Secured by basic
/equipment({equipmentId})/header
get
This endpoint allows get an equipment based on the ID you specify.
put
This end point allows you to update header details of an equipment and get the updated equipment.
get /equipment({equipmentId})/header
This endpoint allows get an equipment based on the ID you specify.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- status: (string)
Retrieve equipment based on the status provided. Possible values are - 1, 2 or 3 where 1 - Unpublished, 2 - Published and 3 - Inrevision.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"equipmentId": {
"type": "string",
"maxLength": 32,
"description": "ID of the equipment"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment"
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "ID of the model"
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"equipmentVersion": {
"type": "double",
"description": "Version of the equipment"
},
"completeness": {
"type": "integer"
},
"publishedOn": {
"type": "string",
"description": "Published On date as string format : YYYY-MM-DD"
},
"status": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "Status of the equipment : 1 - Unpublished, 2 - Published, 3 - InRevision"
},
"sectionCompleteness": {
"type": "object",
"additionalProperties": false,
"properties": {
"headerPercentage": {
"type": "double"
},
"attachmentPercentage": {
"type": "double"
},
"instructionPercentage": {
"type": "double"
},
"valuePercentage": {
"type": "double"
}
}
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"modelKnown": {
"type": "boolean",
"description": "This flag indicates that model is known or not. If modelId is not provided this flag should be 'false' otherwise 'true'."
},
"lifeCycle": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "The life cycle enum value of the equipment, where 1 - Planned and 2 - Actual."
},
"operatorName": {
"type": "string",
"maxLength": 255
},
"adminData": {
"type": "object",
"properties": {
"createdBy": {
"type": "string"
},
"createdOn": {
"type": "string",
"format": "YYYY-MM-DD"
},
"changedBy": {
"type": "string"
},
"changedOn": {
"type": "string",
"format": "YYYY-MM-DD"
}
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
},
"isOperatorValid": {
"type": "boolean"
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "Document ID of the image uploaded through document service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator."
},
"soldTo": {
"type": "string",
"description": "Name of the organization to which equipment is sold"
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
},
"source": {
"type": "string",
"maxLength": 255,
"description": "Name of the equipment's source organization."
}
}
}Example:
{
"equipmentId": "3936D8E60F394D18A033C34F51601E88",
"name": "Pump",
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"language": "en",
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"hasInrevision": true,
"equipmentVersion": 1.0,
"completeness": 39,
"publishedOn": "2016-06-01",
"status": "2",
"sectionCompleteness": {
"headerPercentage": 18.0,
"attachmentPercentage": 0.0,
"instructionPercentage": 0.0,
"valuePercentage": 0.0
},
"sourceBPRole": "1",
"modelKnown": true,
"lifeCycle": "2",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"operatorName": "E&H",
"adminData": {
"createdBy": "E736F3562D53434197433EACDCED2843",
"createdOn": "2016-05-31",
"changedBy": "5C2676AF5FD1425B96031ED0D50EE72B",
"changedOn": "2016-06-01"
},
"templates": [{
"id": "9C8A17D757C940F6983E58F79A6B7035"
}, {
"id": "FFF7A2231BBE41A6A2511FCBFACCD0CC"
}],
"isOperatorValid": true,
"soldTo": "SAP",
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text",
"source": "E&H"
}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 update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
put /equipment({equipmentId})/header
This end point allows you to update header details of an equipment and get the updated equipment.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"internalId": {
"type": "string",
"maxLength": 255,
"description": "User specified Id. This replaces the 'name' field in the next release."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment. We recommend you to use 'internalId' field instead of 'name' since 'name' would be deprecated with next release."
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "Model to which equipment belongs to"
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Business partner ID. Use the /organizations or /organizations/byrole API to get the ID for the business partners."
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
},
"required": ["short"]
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "This is the documentid of the image/logo which you get from the document upload service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator. Use the /organizations or /organizations/byrole API to get the ID for the operator."
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
}
},
"required": ["internalId", "sourceBPRole", "description", "operatorID"]
}Example:
{
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"sourceBPRole": "1",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text"
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"equipmentId": {
"type": "string",
"maxLength": 32,
"description": "ID of the equipment"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment"
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "ID of the model"
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"equipmentVersion": {
"type": "double",
"description": "Version of the equipment"
},
"completeness": {
"type": "integer"
},
"publishedOn": {
"type": "string",
"description": "Published On date as string format : YYYY-MM-DD"
},
"status": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "Status of the equipment : 1 - Unpublished, 2 - Published, 3 - InRevision"
},
"sectionCompleteness": {
"type": "object",
"additionalProperties": false,
"properties": {
"headerPercentage": {
"type": "double"
},
"attachmentPercentage": {
"type": "double"
},
"instructionPercentage": {
"type": "double"
},
"valuePercentage": {
"type": "double"
}
}
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"modelKnown": {
"type": "boolean",
"description": "This flag indicates that model is known or not. If modelId is not provided this flag should be 'false' otherwise 'true'."
},
"lifeCycle": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "The life cycle enum value of the equipment, where 1 - Planned and 2 - Actual."
},
"operatorName": {
"type": "string",
"maxLength": 255
},
"adminData": {
"type": "object",
"properties": {
"createdBy": {
"type": "string"
},
"createdOn": {
"type": "string",
"format": "YYYY-MM-DD"
},
"changedBy": {
"type": "string"
},
"changedOn": {
"type": "string",
"format": "YYYY-MM-DD"
}
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
},
"isOperatorValid": {
"type": "boolean"
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "Document ID of the image uploaded through document service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator."
},
"soldTo": {
"type": "string",
"description": "Name of the organization to which equipment is sold"
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
},
"source": {
"type": "string",
"maxLength": 255,
"description": "Name of the equipment's source organization."
}
}
}Example:
{
"equipmentId": "3936D8E60F394D18A033C34F51601E88",
"name": "Pump",
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"language": "en",
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"hasInrevision": true,
"equipmentVersion": 1.0,
"completeness": 39,
"publishedOn": "2016-06-01",
"status": "2",
"sectionCompleteness": {
"headerPercentage": 18.0,
"attachmentPercentage": 0.0,
"instructionPercentage": 0.0,
"valuePercentage": 0.0
},
"sourceBPRole": "1",
"modelKnown": true,
"lifeCycle": "2",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"operatorName": "E&H",
"adminData": {
"createdBy": "E736F3562D53434197433EACDCED2843",
"createdOn": "2016-05-31",
"changedBy": "5C2676AF5FD1425B96031ED0D50EE72B",
"changedOn": "2016-06-01"
},
"templates": [{
"id": "9C8A17D757C940F6983E58F79A6B7035"
}, {
"id": "FFF7A2231BBE41A6A2511FCBFACCD0CC"
}],
"isOperatorValid": true,
"soldTo": "SAP",
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text",
"source": "E&H"
}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 update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentID})
delete
This endpoint allows you to delete equipment with specified id.
delete /equipment({equipmentID})
This endpoint allows you to delete equipment with specified id.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentID: required (string)
HTTP status code 204
Equipment with specified id has been succesfully deleted.
HTTP status code 400
Bad request, when document or equipment doesn't exists.
HTTP status code 403
User is not authorized to delete the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment/publish
put
This endpoint is used to publish more than one equipment.
put /equipment/publish
This endpoint is used to publish more than one equipment.
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [{
"type": "object",
"properties": {
"id": {
"type": "string",
"length": 32,
"description": "Equipment ID"
}
}
}]
}Example:
[{
"id": "12345678912345678912345678912345"
}, {
"id": "1049EE8BFACE4B09AACD109695B4DA64"
}]HTTP status code 204
Successfully publishes the list of equipment mentioned in the request.
Secured by basic
/equipment({equipmentId})/revise
put
This endpoint allows to create new revision of an equipment.
put /equipment({equipmentId})/revise
This endpoint allows to create new revision of an equipment.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"equipmentId": {
"type": "string",
"maxLength": 32,
"description": "ID of the equipment"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment"
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "ID of the model"
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"equipmentVersion": {
"type": "double",
"description": "Version of the equipment"
},
"completeness": {
"type": "integer"
},
"publishedOn": {
"type": "string",
"description": "Published On date as string format : YYYY-MM-DD"
},
"status": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "Status of the equipment : 1 - Unpublished, 2 - Published, 3 - InRevision"
},
"sectionCompleteness": {
"type": "object",
"additionalProperties": false,
"properties": {
"headerPercentage": {
"type": "double"
},
"attachmentPercentage": {
"type": "double"
},
"instructionPercentage": {
"type": "double"
},
"valuePercentage": {
"type": "double"
}
}
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"modelKnown": {
"type": "boolean",
"description": "This flag indicates that model is known or not. If modelId is not provided this flag should be 'false' otherwise 'true'."
},
"lifeCycle": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "The life cycle enum value of the equipment, where 1 - Planned and 2 - Actual."
},
"operatorName": {
"type": "string",
"maxLength": 255
},
"adminData": {
"type": "object",
"properties": {
"createdBy": {
"type": "string"
},
"createdOn": {
"type": "string",
"format": "YYYY-MM-DD"
},
"changedBy": {
"type": "string"
},
"changedOn": {
"type": "string",
"format": "YYYY-MM-DD"
}
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
},
"isOperatorValid": {
"type": "boolean"
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "Document ID of the image uploaded through document service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator."
},
"soldTo": {
"type": "string",
"description": "Name of the organization to which equipment is sold"
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
},
"source": {
"type": "string",
"maxLength": 255,
"description": "Name of the equipment's source organization."
}
}
}Example:
{
"equipmentId": "3936D8E60F394D18A033C34F51601E88",
"name": "Pump",
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"language": "en",
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"hasInrevision": true,
"equipmentVersion": 1.0,
"completeness": 39,
"publishedOn": "2016-06-01",
"status": "2",
"sectionCompleteness": {
"headerPercentage": 18.0,
"attachmentPercentage": 0.0,
"instructionPercentage": 0.0,
"valuePercentage": 0.0
},
"sourceBPRole": "1",
"modelKnown": true,
"lifeCycle": "2",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"operatorName": "E&H",
"adminData": {
"createdBy": "E736F3562D53434197433EACDCED2843",
"createdOn": "2016-05-31",
"changedBy": "5C2676AF5FD1425B96031ED0D50EE72B",
"changedOn": "2016-06-01"
},
"templates": [{
"id": "9C8A17D757C940F6983E58F79A6B7035"
}, {
"id": "FFF7A2231BBE41A6A2511FCBFACCD0CC"
}],
"isOperatorValid": true,
"soldTo": "SAP",
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text",
"source": "E&H"
}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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}HTTP status code 403
User is not authorized to update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/publish
put
This endpoint allows to publish of an equipment.
put /equipment({equipmentId})/publish
This endpoint allows to publish of an equipment.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"equipmentId": {
"type": "string",
"maxLength": 32,
"description": "ID of the equipment"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment"
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "ID of the model"
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"equipmentVersion": {
"type": "double",
"description": "Version of the equipment"
},
"completeness": {
"type": "integer"
},
"publishedOn": {
"type": "string",
"description": "Published On date as string format : YYYY-MM-DD"
},
"status": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "Status of the equipment : 1 - Unpublished, 2 - Published, 3 - InRevision"
},
"sectionCompleteness": {
"type": "object",
"additionalProperties": false,
"properties": {
"headerPercentage": {
"type": "double"
},
"attachmentPercentage": {
"type": "double"
},
"instructionPercentage": {
"type": "double"
},
"valuePercentage": {
"type": "double"
}
}
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"modelKnown": {
"type": "boolean",
"description": "This flag indicates that model is known or not. If modelId is not provided this flag should be 'false' otherwise 'true'."
},
"lifeCycle": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "The life cycle enum value of the equipment, where 1 - Planned and 2 - Actual."
},
"operatorName": {
"type": "string",
"maxLength": 255
},
"adminData": {
"type": "object",
"properties": {
"createdBy": {
"type": "string"
},
"createdOn": {
"type": "string",
"format": "YYYY-MM-DD"
},
"changedBy": {
"type": "string"
},
"changedOn": {
"type": "string",
"format": "YYYY-MM-DD"
}
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
},
"isOperatorValid": {
"type": "boolean"
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "Document ID of the image uploaded through document service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator."
},
"soldTo": {
"type": "string",
"description": "Name of the organization to which equipment is sold"
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
},
"source": {
"type": "string",
"maxLength": 255,
"description": "Name of the equipment's source organization."
}
}
}Example:
{
"equipmentId": "3936D8E60F394D18A033C34F51601E88",
"name": "Pump",
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"language": "en",
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"hasInrevision": true,
"equipmentVersion": 1.0,
"completeness": 39,
"publishedOn": "2016-06-01",
"status": "2",
"sectionCompleteness": {
"headerPercentage": 18.0,
"attachmentPercentage": 0.0,
"instructionPercentage": 0.0,
"valuePercentage": 0.0
},
"sourceBPRole": "1",
"modelKnown": true,
"lifeCycle": "2",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"operatorName": "E&H",
"adminData": {
"createdBy": "E736F3562D53434197433EACDCED2843",
"createdOn": "2016-05-31",
"changedBy": "5C2676AF5FD1425B96031ED0D50EE72B",
"changedOn": "2016-06-01"
},
"templates": [{
"id": "9C8A17D757C940F6983E58F79A6B7035"
}, {
"id": "FFF7A2231BBE41A6A2511FCBFACCD0CC"
}],
"isOperatorValid": true,
"soldTo": "SAP",
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text",
"source": "E&H"
}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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}HTTP status code 403
User is not authorized to update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/changelifecycle
put
This endpoint changes the lifecycle of the equipment.
put /equipment({equipmentId})/changelifecycle
This endpoint changes the lifecycle of the equipment.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- lifecycle: (string)
Equipment lifecycle code of the new lifecycle.Value can be obtained from /enumeration?type=EquipmentLifeCycle .
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"description": {
"type": "string",
"length": 5000
},
"changedBy": {
"type": "string",
"length": 32
},
"newClient": {
"type": "string",
"length": 32
}
}
}Example:
{
"description": "chaged to Planned",
"changedBy": "5801A0FA19A93594E10000000A78416B"
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"equipmentId": {
"type": "string",
"maxLength": 32,
"description": "ID of the equipment"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of equipment"
},
"modelId": {
"type": "string",
"maxLength": 32,
"description": "ID of the model"
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"equipmentVersion": {
"type": "double",
"description": "Version of the equipment"
},
"completeness": {
"type": "integer"
},
"publishedOn": {
"type": "string",
"description": "Published On date as string format : YYYY-MM-DD"
},
"status": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "Status of the equipment : 1 - Unpublished, 2 - Published, 3 - InRevision"
},
"sectionCompleteness": {
"type": "object",
"additionalProperties": false,
"properties": {
"headerPercentage": {
"type": "double"
},
"attachmentPercentage": {
"type": "double"
},
"instructionPercentage": {
"type": "double"
},
"valuePercentage": {
"type": "double"
}
}
},
"sourceBPRole": {
"type": "string",
"enum": [
"1",
"2",
"3"
],
"description": "The source business partner role of the equipment. Possible values are 1 - For my operations, 2 - For Service and 3 - For Customer. Use /enumeration API with the type as 'SourceBPRole' to get the enumeration."
},
"modelKnown": {
"type": "boolean",
"description": "This flag indicates that model is known or not. If modelId is not provided this flag should be 'false' otherwise 'true'."
},
"lifeCycle": {
"type": "string",
"enum": [
"1",
"2"
],
"description": "The life cycle enum value of the equipment, where 1 - Planned and 2 - Actual."
},
"operatorName": {
"type": "string",
"maxLength": 255
},
"adminData": {
"type": "object",
"properties": {
"createdBy": {
"type": "string"
},
"createdOn": {
"type": "string",
"format": "YYYY-MM-DD"
},
"changedBy": {
"type": "string"
},
"changedOn": {
"type": "string",
"format": "YYYY-MM-DD"
}
}
},
"templates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
},
"isOperatorValid": {
"type": "boolean"
},
"additionalBusinessPartners": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"bpRole": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "The business partner role of the organization. Possible values are 1 - Dealer, 2 - Service Provider, 3 - Regulator/Authority and 4 - Insurer. Use /enumeration API with the type as 'BusinessPartnerType' to get the enumeration."
}
}
}
},
"buildDate": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "Build date as string format : YYYY-MM-DD"
},
"serialNumber": {
"type": "string",
"maxLength": 255
},
"batchNumber": {
"type": "string",
"maxLength": 255
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"equipmentImageUrl": {
"type": "string",
"maxLength": 100,
"description": "Document ID of the image uploaded through document service."
},
"operatorID": {
"type": "string",
"maxLength": 32,
"description": "The business partner ID of the operator."
},
"soldTo": {
"type": "string",
"description": "Name of the organization to which equipment is sold"
},
"modelName": {
"type": "string",
"maxLength": 20,
"description": "The model name free text, that can be entered when there is no model assigned to the equipment."
},
"manufacturerName": {
"type": "string",
"maxLength": 32,
"description": "The manufacturer name free text or manufacturer organization ID, that can be entered when there is no model assigned to the equipment."
},
"source": {
"type": "string",
"maxLength": 255,
"description": "Name of the equipment's source organization."
}
}
}Example:
{
"equipmentId": "3936D8E60F394D18A033C34F51601E88",
"name": "Pump",
"internalId": "Pump",
"modelId": "08C09303B95D4F8D8DCC98AC7089CB3F",
"buildDate": "2016-03-16",
"serialNumber": "R73FR9D",
"batchNumber": "PI83F93J",
"description": {
"language": "en",
"short": "This is a pump",
"long": "This is a pump"
},
"equipmentImageUrl": "94vfLuia40NusoKHrB4DoE_50cs06XdEPHri5IqmCzM",
"operatorID": "098ddfd9bffe4de983949c798b4ce666",
"hasInrevision": true,
"equipmentVersion": 1.0,
"completeness": 39,
"publishedOn": "2016-06-01",
"status": "2",
"sectionCompleteness": {
"headerPercentage": 18.0,
"attachmentPercentage": 0.0,
"instructionPercentage": 0.0,
"valuePercentage": 0.0
},
"sourceBPRole": "1",
"modelKnown": true,
"lifeCycle": "2",
"additionalBusinessPartners": [{
"id": "098ddfd9bffe4de983949c798b4ce666",
"bpRole": "1"
}, {
"id": "E736F3562D53434197433EACDCED2843",
"bpRole": "3"
}],
"operatorName": "E&H",
"adminData": {
"createdBy": "E736F3562D53434197433EACDCED2843",
"createdOn": "2016-05-31",
"changedBy": "5C2676AF5FD1425B96031ED0D50EE72B",
"changedOn": "2016-06-01"
},
"templates": [{
"id": "9C8A17D757C940F6983E58F79A6B7035"
}, {
"id": "FFF7A2231BBE41A6A2511FCBFACCD0CC"
}],
"isOperatorValid": true,
"soldTo": "SAP",
"modelName": "Model free text",
"manufacturerName": "Manufacturer free text",
"source": "E&H"
}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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}HTTP status code 403
User is not authorized to update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/templates
get
This endpoint allows get list of templates associated with specified equipment Id.
put
This end point allows you to modify the list of templates associated with the equipment of specified id.
get /equipment({equipmentId})/templates
This endpoint allows get list of templates associated with specified equipment Id.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- version: (string)
Retrieves equipment templates based on the version provided.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the template."
},
"id": {
"type": "string",
"maxLength": 32,
"description": "Template Id"
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"typeCode": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "The template type code, where 1 - Class Template, 2 - Subclass template, 3 - Model Template, 4 - Equipment Template and 5 - Location template. In this case of equipment the values is '4'."
},
"type": {
"type": "string",
"description": "The template type."
},
"attributeGroups": {
"type": "array",
"description": "List of the of attribute groups which are added to the template.",
"items": [{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the attribute group."
},
"id": {
"type": "string",
"maxLength": 32,
"description": "Attribute group Id"
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"attributes": {
"type": "array",
"description": "List of the of attribute which are added to the attribute group.",
"items": [{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the attribute group."
},
"id": {
"type": "string",
"maxLength": 32
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"dataType": {
"type": "string",
"description": "The attribute data types - string, numeric, boolean, date, enum and picture."
},
"enumlist": {
"type": "array",
"description": "List of the of enumValues objects for different languages.",
"items": [{
"type": "object",
"description": "List of enumerations for each language.",
"properties": {
"enumLang": {
"type": "string",
"description": "The language of the enumeration values."
},
"enumValues": {
"type": "array",
"description": "The enumeration value and it's corresponding code for the language.",
"items": [{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code for the enum value."
},
"value": {
"type": "string",
"description": "The enum value in the enumLang."
}
}
}]
}
}
}]
},
"enumValues": {
"deprecated": true,
"type": "array",
"description": "The list of strings or enums of the attribute when the attribute data type is enum. This field will deprecated after 1711 release of AIN. Please use enumlist field for enumeration values."
},
"isMandatory": {
"type": "boolean"
},
"isMultivalue": {
"type": "boolean"
},
"isLanguage": {
"type": "boolean"
},
"isRange": {
"type": "boolean"
},
"isEnumeration": {
"type": "boolean"
},
"hasNormalValue": {
"type": "boolean"
}
}
}]
}
}
}]
}
}
}]
}Example:
[{
"description": {
"language": "en",
"short": "GSK_EQT_001",
"long": "GSK_EQT_001"
},
"name": "GSK_EQT_001",
"id": "56033DE9037F4465B7C79232D7235153",
"parentId": null,
"type": null,
"source": null,
"isSourceActive": 0,
"modelUnits": 0,
"attributeGroups": [{
"description": {
"language": "en",
"short": "AG_Measuring point",
"long": "AG_Measuring point"
},
"name": "AG_Measuring point",
"id": "0741CEB19F1642698A3E0C60C5F65C74",
"attributes": [{
"dataType": "numeric",
"dimension1": "ACBAC",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": true,
"isEnumeration": false,
"hasNormalValue": false,
"description": {
"language": "en",
"short": "abc",
"long": "abc"
},
"name": "abc",
"id": "5A49F641395A4A609F74EB60F88CAEC3",
"dimension1Description": "Acid/Base Capacity",
"unitOfMeasure1": [{
"code": "C36",
"description": "Mole per cubic meter",
"dimension": "ACBAC"
}, {
"code": "C38",
"description": "Mole per liter",
"dimension": "ACBAC"
}, {
"code": "V02",
"description": "Millimole per liter",
"dimension": "ACBAC"
}]
}, {
"dataType": "numeric",
"dimension1": "ACBAC",
"dimension2": "ACCEL",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": true,
"isEnumeration": false,
"hasNormalValue": false,
"description": {
"language": "en",
"short": "changed hjere ",
"long": "change test edit"
},
"name": "akshaytest",
"id": "5522CB2FDDC0458889B524D0BB0C1EC2",
"dimension1Description": "Acid/Base Capacity",
"dimension2Description": "Acceleration",
"unitOfMeasure1": [{
"code": "C36",
"description": "Mole per cubic meter",
"dimension": "ACBAC"
}, {
"code": "C38",
"description": "Mole per liter",
"dimension": "ACBAC"
}, {
"code": "V02",
"description": "Millimole per liter",
"dimension": "ACBAC"
}],
"unitOfMeasure2": [{
"code": "MS2",
"description": "Meter per second squared",
"dimension": "ACCEL"
}]
}, {
"dataType": "numeric",
"dimension1": "ACCEL",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": true,
"isEnumeration": false,
"hasNormalValue": true,
"description": {
"language": "en",
"short": "testonlymp",
"long": "Template_1Template_1"
},
"name": "test",
"id": "6F4B1781F47E464A9E37AAB0635E8213",
"dimension1Description": "Acceleration",
"unitOfMeasure1": [{
"code": "MS2",
"description": "Meter per second squared",
"dimension": "ACCEL"
}]
}],
"adminData": null
}, {
"description": {
"language": "en",
"short": "GSK_EQT_001_AG_001",
"long": "GSK_EQT_001_AG_001"
},
"name": "GSK_EQT_001_AG_001",
"id": "5DD8213D91A34B62AEECF792C70E0FB7",
"attributes": [{
"dataType": "string",
"enumValues": [],
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"name": "ACL_ATR_02UY8TG8LehRYZGLjTHBlXRz",
"id": "ACL_ATR_02UY8TG8LehRYZGLjTHBlXRz"
}, {
"dataType": "string",
"enumValues": [],
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"name": "ACL_ATR_03UY8TG8LehRYZGLjTHBlXRz",
"id": "ACL_ATR_03UY8TG8LehRYZGLjTHBlXRz"
}, {
"dataType": "numeric",
"dimension1": "PRESS",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"description": {
"language": "en",
"short": "GSK_EQT_001_AG_001_AT_001",
"long": "GSK_EQT_001_AG_001_AT_001"
},
"name": "GSK_EQT_001_AG_001_AT_001",
"id": "6CA7FBDD4E8C409987759B0847ADF496",
"dimension1Description": "Pressure",
"unitOfMeasure1": [{
"code": "mm HG",
"description": "Conventional millimeter of mercury",
"dimension": "PRESS"
}, {
"code": "HPA",
"description": "Hectopascal",
"dimension": "PRESS"
}, {
"code": "KPA",
"description": "Kilopascal",
"dimension": "PRESS"
}, {
"code": "MPA",
"description": "Megapascal",
"dimension": "PRESS"
}]
}],
"adminData": null
}],
"createdOn": null,
"changedOn": null,
"typeCode": "4"
}]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 update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
put /equipment({equipmentId})/templates
This end point allows you to modify the list of templates associated with the equipment of specified id.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"templates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Template ID"
}
}
}
}
},
"required": [
"id"
]
}Example:
{
"templates": [{
"id": "665C0A387C114B95956F6D8CCC06C417"
}, {
"id": "BF92033505AB491C82F3B640D4435EC9"
}]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [{
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the template."
},
"id": {
"type": "string",
"maxLength": 32,
"description": "Template Id"
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"typeCode": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "The template type code, where 1 - Class Template, 2 - Subclass template, 3 - Model Template, 4 - Equipment Template and 5 - Location template. In this case of equipment the values is '4'."
},
"type": {
"type": "string",
"description": "The template type."
},
"attributeGroups": {
"type": "array",
"description": "List of the of attribute groups which are added to the template.",
"items": [{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the attribute group."
},
"id": {
"type": "string",
"maxLength": 32,
"description": "Attribute group Id"
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"attributes": {
"type": "array",
"description": "List of the of attribute which are added to the attribute group.",
"items": [{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the attribute group."
},
"id": {
"type": "string",
"maxLength": 32
},
"description": {
"type": "object",
"properties": {
"language": {
"type": "string",
"maxLength": 32,
"description": "The language in which description is present."
},
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
},
"long": {
"type": "string",
"maxLength": 5000,
"description": "Long description"
}
}
},
"dataType": {
"type": "string",
"description": "The attribute data types - string, numeric, boolean, date, enum and picture."
},
"enumlist": {
"type": "array",
"description": "List of the of enumValues objects for different languages.",
"items": [{
"type": "object",
"description": "List of enumerations for each language.",
"properties": {
"enumLang": {
"type": "string",
"description": "The language of the enumeration values."
},
"enumValues": {
"type": "array",
"description": "The enumeration value and it's corresponding code for the language.",
"items": [{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "The code for the enum value."
},
"value": {
"type": "string",
"description": "The enum value in the enumLang."
}
}
}]
}
}
}]
},
"enumValues": {
"deprecated": true,
"type": "array",
"description": "The list of strings or enums of the attribute when the attribute data type is enum. This field will deprecated after 1711 release of AIN. Please use enumlist field for enumeration values."
},
"isMandatory": {
"type": "boolean"
},
"isMultivalue": {
"type": "boolean"
},
"isLanguage": {
"type": "boolean"
},
"isRange": {
"type": "boolean"
},
"isEnumeration": {
"type": "boolean"
},
"hasNormalValue": {
"type": "boolean"
}
}
}]
}
}
}]
}
}
}]
}Example:
[{
"description": {
"language": "en",
"short": "GSK_EQT_001",
"long": "GSK_EQT_001"
},
"name": "GSK_EQT_001",
"id": "56033DE9037F4465B7C79232D7235153",
"parentId": null,
"type": null,
"source": null,
"isSourceActive": 0,
"modelUnits": 0,
"attributeGroups": [{
"description": {
"language": "en",
"short": "AG_Measuring point",
"long": "AG_Measuring point"
},
"name": "AG_Measuring point",
"id": "0741CEB19F1642698A3E0C60C5F65C74",
"attributes": [{
"dataType": "numeric",
"dimension1": "ACBAC",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": true,
"isEnumeration": false,
"hasNormalValue": false,
"description": {
"language": "en",
"short": "abc",
"long": "abc"
},
"name": "abc",
"id": "5A49F641395A4A609F74EB60F88CAEC3",
"dimension1Description": "Acid/Base Capacity",
"unitOfMeasure1": [{
"code": "C36",
"description": "Mole per cubic meter",
"dimension": "ACBAC"
}, {
"code": "C38",
"description": "Mole per liter",
"dimension": "ACBAC"
}, {
"code": "V02",
"description": "Millimole per liter",
"dimension": "ACBAC"
}]
}, {
"dataType": "numeric",
"dimension1": "ACBAC",
"dimension2": "ACCEL",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": true,
"isEnumeration": false,
"hasNormalValue": false,
"description": {
"language": "en",
"short": "changed hjere ",
"long": "change test edit"
},
"name": "akshaytest",
"id": "5522CB2FDDC0458889B524D0BB0C1EC2",
"dimension1Description": "Acid/Base Capacity",
"dimension2Description": "Acceleration",
"unitOfMeasure1": [{
"code": "C36",
"description": "Mole per cubic meter",
"dimension": "ACBAC"
}, {
"code": "C38",
"description": "Mole per liter",
"dimension": "ACBAC"
}, {
"code": "V02",
"description": "Millimole per liter",
"dimension": "ACBAC"
}],
"unitOfMeasure2": [{
"code": "MS2",
"description": "Meter per second squared",
"dimension": "ACCEL"
}]
}, {
"dataType": "numeric",
"dimension1": "ACCEL",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": true,
"isEnumeration": false,
"hasNormalValue": true,
"description": {
"language": "en",
"short": "testonlymp",
"long": "Template_1Template_1"
},
"name": "test",
"id": "6F4B1781F47E464A9E37AAB0635E8213",
"dimension1Description": "Acceleration",
"unitOfMeasure1": [{
"code": "MS2",
"description": "Meter per second squared",
"dimension": "ACCEL"
}]
}],
"adminData": null
}, {
"description": {
"language": "en",
"short": "GSK_EQT_001_AG_001",
"long": "GSK_EQT_001_AG_001"
},
"name": "GSK_EQT_001_AG_001",
"id": "5DD8213D91A34B62AEECF792C70E0FB7",
"attributes": [{
"dataType": "string",
"enumValues": [],
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"name": "ACL_ATR_02UY8TG8LehRYZGLjTHBlXRz",
"id": "ACL_ATR_02UY8TG8LehRYZGLjTHBlXRz"
}, {
"dataType": "string",
"enumValues": [],
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"name": "ACL_ATR_03UY8TG8LehRYZGLjTHBlXRz",
"id": "ACL_ATR_03UY8TG8LehRYZGLjTHBlXRz"
}, {
"dataType": "numeric",
"dimension1": "PRESS",
"enumValues": [],
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"description": {
"language": "en",
"short": "GSK_EQT_001_AG_001_AT_001",
"long": "GSK_EQT_001_AG_001_AT_001"
},
"name": "GSK_EQT_001_AG_001_AT_001",
"id": "6CA7FBDD4E8C409987759B0847ADF496",
"dimension1Description": "Pressure",
"unitOfMeasure1": [{
"code": "mm HG",
"description": "Conventional millimeter of mercury",
"dimension": "PRESS"
}, {
"code": "HPA",
"description": "Hectopascal",
"dimension": "PRESS"
}, {
"code": "KPA",
"description": "Kilopascal",
"dimension": "PRESS"
}, {
"code": "MPA",
"description": "Megapascal",
"dimension": "PRESS"
}]
}],
"adminData": null
}],
"createdOn": null,
"changedOn": null,
"typeCode": "4"
}]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 update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/values
get
This endpoint gets list of values associated with specified equipmentID.
put
This end point allows you to modify value associated with equipment of specified id.
get /equipment({equipmentId})/values
This endpoint gets list of values associated with specified equipmentID.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- status: (string)
Retrieve equipment based on the status provided. Possible values are - 1, 2 or 3 where 1 - Unpublished, 2 - Published and 3 - Inrevision.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Generated by server, used as read-only"
},
"templates": {
"type": "array",
"description": "Current templates and its parent templates, along with their values",
"items": {
"type": "object",
"properties": {
"templateId": {
"type": "string",
"maxLength": 32,
"description": "One of the template in inheritance chain."
},
"attributeGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeGroupId": {
"type": "string",
"maxLength": 32
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"object": {
"type": "object",
"oneOf": [{
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"value1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"minValue1": {
"type": "string"
},
"value1": {
"type": "string"
},
"maxValue1": {
"type": "string"
},
"minValue2": {
"type": "string"
},
"value2": {
"type": "string"
},
"maxValue2": {
"type": "string"
},
"uom1": {
"type": "string"
},
"uom2": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"value1": {
"type": "array",
"items": {
"type": "string"
}
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"minValue1": {
"type": "string"
},
"maxValue1": {
"type": "string"
},
"uom1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"minValue1": {
"type": "string"
},
"value1": {
"type": "string"
},
"maxValue1": {
"type": "string"
},
"uom1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"value1": {
"type": "string"
},
"value2": {
"type": "string"
},
"uom1": {
"type": "string"
},
"uom2": {
"type": "string"
}
}]
}
}
},
"required": [
"attributeId"
]
}
}
},
"required": [
"attributeGroupId"
]
}
}
},
"required": [
"templateId"
]
}
},
"required": [
"id"
]
}Example:
{
"id": "1D3B9C6FF28F4C90BC39D480CD05681C",
"templates": [{
"templateId": "37C1831052CD49BA83C6BD61DCA449D9",
"attributeGroups": [{
"attributeGroupId": "66A48786C0704503A4F74A0648CB515A",
"attributes": [{
"attributeId": "0D152B665CAB41E6ACC7EEBDD3C8FE44",
"value1": [],
"name": "enumtest1",
"dataType": "enum",
}, {
"attributeId": "1014CCF0025B4863B685ECB1B347D1BF",
"value1": "false",
"name": "ATT2",
"dataType": "boolean",
}]
}, {
"attributeGroupId": "AC2791787ED840D8876364A56C5C2A97",
"attributes": [{
"attributeId": "27A4BC8DA4414C22A7C817A9D5355255",
"value1": [],
"name": "Asian",
"dataType": "enum",
}, {
"attributeId": "C430982F4F3142DCACCF8F0070ECE855",
"value1": "a",
"name": "Jamaican",
"dataType": "enum",
}]
}, {
"attributeGroupId": "D25AAB15969D49B7A7C6222D5C8F6475",
"attributes": [{
"attributeId": "2F96D11911B7463B8B0B11745873A3AB",
"value1": "false",
"name": "efe",
"dataType": "boolean",
}]
}]
}, {
"templateId": "3918B79E52BC4C34801AD36355A4758A",
"attributeGroups": [{
"attributeGroupId": "865A39C0BF8A4708868C8940954F8B9E",
"attributes": [{
"attributeId": "D5AA27F4756E432199F5A65CD7D65265",
"value1": [],
"name": "Enum Multi",
"dataType": "enum",
}, {
"attributeId": "E22B494DECC74DEE9A3BF53F1F9F2993",
"value1": "false",
"name": "eight",
"dataType": "boolean",
}]
}]
}]
}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 update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
put /equipment({equipmentId})/values
This end point allows you to modify value associated with equipment of specified id.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"templates": {
"type": "array",
"description": "Current templates and its parent templates, along with their values",
"items": {
"type": "object",
"properties": {
"templateId": {
"type": "string",
"maxLength": 32,
"description": "One of the template in inheritance chain."
},
"attributeGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeGroupId": {
"type": "string",
"maxLength": 32
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"object": {
"type": "object",
"oneOf": [{
"attributeId": {
"type": "string",
"maxLength": 32
},
"value1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"minvalue1": {
"type": "string"
},
"value1": {
"type": "string"
},
"maxvalue1": {
"type": "string"
},
"minvalue2": {
"type": "string"
},
"value2": {
"type": "string"
},
"maxvalue2": {
"type": "string"
},
"uom1": {
"type": "string"
},
"uom2": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"value1": {
"type": "array",
"items": {
"type": "string"
}
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"minvalue1": {
"type": "string"
},
"maxvalue1": {
"type": "string"
},
"uom1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"minvalue1": {
"type": "string"
},
"value1": {
"type": "string"
},
"maxvalue1": {
"type": "string"
},
"uom1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"value1": {
"type": "string"
},
"value2": {
"type": "string"
},
"uom1": {
"type": "string"
},
"uom2": {
"type": "string"
}
}]
}
}
},
"required": [
"attributeId"
]
}
}
},
"required": [
"attributeGroupId"
]
}
}
},
"required": [
"templateId"
]
}
},
"required": [
"id"
]
}Example:
{
"templates": [{
"templateId": "37C1831052CD49BA83C6BD61DCA449D9",
"attributeGroups": [{
"attributeGroupId": "66A48786C0704503A4F74A0648CB515A",
"attributes": [{
"attributeId": "0D152B665CAB41E6ACC7EEBDD3C8FE44",
"value1": "1"
}, {
"attributeId": "1014CCF0025B4863B685ECB1B347D1BF",
"minvalue1": 10,
"value1": 15,
"maxvalue1": 20,
"uom1": "KM"
}]
}, {
"attributeGroupId": "AC2791787ED840D8876364A56C5C2A97",
"attributes": [{
"attributeId": "27A4BC8DA4414C22A7C817A9D5355255",
"minvalue1": 10,
"value1": 15,
"maxvalue1": 20,
"uom1": "KM",
"minvalue2": 10,
"value2": 15,
"maxvalue2": 20,
"uom2": "H"
}, {
"attributeId": "C430982F4F3142DCACCF8F0070ECE855",
"value1": "a"
}]
}, {
"attributeGroupId": "D25AAB15969D49B7A7C6222D5C8F6475",
"attributes": [{
"attributeId": "2F96D11911B7463B8B0B11745873A3AB",
"value1": "false"
}]
}]
}, {
"templateId": "3918B79E52BC4C34801AD36355A4758A",
"attributeGroups": [{
"attributeGroupId": "865A39C0BF8A4708868C8940954F8B9E",
"attributes": [{
"attributeId": "D5AA27F4756E432199F5A65CD7D65265",
"value1": ["1", "2"]
}, {
"attributeId": "E22B494DECC74DEE9A3BF53F1F9F2993",
"value1": "false"
}, {
"attributeId": "E22B494DECC74DEE9A3BF53F1F9F2993",
"value1": 10.4
}]
}]
}]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "Generated by server, used as read-only"
},
"templates": {
"type": "array",
"description": "Current templates and its parent templates, along with their values",
"items": {
"type": "object",
"properties": {
"templateId": {
"type": "string",
"maxLength": 32,
"description": "One of the template in inheritance chain."
},
"attributeGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributeGroupId": {
"type": "string",
"maxLength": 32
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"object": {
"type": "object",
"oneOf": [{
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"value1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"minValue1": {
"type": "string"
},
"value1": {
"type": "string"
},
"maxValue1": {
"type": "string"
},
"minValue2": {
"type": "string"
},
"value2": {
"type": "string"
},
"maxValue2": {
"type": "string"
},
"uom1": {
"type": "string"
},
"uom2": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"value1": {
"type": "array",
"items": {
"type": "string"
}
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"minValue1": {
"type": "string"
},
"maxValue1": {
"type": "string"
},
"uom1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"minValue1": {
"type": "string"
},
"value1": {
"type": "string"
},
"maxValue1": {
"type": "string"
},
"uom1": {
"type": "string"
}
}, {
"attributeId": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string"
},
"value1": {
"type": "string"
},
"value2": {
"type": "string"
},
"uom1": {
"type": "string"
},
"uom2": {
"type": "string"
}
}]
}
}
},
"required": [
"attributeId"
]
}
}
},
"required": [
"attributeGroupId"
]
}
}
},
"required": [
"templateId"
]
}
},
"required": [
"id"
]
}Example:
{
"id": "1D3B9C6FF28F4C90BC39D480CD05681C",
"templates": [{
"templateId": "37C1831052CD49BA83C6BD61DCA449D9",
"attributeGroups": [{
"attributeGroupId": "66A48786C0704503A4F74A0648CB515A",
"attributes": [{
"attributeId": "0D152B665CAB41E6ACC7EEBDD3C8FE44",
"value1": [],
"name": "enumtest1",
"dataType": "enum",
}, {
"attributeId": "1014CCF0025B4863B685ECB1B347D1BF",
"value1": "false",
"name": "ATT2",
"dataType": "boolean",
}]
}, {
"attributeGroupId": "AC2791787ED840D8876364A56C5C2A97",
"attributes": [{
"attributeId": "27A4BC8DA4414C22A7C817A9D5355255",
"value1": [],
"name": "Asian",
"dataType": "enum",
}, {
"attributeId": "C430982F4F3142DCACCF8F0070ECE855",
"value1": "a",
"name": "Jamaican",
"dataType": "enum",
}]
}, {
"attributeGroupId": "D25AAB15969D49B7A7C6222D5C8F6475",
"attributes": [{
"attributeId": "2F96D11911B7463B8B0B11745873A3AB",
"value1": "false",
"name": "efe",
"dataType": "boolean",
}]
}]
}, {
"templateId": "3918B79E52BC4C34801AD36355A4758A",
"attributeGroups": [{
"attributeGroupId": "865A39C0BF8A4708868C8940954F8B9E",
"attributes": [{
"attributeId": "D5AA27F4756E432199F5A65CD7D65265",
"value1": [],
"name": "Enum Multi",
"dataType": "enum",
}, {
"attributeId": "E22B494DECC74DEE9A3BF53F1F9F2993",
"value1": "false",
"name": "eight",
"dataType": "boolean",
}]
}]
}]
}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 update the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/components
get
Gets list of components attached to equipment of specified Id.
put
Updates list of equipment components.
get /equipment({equipmentId})/components
Gets list of components attached to equipment of specified Id.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- version: (string)
The equipment version to retrieve it's components.
- immediate: (string)
Boolean flag. If 'true' will fetch only immediate children and if the value is specfied as 'false' it will fetch all the children.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string",
"maxLength": 256
},
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
}
}
},
"status": {
"type": "integer",
"description": "The revision status of the equipment. Possible values are: 1 - Unpublished, 2 - Published and 3 - In-revision."
},
"version": {
"type": "integer",
"description": "Version of the equipment."
},
"image": {
"type": "string",
"mediaType": "image/png",
"contentEncoding": "base64"
},
"objectType": {
"type": "string",
"maxLength": 10,
"description": "The object type, EQU - equipment and PRT - part."
},
"source": {
"type": "string",
"maxLength": 256,
"description": "Name of the organization who owns this object."
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"cardinality": {
"type": "integer"
},
"childNodes": {
"type": "array",
"items": {
"$ref": "#"
}
},
"leafNode": {
"type": "boolean",
"description": "This flag indicates that is this equipment is leaf equipment in the hierarchy or not."
}
}
}Example:
{
"id": "30254344DCE14F98B38C5E74E695384D",
"name": "Car",
"description": "Car",
"status": 2,
"version": 0.0,
"image": null,
"objectType": "EQU",
"source": "Honda",
"hasInrevision": false,
"childNodes": [{
"id": "68119601D6C8471C99009A179A69475A",
"name": "Engine",
"description": "Engine",
"status": 2,
"version": 0.0,
"image": null,
"objectType": "EQU",
"source": "Honda",
"hasInrevision": false,
"childNodes": [{
"id": "4F0FFD42EB6849238F5ECF177AFA0961",
"name": "Cylinder",
"description": "Cylinder",
"status": 2,
"version": 1.0,
"image": null,
"objectType": "EQU",
"source": "Honda",
"hasInrevision": false,
"childNodes": []
}]
}, {
"id": "68119601D6C8471C99009A179A69475A",
"name": "Front wheel",
"description": "Front wheel",
"status": 2,
"version": 0.0,
"image": null,
"objectType": "EQU",
"source": "MRF",
"hasInrevision": false,
"childNodes": []
}]
}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 access the model
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
put /equipment({equipmentId})/components
Updates list of equipment components.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- type: (string)
The object type which need to be assigned to the equipment. The allowed values are 'EQU', 'PRT', where 'EQU' is equipment and 'PRT' is part.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"children": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
}
}
}
}
}
}Example:
{
"children": [{
"id": "68119601D6C8471C99009A179A69475A"
}, {
"id": "4F0FFD42EB6849238F5ECF177AFA0961"
}]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"maxLength": 32
},
"name": {
"type": "string",
"maxLength": 256
},
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"maxLength": 255,
"description": "Short description"
}
}
},
"status": {
"type": "integer",
"description": "The revision status of the equipment. Possible values are: 1 - Unpublished, 2 - Published and 3 - In-revision."
},
"version": {
"type": "integer",
"description": "Version of the equipment."
},
"image": {
"type": "string",
"mediaType": "image/png",
"contentEncoding": "base64"
},
"objectType": {
"type": "string",
"maxLength": 10,
"description": "The object type, EQU - equipment and PRT - part."
},
"source": {
"type": "string",
"maxLength": 256,
"description": "Name of the organization who owns this object."
},
"hasInrevision": {
"type": "boolean",
"description": "The flag denotes is there a draft version of the equipment exists or not. Possible values are : 'true' - draft version exists, 'false' - draft version does not exists."
},
"cardinality": {
"type": "integer"
},
"childNodes": {
"type": "array",
"items": {
"$ref": "#"
}
},
"leafNode": {
"type": "boolean",
"description": "This flag indicates that is this equipment is leaf equipment in the hierarchy or not."
}
}
}Example:
{
"id": "30254344DCE14F98B38C5E74E695384D",
"name": "Car",
"description": "Car",
"status": 2,
"version": 0.0,
"image": null,
"objectType": "EQU",
"source": "Honda",
"hasInrevision": false,
"childNodes": [{
"id": "68119601D6C8471C99009A179A69475A",
"name": "Engine",
"description": "Engine",
"status": 2,
"version": 0.0,
"image": null,
"objectType": "EQU",
"source": "Honda",
"hasInrevision": false,
"childNodes": [{
"id": "4F0FFD42EB6849238F5ECF177AFA0961",
"name": "Cylinder",
"description": "Cylinder",
"status": 2,
"version": 1.0,
"image": null,
"objectType": "EQU",
"source": "Honda",
"hasInrevision": false,
"childNodes": []
}]
}, {
"id": "68119601D6C8471C99009A179A69475A",
"name": "Front wheel",
"description": "Front wheel",
"status": 2,
"version": 0.0,
"image": null,
"objectType": "EQU",
"source": "MRF",
"hasInrevision": false,
"childNodes": []
}]
}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 update the model
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/documents
get
Gets all the documents assigned to the equipment of specified id and status.
post
This end point allows you to assign documents to an equipment.
get /equipment({equipmentId})/documents
Gets all the documents assigned to the equipment of specified id and status.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- status: (string)
Retrieve equipment based on the status provided. Possible values are - 1, 2 or 3 where 1 - Unpublished, 2 - Published and 3 - Inrevision.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentList": {
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100,
"description": "The ID of the document which you get from the document upload service."
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of document. We recommend you to use 'internalId' field instead of 'name' since 'name' would be deprecated with next release."
},
"internalId": {
"type": "string",
"maxLength": 255,
"description": "User specified Id. This would replace the 'name' field with the next release"
},
"description": {
"type": "string",
"maxLength": 255,
"description": "Document description."
},
"phaseCode": {
"type": "string",
"maxLength": 1,
"enum": ["1", "2", "3", "4", "5", "6", "7", "8"],
"description": "Phase code enum value."
},
"categoryCode": {
"type": "string",
"maxLength": 2,
"enum": ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18"],
"description": "Category code enum value."
},
"phase": {
"type": "string",
"maxLength": 255
},
"category": {
"type": "string",
"maxLength": 255
},
"source": {
"type": "string",
"maxLength": 255,
"description": "Name of the organization who owns the document."
},
"fileSize": {
"type": "string",
"maxLength": 255
},
"mimeType": {
"type": "string",
"maxLength": 255
}
}
}
}
}
}Example:
[
{
"documentID": "02B50CB8C4C44E2AA52BD667A6C7C0E7",
"name": "rotor.png",
"internalId": "D.TEDX.490",
"description": "Messages ",
"phaseCode": "8",
"categoryCode": "8",
"phase": "Disposal",
"category": "StartupResults",
"source": "Manufacturer",
"fileSize": "9 KB",
"uRL": "ZiUKj5OoTMNgNWjjYrIfwfZHfafDNdRUIihOQAvB9sE",
"mimeType": "image/png"
},
{
"documentID": "749E499CF898433294B27ABB3F4F0DFE",
"name": "test.txt",
"internalId": "D.TEDX.492",
"description": "Testing file upload 2",
"phaseCode": "4",
"categoryCode": "4",
"phase": "Operation",
"category": "InstallationPlan",
"source": "Manufacturer",
"fileSize": "0 KB",
"uRL": "ZiUKj5OoTMNgNWjjYrIfwfZHfafDNdRUIihOQAvB9sE",
"mimeType": "text/plain"
}
]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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}HTTP status code 403
User is not authorized to access the model
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
post /equipment({equipmentId})/documents
This end point allows you to assign documents to an equipment.
URI Parameters
- equipmentId: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"documentList": {
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"documentID": {
"type": "string",
"maxLength": 100,
"description": "This is the ID of the document which you get from the document upload service."
}
}
}
}
}
}Example:
{
"documentList": [{
"documentID": "AFC95C0F472341BFA9D78ABB2898A734"
}, {
"documentID": "860474BAE08C427BB46F399FEAE61862"
}]
}HTTP status code 200
Successfully publishes the list of model mentioned in the request.
/equipment({equipmentId})/timeline
get
This endpoint is used to get all timeline events of the equipment.
get /equipment({equipmentId})/timeline
This endpoint is used to get all timeline events of the equipment.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- status: (string)
Retrieve equipment timeline based on the status provided. Possible values are - 1, 2 or 3 where 1 - Unpublished, 2 - Published and 3 - Inrevision.
HTTP status code 200
Search result based on query parameters
Body
Type: application/json
Example:
[{
"objectID": "B22650A0CE054FC5A4AD0D33FE0E821D",
"objectType": "EQU",
"changeID": "B984A4CEE5CC4099B602BB20FCC63874",
"action": "1",
"actionName": "Object is created",
"emailAddress": "siddesh.b.b@sap.com",
"source": "SAP Operator 1",
"processor": "Siddesh B B",
"preview": "null",
"actionTimeStamp": "2017-02-03 05:23:54.6430000"
}, {
"objectID": "B22650A0CE054FC5A4AD0D33FE0E821D",
"objectType": "EQU",
"changeID": "B984A4CEE5CC4099B602BB20FCC63874",
"action": "1",
"actionName": "Object is created",
"emailAddress": "siddesh.b.b@sap.com",
"source": "SAP Operator 1",
"processor": "Siddesh B B",
"preview": "null",
"actionTimeStamp": "2017-02-03 05:23:54.6430000",
"fieldChanges": [{
"subAction": "32",
"subActionName": "Field Changes",
"fieldName": "Short Description",
"newValue": "desc",
"valueType": "TEXT",
"rank": 10
}, {
"subAction": "32",
"subActionName": "Field Changes",
"fieldName": "Long Description",
"newValue": "desc",
"valueType": "TEXT",
"rank": 10
}, {
"subAction": "32",
"subActionName": "Field Changes",
"fieldName": "ID",
"newValue": "Equipment1001Test",
"valueType": "TEXT",
"rank": 10
}, {
"subAction": "32",
"subActionName": "Field Changes",
"fieldName": "Serial Number",
"newValue": "",
"valueType": "TEXT",
"rank": 10
}, {
"subAction": "32",
"subActionName": "Field Changes",
"fieldName": "Batch Number",
"newValue": "",
"valueType": "TEXT",
"rank": 10
}, {
"subAction": "32",
"subActionName": "Field Changes",
"fieldName": "Operator",
"newValue": "SAP Operator 1",
"valueType": "TEXT",
"rank": 10
}]
}, {
"objectID": "B22650A0CE054FC5A4AD0D33FE0E821D",
"objectType": "EQU",
"changeID": "D754F600F66E498C853EF4F41F8A1EA9",
"action": "12",
"emailAddress": "siddesh.b.b@sap.com",
"source": "SAP Operator 1",
"processor": "Siddesh B B",
"preview": "null",
"actionTimeStamp": "2017-02-03 05:23:54.6470000",
"templateChanges": [{
"subAction": "33",
"subActionName": "Templates Added",
"templateID": "E8048E9FD4564D2A8DA03B10FFE12DE1",
"templateName": "NewTemplateCreatedByAnmol",
"rank": 10,
"source": "KSB",
"description": "NewTemplateCreatedByAnmol"
}]
}]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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}HTTP status code 403
User is not authorized to access the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/instructions
get
This endpoint will get all instructions assigned to the equipment.
get /equipment({equipmentId})/instructions
This endpoint will get all instructions assigned to the equipment.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
HTTP status code 200
Successfully retrieves list of instructions.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"instructionID": {
"type": "string"
},
"title": {
"type": "string",
"description": "Name of instruction. We recommend you to use 'internalId' field instead of 'title' since 'title' would be deprecated with next release."
},
"internalId": {
"type": "string",
"description": "User specified Id. This would replace the 'title' field with the next release"
},
"status": {
"type": "string"
},
"activityCode": {
"type": "string"
},
"duration": {
"type": "string"
},
"description": {
"type": "string"
},
"statusDescription": {
"type": "string"
},
"activityCodeDescription": {
"type": "string"
},
"period": {
"type": "string"
},
"subclass": {
"type": "string"
},
"source": {
"type": "string"
},
"failureModeCode": {
"type": "null"
},
"failureModeCodeDescription": {
"type": "null"
},
"instructionType": {
"type": "string"
},
"instructionTypeDescription": {
"type": "string"
},
"sourceSearchTerms": {
"type": "string"
},
"isInherited": {
"type": "string"
}
}
}
}Example:
[{
"instructionID": "CB075560183A49799DEAE1175456A5D6",
"status": "3",
"activityCode": "8",
"duration": null,
"title": "new ins test 1.9",
"description": "",
"statusDescription": "In Revision",
"activityCodeDescription": "Overhaul",
"period": null,
"subclass": "Adsorber",
"source": "ubuntu123",
"failureModeCode": "HIO",
"failureModeCodeDescription": "High output",
"instructionType": "2",
"instructionTypeDescription": "Breakdown",
"sourceSearchTerms": "Ubuntu12,ubuntu123,abc,abctest",
"internalID": "I.TEDX.490",
"isInherited": "0"
}, {
"instructionID": "553D6B21E6BC4A6C971768F727180A7C",
"status": "3",
"activityCode": "10",
"duration": null,
"title": "this is ins",
"description": "",
"statusDescription": "In Revision",
"activityCodeDescription": "Installation",
"period": null,
"subclass": "ACL_CAT_02UY8TG8LehRYZGLjTHBlXRz",
"source": "BASF1",
"failureModeCode": null,
"failureModeCodeDescription": null,
"instructionType": "3",
"instructionTypeDescription": "Installation",
"sourceSearchTerms": "BASF1,BASF1",
"internalID": "I.TEDX.491",
"isInherited": "0"
}, {
"instructionID": "1ADF3BA63AF5418DB0C4CDE40CF7BF22",
"status": "2",
"activityCode": "7",
"duration": "2 Hours",
"title": null,
"description": null,
"statusDescription": "Published",
"activityCodeDescription": "Inspection",
"period": "20 Weeks",
"subclass": "Aeroderivative",
"source": "ubuntu123",
"failureModeCode": null,
"failureModeCodeDescription": null,
"instructionType": "1",
"instructionTypeDescription": "Planned Maintenance",
"sourceSearchTerms": "Ubuntu12,ubuntu123,abc,abctest",
"internalID": "I.TEDX.492",
"isInherited": "0"
}]HTTP status code 403
User is not authorized to access the equipment
HTTP status code 404
Not Found
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/spareparts
get
Gets all the spareparts assigned to the equipment of specified id.
get /equipment({equipmentId})/spareparts
Gets all the spareparts assigned to the equipment of specified id.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
Query Parameters
- status: (string)
Retrieve spareparts based on the status of the equipment provided. Possible values are - 1, 2 or 3 where 1 - Unpublished, 2 - Published and 3 - Inrevision.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sparepartName": {
"type": "string",
"description": "Name of sparepart. We recommend you to use 'sparepartInternalID' field instead of 'sparepartName' since 'sparepartName' would be deprecated with next release."
},
"sparepartInternalID": {
"type": "string",
"description": "User specified Id. This would replace the 'sparepartName' field with the next release"
},
"manufacturerPartNumber": {
"type": "string"
},
"sparepartDescription": {
"type": "string"
},
"subClass": {
"type": "string"
},
"eanNumber": {
"type": "string"
},
"source": {
"type": "string"
},
"manufacturer": {
"type": "string"
},
"unitOfMeasure": {
"type": "string"
},
"sourceSearchTerms": {
"type": "string"
},
"manufacturerSearchTerms": {
"type": "string"
},
"subClassID": {
"type": "string"
},
"commissioningQuantity": {
"type": "double"
},
"initialQuantity": {
"type": "double"
},
"operationQuantity": {
"type": "double"
},
"quantity": {
"type": "double"
},
"advisedStockQuantity": {
"type": "double"
},
"noOfInstructions": {
"type": "string"
},
"noOfVEDocs": {
"type": "string"
},
"primaryExternalID": {
"type": "string"
},
"sparepartSearchTerms": {
"type": "string"
}
}
}
}Example:
[
{
"id": "57BDE1720A833D6AE10000000A442868",
"sparepartName": "tyre-312fg",
"manufacturerPartNumber": "SP-csv-21",
"sparepartDescription": "sd-new123",
"subClass": "subClassAC",
"eanNumber": "1",
"source": "ubuntu",
"manufacturer": "1112",
"unitOfMeasure": "Mole per cubic meter",
"preview": null,
"sourceSearchTerms": "Ubuntu271,ubuntu,test34,123",
"manufacturerSearchTerms": "1112",
"isSourceActive": 1,
"isManufacturerActive": 1,
"subClassID": "97A6424F9C2D4F38B18CCB671E63BADB",
"commissioningQuantity": "15",
"initialQuantity": "23",
"operationQuantity": "4",
"quantity": "11",
"advisedStockQuantity": "21",
"noOfInstructions": "0",
"noOfVEDocs": "0",
"sparepartInternalID": "tyre-312fg"
},
{
"id": "57B57396725F3D6AE10000000A442868",
"sparepartName": "nutnew",
"manufacturerPartNumber": "SP-new",
"sparepartDescription": "ghjj",
"subClass": "subClassAC",
"eanNumber": "1",
"source": "ubuntu",
"manufacturer": "local",
"unitOfMeasure": "Mole per cubic meter",
"preview": null,
"sourceSearchTerms": "Ubuntu271,ubuntu,test34,123",
"manufacturerSearchTerms": "orgnamemnemo,local,tag003,hello,I1",
"isSourceActive": 1,
"isManufacturerActive": 1,
"subClassID": "97A6424F9C2D4F38B18CCB671E63BADB",
"commissioningQuantity": "15",
"initialQuantity": "9",
"operationQuantity": "10",
"quantity": "12",
"advisedStockQuantity": "2",
"noOfInstructions": "0",
"noOfVEDocs": "0",
"sparepartInternalID": "nutnew"
},
{
"id": "C2BCE717B3A44DD69672E53BDC5ABB16",
"sparepartName": "Part1",
"manufacturerPartNumber": "evev",
"sparepartDescription": "dcd",
"subClass": "Subclass1",
"eanNumber": "",
"source": "ubuntu",
"manufacturer": "1235667",
"unitOfMeasure": "Milligram per liter",
"preview": null,
"sourceSearchTerms": "Ubuntu271,ubuntu,test34,123",
"manufacturerSearchTerms": "1235667",
"isSourceActive": 1,
"isManufacturerActive": 0,
"subClassID": "FFA387A74BAF4049B8FA68A9106B82EC",
"commissioningQuantity": "15",
"initialQuantity": "23",
"operationQuantity": "4",
"quantity": "11",
"advisedStockQuantity": "21",
"noOfInstructions": "0",
"noOfVEDocs": "0",
"sparepartInternalID": "Part1"
}
] 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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}HTTP status code 403
User is not authorized to access the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment({equipmentId})/workorders
get
Gets all the workorders assigned to the equipment of specified id.
get /equipment({equipmentId})/workorders
Gets all the workorders assigned to the equipment of specified id.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- equipmentId: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"workOrderID": {
"type": "string"
},
"internalID": {
"type": "string"
},
"status": {
"type": "string"
},
"statusDescription": {
"type": "string"
},
"workOrderType": {
"type": "string"
},
"workOrderTypeDescription": {
"type": "string"
},
"priority": {
"type": "integer"
},
"priorityDescription": {
"type": "string"
},
"plant": {
"type": "string"
},
"workCenter": {
"type": "string"
},
"shortDescription": {
"type": "string"
},
"longDescription": {
"type": "string"
},
"personResponsible": {
"type": "string"
},
"basicStartDate": {
"type": "date"
},
"basicEndDate": {
"type": "date"
},
"actualStartDate": {
"type": "date"
},
"actualEndDate": {
"type": "date"
},
"createdBy": {
"type": "double"
},
"creationDateTime": {
"type": "timestamp"
},
"lastChangedBy": {
"type": "string"
},
"lastChangeDateTime": {
"type": "timestamp"
},
"progressStatus": {
"type": "string"
},
"progressStatusDescription": {
"type": "string"
}
}
}
}Example:
[{
"workOrderID": "22DD475ABB684A4AA489D55E8DB356BB",
"internalID": "WORK-order1",
"status": "PBD, NEW",
"statusDescription": "Published, New",
"workOrderType": "1",
"workOrderTypeDescription": "Breakdown",
"priority": 5,
"priorityDescription": "Low",
"plant": "France",
"workCenter": "Paris",
"shortDescription": "Local work order",
"longDescription": "abcdefgh",
"personResponsible": "no one",
"basicStartDate": "2017-06-07",
"basicEndDate": "2017-06-17",
"actualStartDate": "2017-06-07",
"actualEndDate": "2017-06-17",
"createdBy": "AC26BBE50EDE41F69D6A11D4C33727A2",
"creationDateTime": "2017-06-03",
"lastChangedBy": "AC26BBE50EDE41F69D6A11D4C33727A2",
"lastChangeDateTime": "2017-06-04",
"progressStatus": "15",
"progressStatusDescription": "Pending"
},
{
"workOrderID": "602C1B09036B42239C52DA9A1D590359",
"internalID": "WORK-order3",
"status": "PBD, NEW",
"statusDescription": "Published, New",
"workOrderType": "1",
"workOrderTypeDescription": "Breakdown",
"priority": 5,
"priorityDescription": "Low",
"plant": "France",
"workCenter": "Paris",
"shortDescription": "Local work order",
"longDescription": "abcdefgh",
"personResponsible": "no one",
"basicStartDate": "2017-06-07",
"basicEndDate": "2017-06-17",
"actualStartDate": "2017-06-07",
"actualEndDate": "2017-06-17",
"createdBy": "AC26BBE50EDE41F69D6A11D4C33727A2",
"creationDateTime": "2017-06-03",
"lastChangedBy": "AC26BBE50EDE41F69D6A11D4C33727A2",
"lastChangeDateTime": "2017-06-04",
"progressStatus": "15",
"progressStatusDescription": "Pending"
},
{
"workOrderID": "7DAD1FF3517241EDAF4DEAEA00E25287",
"internalID": "WORK-order2",
"status": "PBD, NEW",
"statusDescription": "Published, New",
"workOrderType": "4",
"workOrderTypeDescription": "Planned",
"priority": 5,
"priorityDescription": "Low",
"plant": "France",
"workCenter": "Paris",
"shortDescription": "Local work order",
"longDescription": "abcdefgh",
"personResponsible": "no one",
"basicStartDate": "2017-06-07",
"basicEndDate": "2017-06-17",
"actualStartDate": "2017-06-07",
"actualEndDate": "2017-06-17",
"createdBy": "AC26BBE50EDE41F69D6A11D4C33727A2",
"creationDateTime": "2017-06-03",
"lastChangedBy": "AC26BBE50EDE41F69D6A11D4C33727A2",
"lastChangeDateTime": "2017-06-04",
"progressStatus": "15",
"progressStatusDescription": "Pending"
}
]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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}HTTP status code 403
User is not authorized to access the equipment
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment/instructions
put
This endpoint is used to add or remove multiple instructions to or from multiple equipment.
put /equipment/instructions
This endpoint is used to add or remove multiple instructions to or from multiple equipment.
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"operation": {
"type": "string",
"enum": [
"add",
"rmv"
],
"description": "The opeation to be performed."
},
"instructionEquipmentIDList": {
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"instructionID": {
"type": "string",
"maxLength": 32
},
"equipmentID": {
"type": "string",
"maxLength": 32
}
}
}
}
}
}Example:
{
"operation": "add",
"instructionEquipmentIDList": [{
"instructionID": "8EF5A1DEFF254EFBA757C610F55648EA",
"equipmentID": "C788FC7A55064E418FA2BF4DD8A79884"
}]
}HTTP status code 204
Successfully assigned or unassigned instructions from the list of equipments as per the request.
Secured by basic
/equipment/spareparts
put
This endpoint is used to add/remove/update the quantities of multiple parts to an equipment.
put /equipment/spareparts
This endpoint is used to add/remove/update the quantities of multiple parts to an equipment.
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"assigneeID": {
"type": "string",
"description": "Equipment Id to add/remove the parts."
},
"operation": {
"type": "string",
"enum": ["add", "rmv", "upd"]
},
"partAssignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"partID": {
"type": "string"
},
"quantity": {
"type": "string"
},
"operationQuantity": {
"type": "string"
},
"commissioningQuantity": {
"type": "string"
},
"initialQuantity": {
"type": "string"
},
"advisedStockQuantity": {
"type": "string"
}
}
}
}
}
}Example:
{
"assigneeID": "4275E0CD8DBA4DAD9E115C8CADD1E79A",
"operation": "add",
"partAssignments": [{
"partID": "85FD564CB51A424A98F0CD742E12E4DE",
"quantity": "3",
"operationQuantity": "0",
"commissioningQuantity": "0",
"initialQuantity": "0",
"advisedStockQuantity": "4"
}]
}HTTP status code 204
Successfully adds the list of parts mentioned in the request.
HTTP status code 400
Bad request, when equipment or part mentioned in payload doesn't exists.
Secured by basic
/equipment/transfer
put
This endpoint is used to get transfer equipment to other organization.
put /equipment/transfer
This endpoint is used to get transfer equipment to other organization.
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "http://jsonschema.net",
"type": "object",
"properties": {
"description": {
"type": "string",
"length": 5000
},
"changedBy": {
"type": "string",
"length": 32
},
"newClient": {
"type": "string",
"length": 32
}
}
}Example:
{
"description": "chaged to Sold",
"changedBy": "5801A0FA19A93594E10000000A78416B",
"newClient": "5632F247077970ADE10000000A442868"
}HTTP status code 204
Equipment succesfully transfered to the new organization listed in the payload.
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.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}Secured by basic
/organizations
get
This endpoint will get all organizations in the system.
get /organizations
This endpoint will get all organizations in the system.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- $filter: (string)
You can filter the organizations based on the name to get specific organization. For example - /organizations?$filter=substringof('SAP', name ) eq true
HTTP status code 200
Successfully retrieves list of organizations.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"javaType": "com.sap.iot.ain.gen.equipments.EquipmentHeader",
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 32,
"description": "ID of the organization"
},
"name": {
"type": "string",
"maxLength": 255,
"description": "Name of the organization"
},
"image": {
"type": "string",
"mediaType": "image/png",
"contentEncoding": "base64"
}
}
}Example:
[{
"id": "D7E24DDB3CD6492A911286470B6B3218",
"name": "Ariba India",
"image": null
}, {
"id": "03EB9804CCCB4A7D8E3B78D2B13497E1",
"name": "Company",
"image": null
}]HTTP status code 404
Not Found
Secured by basic
/organizations/byrole
get
This endpoint will get organizations with specific role.
get /organizations/byrole
This endpoint will get organizations with specific role.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- roleid: (string)
specific role id to get organization of that role. Role IDs are, 1 - Manufacturer 2 - Service Provider 3 - Operator 4 - Supplier / Dealer 5 - Insurer 6 - Regulator / Authority 7 - Software Partner / Content Partner
- $filter: (string)
You can filter the organizations based on the name to get specific organization. For example - /organizations?$filter=substringof('SAP', name ) eq true
Secured by basic
/organizations/$count
get
This endpoint will get the count of all organizations.
get /organizations/$count
This endpoint will get the count of all organizations.
Secured by basic
REST API supports Basic Authentication
/enumeration
get
This api will allow you to get the enumeration values. For example /enumration?type=EquipmentTracking&type=EquipmentSafetyRisk
get /enumeration
This api will allow you to get the enumeration values. For example /enumration?type=EquipmentTracking&type=EquipmentSafetyRisk
Secured by basic
REST API supports Basic Authentication
Query Parameters
- type: (string)
The type of the enumration. User can specify multiple enumeration types.
HTTP status code 200
Body
Type: application/json
Example:
{
"EquipmentSafetyRisk": [{
"type": "EquipmentSafetyRisk",
"code": "1",
"languageIsoCode": "en",
"description": "Minor"
}, {
"type": "EquipmentSafetyRisk",
"code": "2",
"languageIsoCode": "en",
"description": "Moderate"
}, {
"type": "EquipmentSafetyRisk",
"code": "3",
"languageIsoCode": "en",
"description": "Severe"
}, {
"type": "EquipmentSafetyRisk",
"code": "4",
"languageIsoCode": "en",
"description": "Catastrophic"
}]
}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 access the end point.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/enumerationvalue
get
This api will allow you to get a particular value of an enumeration type. For example /enumration?type=EquipmentSafetyRisk&code=1
get /enumerationvalue
This api will allow you to get a particular value of an enumeration type. For example /enumration?type=EquipmentSafetyRisk&code=1
Secured by basic
REST API supports Basic Authentication
Query Parameters
- type: (string)
The type of the enumration.
- code: (string)
The enumeration code for the specified type.
HTTP status code 200
Body
Type: application/json
Example:
{
"type": "EquipmentSafetyRisk",
"code": "1",
"languageIsoCode": "en",
"description": "Minor"
}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 access the end point.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic
/equipment/attributeSearch
get
This api will allow you to search a equipment based on its attributes values. It accepts a key value, where Key is the internal attribute ID and the value is the String Value or Enum Value depending on the attribute type. It will accept multiple pairs of attribute ID and Values seperated by "and" operator. Currently only "AND" operation is supported. For example /attributeSearch?$filter=CEC3DFF4634C492788AF479894AE4113 eq '266'
get /equipment/attributeSearch
This api will allow you to search a equipment based on its attributes values. It accepts a key value, where Key is the internal attribute ID and the value is the String Value or Enum Value depending on the attribute type. It will accept multiple pairs of attribute ID and Values seperated by "and" operator. Currently only "AND" operation is supported. For example /attributeSearch?$filter=CEC3DFF4634C492788AF479894AE4113 eq '266'
Secured by basic
REST API supports Basic Authentication
HTTP status code 200
Body
Type: application/json
Example:
[
{
"objectID": "06CFF9B05E83414596B5E1B4BF2DDF4A",
"objectName": "Equipment-001",
"objectVersion": "0",
"objectType": "EQU"
},
{
"objectID": "5E230BBE7B35426A8BF3FBAA24240D60",
"objectName": "Equipment-002",
"objectVersion": "0",
"objectType": "EQU"
},
{
"objectID": "E4EF5E63E545414994CD304150C6A90A",
"objectName": "Equipment-003",
"objectVersion": "0",
"objectType": "EQU"
}
]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 access the end point.
HTTP status code 500
Internal Server Error, something unexpected happened.
Secured by basic