Templates API documentation version v1
Application_URL/services/api/v1
About Template
Template defines the format for an equipment. A template consists of attribute group and attributes. There are six different types of templates that can be created – Class Template, Sub Class Template, Model Template, Equipment Template, Location Template, Spare Part Template.
A class template is used as an outline for the creation of similar templates with additional attribute groups and are classified as subclass templates. A model template inherits either a model template or a sub class template.
You can use an equipment template to add attributes to suit your equipment needs. You may choose to add attributes that may not be from a predefined template.
Create a location template to assign a location to your equipment. The location you assign is based on the functionality of the equipment.
You can use an spare part template to add attributes to suit your spare part needs. You may choose to add attributes that may not be from a predefined template.
Purpose
This API allows you to create, update, retrieve, and delete a template
/attribute
post
Creates a attribute
get
Gets all the attributes based on filter conditions or gets count of all the attributes depending upon the query paramters used
put
Updates attribute of specified id and gets the updated attribute
post /attribute
Creates a attribute
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"properties": {
"name": {
"deprecated": true,
"type": "string",
"description": "A mandatory field that defines a unique name for the attribute. Replaced by internalId.",
"required": true,
"maxLength": 40
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the attribute.",
"required": true,
"maxLength": 40
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"dataType": {
"type": "string",
"description": "Defines the kind of data types that can be assigned for an attribute.",
"required ": true,
"enum": [
"string",
"numeric",
"boolean",
"date",
"enum",
"picture"
]
},
"dimension1": {
"type": "string",
"description": "Dimension 1 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"dimension2": {
"type": "string",
"description": "Dimension 2 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"enumValues": {
"type": "array",
"description": "Enumeration values/codes of the attribute in case of enum data type only.",
"items": {
"type": "string",
"maxLength": 40
}
},
"enumlist": {
"type": "array",
"description": "Enumeration values/codes of the attribute in case of enum data type only with multi language support.",
"items": {
"properties": {
"enumValues": {
"type": "array",
"items": {
"code": {
"type": "string",
"description": "The user entered code which corresponds to the values in different languages."
},
"value": {
"type": "string",
"description": "The user entered value specific to the language entered."
}
}
},
"enumLang": {
"type": "string",
"description": "The language code for the selected language.",
"maxLength": 2
}
}
}
},
"isMandatory": {
"type": "boolean"
},
"isMultivalue": {
"type": "boolean"
},
"isLanguage": {
"type": "boolean"
},
"isRange": {
"type": "boolean"
},
"industryStandards": {
"description": "Industry Standards of the attribute is complaint to.",
"required ": true,
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
},
"isEnumeration": {
"type": "boolean"
},
"hasNormalValue": {
"type": "boolean"
},
"optionCode": {
"description": "Specifies the priority - Optional, Mandatory or Recommended.",
"type": "integer"
},
"isMeasuringPoint": {
"description": "If the attribute is a measure point input in case of numeric.",
"type": "boolean"
},
"isMeasuringPointShared": {
"description": "If the attribute is a measure point input which is also shared in case of numeric.",
"type": "boolean"
},
"isLink": {
"description": "Specifies if this string attribute is of type hyper link. This flag can be used only if <isLanguage> is set to false.",
"type": "boolean"
},
"isRelationalOperator":{
"description": "Specifies the condition this numeric attribute will be evaluated for.This flag can be used only if <dimension2> is set to null and <isRange> is set to false.",
"type": "boolean"
}
}
}Example:
{
"internalId": "Number_of_cylinders",
"description": {
"short": "TO demonstrate creation of Attribute ",
"long": "To demonstrate creation of Attribute with numeric datatype"
},
"dataType": "numeric",
"optionCode": "1",
"dimension1": "MASS",
"dimension2": null,
"industryStandards": [{
"industryStandard": "MIMOSA",
"standardID": "1234"
}]
}HTTP status code 200
attribute successfully created and returned details of created attribute along with ID
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"properties": {
"name": {
"deprecated": true,
"type": "string",
"description": "A field that defines a unique name for the attribute.",
"required": true,
"maxLength": 255
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for an attribute.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for an attribute.",
"required": true,
"maxLength": 32
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"dataType": {
"type": "string",
"description": "Defines the kind of data types that can be assigned for an attribute.",
"required ": true,
"enum": [
"string",
"numeric",
"boolean",
"date",
"enum",
"picture"
]
},
"dimension1": {
"type": "string",
"description": "Dimension 1 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"dimension2": {
"type": "string",
"description": "Dimension 2 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"optionCode": {
"description": "The priority of the attribute.",
"type": "string",
"maxLength": 20
},
"option": {
"description": "Specifies the priority - Optional, Mandatory or Recommended.",
"type": "string"
},
"dimension1Description": {
"description": "Description of the dimesnsion1 of the attribute in case of numeric data type only.",
"type": "string"
},
"dimension2Description": {
"description": "Description of the dimension 2 of the attribute in case of numeric data type only.",
"type": "string"
},
"enumValues": {
"type": "array",
"description": "Specifies an array of values which serves as an enumeration for enum attribute.",
"items": {
"type": "string",
"maxLength": 40
}
},
"isMandatory": {
"type": "boolean"
},
"isMultivalue": {
"description" : "Specifies if the enum attribute can support multiple values.",
"type": "boolean"
},
"isLanguage": {
"description" : "Specifies if the value supported by a string attribute is language-dependent or not.",
"type": "boolean"
},
"isRange": {
"description" : "Specifies if the numeric attribute can support a range.",
"type": "boolean"
},
"industryStandards": {
"description": "Industry Standards of the attribute is complaint to.",
"required ": true,
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
},
"isEnumeration": {
"type": "boolean"
},
"hasNormalValue": {
"description": "Specifies if the numeric attribute can support a normal value. This flag can be used only if <isRange> is set to true.",
"type": "boolean"
},
"isMeasuringPoint": {
"description": "If the attribute is a measure point input in case of numeric.",
"type": "boolean"
},
"isMeasuringPointShared": {
"description": "If the attribute is a measure point input which is also shared in case of numeric.",
"type": "boolean"
},
"isLink": {
"description": "Specifies if this string attribute is of type hyper link. This flag can be used only if <isLanguage> is set to false.",
"type": "boolean"
},
"isRelationalOperator":{
"description": "Specifies the condition this numeric attribute will be evaluated for.This flag can be used only if <dimension2> is set to null and <isRange> is set to false.",
"type": "boolean"
}
}
}Example:
{
"dataType": "numeric",
"dimension1": "MASS",
"dimension2": null,
"enumValues": [],
"typeCode": null,
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": "MIMOSA",
"standardID": "1234"
}],
"description": {
"language": "en",
"short": "TO demonstrate creation of Attribute ",
"long": "To demonstrate creation of Attribute with numeric datatype"
},
"name": "Number_of_cylinders",
"internalId": "Number_of_cylinders",
"id": "B984461CC6D3409389709D38845FAAAC",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": "Mass",
"dimension2Description": null
}HTTP status code 400
Bad request.Something wrong with the payload
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"id": { "type" : "string" },
"name": { "type" : "string" }
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessage": "Name already exists",
"EntitiesNotFound": []
}
get /attribute
Gets all the attributes based on filter conditions or gets count of all the attributes depending upon the query paramters used
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves attributes based on the value provided.This parameter follows ODATA URL covention. For eg $filter=(substringof('Design', name) eq true)
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "6562A8E6F2C44272B3DC3F1788CBA742",
"name": "PowerDesign",
"desc": {
"short": "Power Design",
"long": "Power Design"
}
},
{
"id": "2BD2885C3DF34F1688C67D79EC09EBE1",
"name": "StartingSystem",
"desc": {
"short": "Starting System",
"long": "Starting System"
}
},
{
"id": "417A90964B814693A5EFCC3041933D5A",
"name": "CylinderConfiguration",
"desc": {
"short": "Cylinder Configuration",
"long": "Cylinder Configuration"
}
}
]
HTTP status code 400
Bad request, when trying to search using invalid column name
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}put /attribute
Updates attribute of specified id and gets the updated attribute
Secured by basic
REST API supports Basic Authentication
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A mandatory field that describes the unique identifier for an attribute.",
"required": true,
"maxLength": 32
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"dataType": {
"type": "string",
"description": "Defines the kind of data types that can be assigned for an attribute.",
"required ": true,
"enum": [
"string",
"numeric",
"boolean",
"date",
"enum",
"picture"
]
},
"dimension1": {
"type": "string",
"description": "Dimension 1 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"dimension2": {
"type": "string",
"description": "Dimension 2 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"enumValues": {
"type": "array",
"description": "Allows you to specify an array of values which serves as an enumeration for enum attribute.",
"items": {
"type": "string",
"maxLength": 40
}
},
"isMandatory": {
"type": "boolean"
},
"isMultivalue": {
"type": "boolean"
},
"isLanguage": {
"type": "boolean"
},
"isRange": {
"type": "boolean"
},
"industryStandards": {
"description": "Industry Standards of the attribute is complaint to.",
"required ": true,
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
},
"isEnumeration": {
"type": "boolean"
},
"hasNormalValue": {
"type": "boolean"
},
"optionCode": {
"description": "The priority of the attribute.",
"type": "integer"
},
"isMeasuringPoint": {
"description": "If the attribute is a measure point input in case of numeric.",
"type": "boolean"
},
"isMeasuringPointShared": {
"description": "If the attribute is a measure point input which is also shared in case of numeric.",
"type": "boolean"
},
"isLink": {
"description": "Specifies if this string attribute is of type hyper link. This flag can be used only if <isLanguage> is set to false.",
"type": "boolean"
},
"isRelationalOperator":{
"description": "Specifies the condition this numeric attribute will be evaluated for.This flag can be used only if <dimension2> is set to null and <isRange> is set to false.",
"type": "boolean"
}
}
}Example:
{
"id": "6A154EA2D00642C88CF26F8702ECF2D1",
"industryStandards": [{
"industryStandard": "MIMOSA",
"standardID": "1234567"
}],
"dataType": "numeric",
"description": {
"language": "en",
"short": "new",
"long": "new1"
},
"dimension1": "MASS",
"dimension2": null,
"enumValues": [],
"hasNormalValue": false,
"isEnumeration": false,
"isLanguage": false,
"isMandatory": true,
"isMultivalue": false,
"isRange": false
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"properties": {
"name": {
"deprecated": true,
"type": "string",
"description": "A field that defines a unique name for the attribute.",
"required": true,
"maxLength": 255
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for an attribute.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for an attribute.",
"required": true,
"maxLength": 32
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"dataType": {
"type": "string",
"description": "Defines the kind of data types that can be assigned for an attribute.",
"required ": true,
"enum": [
"string",
"numeric",
"boolean",
"date",
"enum",
"picture"
]
},
"dimension1": {
"type": "string",
"description": "Dimension 1 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"dimension2": {
"type": "string",
"description": "Dimension 2 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"optionCode": {
"description": "The priority of the attribute.",
"type": "string",
"maxLength": 20
},
"option": {
"description": "Specifies the priority - Optional, Mandatory or Recommended.",
"type": "string"
},
"dimension1Description": {
"description": "Description of the dimesnsion1 of the attribute in case of numeric data type only.",
"type": "string"
},
"dimension2Description": {
"description": "Description of the dimension 2 of the attribute in case of numeric data type only.",
"type": "string"
},
"enumValues": {
"type": "array",
"description": "Specifies an array of values which serves as an enumeration for enum attribute.",
"items": {
"type": "string",
"maxLength": 40
}
},
"isMandatory": {
"type": "boolean"
},
"isMultivalue": {
"description" : "Specifies if the enum attribute can support multiple values.",
"type": "boolean"
},
"isLanguage": {
"description" : "Specifies if the value supported by a string attribute is language-dependent or not.",
"type": "boolean"
},
"isRange": {
"description" : "Specifies if the numeric attribute can support a range.",
"type": "boolean"
},
"industryStandards": {
"description": "Industry Standards of the attribute is complaint to.",
"required ": true,
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
},
"isEnumeration": {
"type": "boolean"
},
"hasNormalValue": {
"description": "Specifies if the numeric attribute can support a normal value. This flag can be used only if <isRange> is set to true.",
"type": "boolean"
},
"isMeasuringPoint": {
"description": "If the attribute is a measure point input in case of numeric.",
"type": "boolean"
},
"isMeasuringPointShared": {
"description": "If the attribute is a measure point input which is also shared in case of numeric.",
"type": "boolean"
},
"isLink": {
"description": "Specifies if this string attribute is of type hyper link. This flag can be used only if <isLanguage> is set to false.",
"type": "boolean"
},
"isRelationalOperator":{
"description": "Specifies the condition this numeric attribute will be evaluated for.This flag can be used only if <dimension2> is set to null and <isRange> is set to false.",
"type": "boolean"
}
}
}Example:
{
"dataType": "numeric",
"dimension1": "MASS",
"dimension2": null,
"enumValues": [],
"optionCode": "2",
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": "MIMOSA",
"standardID": "1234"
}],
"description": {
"language": "en",
"short": "TO demonstrate updation of Attribute ",
"long": "To demonstrate updation of Attribute with numeric datatype"
},
"name": "Number_of_cylinders",
"internalId": "Number_of_cylinders",
"id": "89BA2FAE86364B95853A4CAB8DB760B1",
"adminData": null,
"type": null,
"option": "Recommended",
"dimension1Description": "Mass",
"dimension2Description": null
}HTTP status code 400
Not Found
get
Provides you the number of all Attributes or the number of Attributes retrieved based on the text provided in the filter parameter.This parameter follows ODATA URL covention.
get /attribute/$count
Provides you the number of all Attributes or the number of Attributes retrieved based on the text provided in the filter parameter.This parameter follows ODATA URL covention.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves Attributes based on the value provided.This parameter follows ODATA URL covention. For eg $filter=(substringof('functionality', Description) eq true)
/attribute({attributeID})
get
Gets template along with autogenerated ID
delete
Deletes the specified attribute.
get /attribute({attributeID})
Gets template along with autogenerated ID
Secured by basic
REST API supports Basic Authentication
URI Parameters
- attributeID: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"properties": {
"name": {
"deprecated": true,
"type": "string",
"description": "A field that defines a unique name for the attribute.",
"required": true,
"maxLength": 255
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for an attribute.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for an attribute.",
"required": true,
"maxLength": 32
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"dataType": {
"type": "string",
"description": "Defines the kind of data types that can be assigned for an attribute.",
"required ": true,
"enum": [
"string",
"numeric",
"boolean",
"date",
"enum",
"picture"
]
},
"dimension1": {
"type": "string",
"description": "Dimension 1 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"dimension2": {
"type": "string",
"description": "Dimension 2 of the attribute in case of numeric data type only.",
"maxLength": 30
},
"optionCode": {
"description": "The priority of the attribute.",
"type": "string",
"maxLength": 20
},
"option": {
"description": "Specifies the priority - Optional, Mandatory or Recommended.",
"type": "string"
},
"dimension1Description": {
"description": "Description of the dimesnsion1 of the attribute in case of numeric data type only.",
"type": "string"
},
"dimension2Description": {
"description": "Description of the dimension 2 of the attribute in case of numeric data type only.",
"type": "string"
},
"enumValues": {
"type": "array",
"description": "Specifies an array of values which serves as an enumeration for enum attribute.",
"items": {
"type": "string",
"maxLength": 40
}
},
"isMandatory": {
"type": "boolean"
},
"isMultivalue": {
"description" : "Specifies if the enum attribute can support multiple values.",
"type": "boolean"
},
"isLanguage": {
"description" : "Specifies if the value supported by a string attribute is language-dependent or not.",
"type": "boolean"
},
"isRange": {
"description" : "Specifies if the numeric attribute can support a range.",
"type": "boolean"
},
"industryStandards": {
"description": "Industry Standards of the attribute is complaint to.",
"required ": true,
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
},
"isEnumeration": {
"type": "boolean"
},
"hasNormalValue": {
"description": "Specifies if the numeric attribute can support a normal value. This flag can be used only if <isRange> is set to true.",
"type": "boolean"
},
"isMeasuringPoint": {
"description": "If the attribute is a measure point input in case of numeric.",
"type": "boolean"
},
"isMeasuringPointShared": {
"description": "If the attribute is a measure point input which is also shared in case of numeric.",
"type": "boolean"
},
"isLink": {
"description": "Specifies if this string attribute is of type hyper link. This flag can be used only if <isLanguage> is set to false.",
"type": "boolean"
},
"isRelationalOperator":{
"description": "Specifies the condition this numeric attribute will be evaluated for.This flag can be used only if <dimension2> is set to null and <isRange> is set to false.",
"type": "boolean"
}
}
}Example:
{
"dataType": "numeric",
"dimension1": "MASS",
"dimension2": null,
"enumValues": [],
"typeCode": null,
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": "MIMOSA",
"standardID": "1234"
}],
"description": {
"language": "en",
"short": "TO demonstrate creation of Attribute ",
"long": "To demonstrate creation of Attribute with numeric datatype"
},
"name": "Number_of_cylinders",
"internalId": "Number_of_cylinders",
"id": "B984461CC6D3409389709D38845FAAAC",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": "Mass",
"dimension2Description": null
}HTTP status code 400
Not Found
Body
Type: application/json
Example:
{
"statusCode": 404,
"errorMessage": "Requested Attribute Not Found"
}delete /attribute({attributeID})
Deletes the specified attribute.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- attributeID: required (string)
HTTP status code 200
If the attribute gets deleted.
HTTP status code 400
Bad request, when attribute is used in other business object.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessages": [
{
"severity": { "type": "string" },
"errorMessage": { "type": "string" },
"repeatedEntities": [
{
"id": { "type": "string" },
"name": { "type": "string" },
"type": { "type": "string" }
}
],
"EntitiesNotFound": []
}
]
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "You cannot delete this attribute/attribute group, as it is used in other objects.You may not be authorized to access some of them. ",
"repeatedEntities": [
{
"id": "4BA809B0D4CF4733BCD0C93241B9B185",
"name": "TestingMPTemplate",
"type": "Model Template"
},
{
"id": "7D959360216D4A22B2100A711E38A02E",
"name": "testmodeltemplatewith2mp1",
"type": "Model"
},
{
"id": "E22F17644D134F0F87E6573BBAF2EF01",
"name": "asdfsdf",
"type": "Equipment"
},
{
"id": "A6A845F3FD70476A95BE8C0C16FDC9A8",
"name": "AS_TEST_123",
"type": "Equipment"
}, {
"id": "8FCC3674303F407C87FDD8AF0C327BD1",
"name": "NML_EQT1",
"type": "Equipment Template"
},
{
"id": "726B1BE1854048F3AF893F8864E0FA9D",
"name": "MPRepeat",
"type": "Attribute Group"
}
],
"EntitiesNotFound": []
}
]
}HTTP status code 500
Internal Server Error, something unexpected happened.
get
Gets all the equipments where this attribute is used and filled out.
get /attribute({attributeID})/equipments
Gets all the equipments where this attribute is used and filled out.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- attributeID: required (string)
HTTP status code 200
Gets all the equipments where this attribute is used and filled out.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": {
"type": "object",
"properties": {
"equipmentID": {
"type": "string"
},
"equipmentInternalID": {
"type": "string"
},
"equipmentVersion": {
"type": "string"
},
"status": {
"type": "string"
},
"statusDescription": {
"type": "string"
},
"source": {
"type": "string"
},
"operatorID": {
"type": "string"
},
"operator": {
"type": "string"
},
"attributeValue": {
"type": "string"
},
"templateID": {
"type": "string"
},
"templateName": {
"type": "string"
},
"attributeGroupID": {
"type": "string"
},
"attributeGroupName": {
"type": "string"
},
"attributeID": {
"type": "string"
},
"attributeName": {
"type": "string"
},
"attributeDataType": {
"type": "string"
}
}
}
}Example:
[{
"equipmentID": "30584D277D6D4568B17EBB8917D0CB15",
"equipmentInternalID": "Pump 43000",
"equipmentVersion": 3,
"status": "2",
"statusDescription": "Published",
"source": "SAP Operator",
"operatorID": "B283596BA46740CFAF1DDB4007707CC1",
"operator": "SAP Operator",
"attributeValue": "100 Centimeter",
"templateID": "0A61794B478846BCAADC82CD7883966D",
"templateName": "newT",
"attributeGroupID": "2BAE7D5855DE6838E10000000A78416B",
"attributeGroupName": "newT1",
"attributeID": "427B929ACC5C4163BC370897429AB0AE",
"attributeName": "A-frame height",
"attributeDataType": "numeric"
}, {
"equipmentID": "8AE55958DA88477FB4276E569E482F5D",
"equipmentInternalID": "tttttttttttttt",
"equipmentVersion": 4,
"status": "3",
"statusDescription": "In Revision",
"source": "SAP Operator",
"operatorID": "B283596BA46740CFAF1DDB4007707CC1",
"operator": "SAP Operator",
"attributeValue": "234 Centimeter",
"templateID": "80E155F1261D479ABA7D549CD71CEB4A",
"templateName": "PLEASEDONOTUSETHISEQIPTEMPLATE",
"attributeGroupID": "D5FC7358ACB56838E10000000A78416B",
"attributeGroupName": "jhgfjegfhjewgfyewgtuyuy",
"attributeID": "427B929ACC5C4163BC370897429AB0AE",
"attributeName": "A-frame height",
"attributeDataType": "numeric"
}, {
"equipmentID": "8AE55958DA88477FB4276E569E482F5D",
"equipmentInternalID": "tttttttttttttt",
"equipmentVersion": 4,
"status": "3",
"statusDescription": "In Revision",
"source": "SAP Operator",
"operatorID": "B283596BA46740CFAF1DDB4007707CC1",
"operator": "SAP Operator",
"attributeValue": "234123 Centimeter",
"templateID": "94CFEF7E8263487DAB287A268DFEAB15",
"templateName": "NewKSBEquipmentTemp",
"attributeGroupID": "CDEC31A6A0E34DD99D45FDF0C5554BE0",
"attributeGroupName": "asdsa",
"attributeID": "427B929ACC5C4163BC370897429AB0AE",
"attributeName": "A-frame height",
"attributeDataType": "numeric"
}, {
"equipmentID": "8AE55958DA88477FB4276E569E482F5D",
"equipmentInternalID": "tttttttttttttt",
"equipmentVersion": 4,
"status": "3",
"statusDescription": "In Revision",
"source": "SAP Operator",
"operatorID": "B283596BA46740CFAF1DDB4007707CC1",
"operator": "SAP Operator",
"attributeValue": "432 Inch",
"templateID": "80E155F1261D479ABA7D549CD71CEB4A",
"templateName": "PLEASEDONOTUSETHISEQIPTEMPLATE",
"attributeGroupID": "F67E0060BFBC493788F97146202EB7A5",
"attributeGroupName": "AddedANewGroupToRetest",
"attributeID": "427B929ACC5C4163BC370897429AB0AE",
"attributeName": "A-frame height",
"attributeDataType": "numeric"
}, {
"equipmentID": "69D633472C4946B48F239454F2B290E9",
"equipmentInternalID": "KSK_EQP6",
"equipmentVersion": 1,
"status": "3",
"statusDescription": "In Revision",
"source": "SAP Operator",
"operatorID": "57E213E626383594E10000000A78416B",
"operator": "Dev",
"attributeValue": "65 Centimeter",
"templateID": "DA61A02BE731413AB104495D50EC8300",
"templateName": "newETShareTest",
"attributeGroupID": "F67E0060BFBC493788F97146202EB7A5",
"attributeGroupName": "AddedANewGroupToRetest",
"attributeID": "427B929ACC5C4163BC370897429AB0AE",
"attributeName": "A-frame height",
"attributeDataType": "numeric"
}]HTTP status code 400
Bad request, when attribute is used in other business object.
HTTP status code 500
Internal Server Error, something unexpected happened.
/attributeGroup
post
Creates a attributeGroup
get
Gets all the attributeGroups based on filter conditions or gets count of all the attributeGroups depending upon the query paramters used
put
Updates attributeGroup of specified id and gets the updated attributeGroup
post /attributeGroup
Creates a attributeGroup
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": {
"name": {
"deprecated": true,
"type": "string",
"description": "A mandatory field that defines a unique name for the attribute group. Replaced by internalId.",
"maxLength": 40
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the attribute group.",
"required": true,
"maxLength": 40
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute group.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"templateId": {
"type": "string",
"description": "Field to assign a template while creating an attribute group.",
"maxLength": 32
},
"attributes": {
"type": "array",
"description": "List of IDs of attributes which are to be added to the attribute group.",
"items": {
"id": {
"type": "string",
"required": true,
"maxLength": 32
}
}
}
}
}Example:
{
"internalId": "Combustion_Engine_Attributes",
"description": {
"short": "Combustion Engine Attributes",
"long": "To demonstrate creation Attribute Group "
},
"attributes": [{
"id": "89BA2FAE86364B95853A4CAB8DB760B1"
}, {
"id": "1E4CA8D2E4454377B2AED65F5884D596"
}]
}HTTP status code 200
attributeGroup successfully created and returned details of created attributeGroup along with ID
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"deprecated": true,
"type": "string",
"description": "Name of the attribute group to be created.",
"maxLength": 255
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the attribute group.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for an attribute group.",
"maxLength": 32
},
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute group.",
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"adminData": {
"type": "object",
"properties": {
"changedOn": {
"type": "string",
"description": "Last modified date of the attribute group."
},
"createdOn": {
"type": "string",
"description": "Creation date of the attribute group."
}
}
},
"attributes": {
"type": "array",
"description": "List of the of attributes which are added to the attribute group."
}
}
}Example:
{
"description": {
"language": "en",
"short": "Combustion Engine Attributes",
"long": "To demonstrate creation Attribute Group "
},
"name": "Combustion_Engine_Attributes",
"internalId": "Combustion_Engine_Attributes",
"id": "E9DEDF78729E4F32A2318CB14805D0B0",
"attributes": [{
"dataType": "numeric",
"dimension1": null,
"dimension2": null,
"enumValues": [],
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": "Mimosa",
"standardID": "1234"
}],
"description": {
"language": "en",
"short": "TO demonstrate updation of Attribute ",
"long": "To demonstrate updation of Attribute with numeric datatype"
},
"name": "Number_of_cylinders",
"internalId": "Number_of_cylinders",
"id": "89BA2FAE86364B95853A4CAB8DB760B1",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": null,
"dimension2Description": null
}, {
"dataType": "picture",
"dimension1": null,
"dimension2": null,
"enumValues": [],
"typeCode": null,
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": ""
}],
"description": {
"language": "en",
"short": "TO check behaviour",
"long": "boolean datatype"
},
"name": "SANImage",
"internalId": "SANImage",
"id": "C72784BCCC4642D99DDFB164F8569AA5",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": null,
"dimension2Description": null
}],
"adminData": null
}HTTP status code 400
Bad request.Something wrong with the payload
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"id": { "type" : "string" },
"name": { "type" : "string" }
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessage": PropertySetType with same name already exists
}
get /attributeGroup
Gets all the attributeGroups based on filter conditions or gets count of all the attributeGroups depending upon the query paramters used
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves attributeGroups based on the value provided.This parameter follows ODATA URL covention. For eg $filter=(substringof('Design', name) eq true)
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "BF180DF3F720494CB721D895C4C73F65",
"name": "CombustionAttributes",
"desc": {
"short": "Combustion Attributes",
"long": "Combustion Attributes"
}
},
{
"id": "80E6C77DCF594857AC1420FFF0276425",
"name": "EngineProperties",
"desc": {
"short": "Engine Properties",
"long": "Engine Properties"
}
},
{
"id": "34C1F52CEDF84336BAA2ADB3A2801982",
"name": "KSB_Engine_Attributes",
"desc": {
"short": "KSB Engine Attributes",
"long": "KSB Engine Attributes"
}
},
{
"id": "1CDB6A9D73454EFDB4A76F533CD8A9A5",
"name": "Awesome ",
"desc": {
"short": "A",
"long": "Awsm"
}
},
{
"id": "8C12009870E84662BDB17CD2632A398B",
"name": "AA",
"desc": {
"short": "aa",
"long": "AA2 "
}
},
{
"id": "90519DA027C54B2E9EBE44D0AFBC514E",
"name": "Fine_1",
"desc": {
"short": "f1",
"long": "F1"
}
},
{
"id": "58DC79735DF84B5AA4E8F440F5A389D2",
"name": "BS_class_ag1",
"desc": {
"short": "BS_class_ag1 short text",
"long": "BS_class_ag1 long test long text"
}
},
{
"id": "7B0E13AD6D904716A4047AD893859028",
"name": "BS_subclass_ag1",
"desc": {
"short": "BS_subclass_ag1 short",
"long": "BS_subclass_ag1 long long long long long "
}
}
]HTTP status code 400
Bad request, when trying to search using invalid column name
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}put /attributeGroup
Updates attributeGroup of specified id and gets the updated attributeGroup
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": {
"id": {
"type": "string",
"description": "A mandatory field containing the unique identifier for the attribute group.",
"required": true,
"maxLength": 32
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute group.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"required ": true,
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"attributes": {
"type": "array",
"required ": true,
"description": "List of all the IDs of attributes which are to be added to the attribute group.",
"items": {
"id": {
"type": "string",
"required": true,
"maxLength": 32
}
}
}
}
}Example:
{
"id": "89BA2FAE86364B95853A4CAB8DB760B1",
"description": {
"language": "en",
"short": "Combustion Engine Attributes",
"long": "To demonstrate updation Attribute Group "
},
"attributes": [
{
"id": "89BA2FAE86364B95853A4CAB8DB760B1"
}, {
"id": "1E4CA8D2E4454377B2AED65F5884D596"
}
]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"deprecated": true,
"type": "string",
"description": "Name of the attribute group to be created.",
"maxLength": 255
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the attribute group.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for an attribute group.",
"maxLength": 32
},
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute group.",
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"adminData": {
"type": "object",
"properties": {
"changedOn": {
"type": "string",
"description": "Last modified date of the attribute group."
},
"createdOn": {
"type": "string",
"description": "Creation date of the attribute group."
}
}
},
"attributes": {
"type": "array",
"description": "List of the of attributes which are added to the attribute group."
}
}
}Example:
{
"description": {
"language": "en",
"short": "Combustion Engine Attributes",
"long": "To demonstrate creation Attribute Group "
},
"name": "Combustion_Engine_Attributes",
"internalId": "Combustion_Engine_Attributes",
"id": "E9DEDF78729E4F32A2318CB14805D0B0",
"attributes": [{
"dataType": "numeric",
"dimension1": null,
"dimension2": null,
"enumValues": [],
"unitOfMeasure1": [],
"unitOfMeasure2": [],
"typeCode": null,
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": "Mimosa",
"standardID": "1234"
}],
"description": {
"language": "en",
"short": "TO demonstrate updation of Attribute ",
"long": "To demonstrate updation of Attribute with numeric datatype"
},
"name": "Number_of_cylinders",
"internalId": "Number_of_cylinders",
"id": "89BA2FAE86364B95853A4CAB8DB760B1",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": null,
"dimension2Description": null
}, {
"dataType": "picture",
"dimension1": null,
"dimension2": null,
"enumValues": [],
"typeCode": null,
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": ""
}],
"description": {
"language": "en",
"short": "TO check behaviour",
"long": "boolean datatype"
},
"name": "SANImage",
"internalId": "SANImage",
"id": "C72784BCCC4642D99DDFB164F8569AA5",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": null,
"dimension2Description": null
}],
"adminData": null
}HTTP status code 400
Not Found
get
Provides you the number of all Attribute Groups or the number of Attribute Groups retrieved based on the text provided in the filter parameter.This parameter follows ODATA URL covention.
get /attributeGroup/$count
Provides you the number of all Attribute Groups or the number of Attribute Groups retrieved based on the text provided in the filter parameter.This parameter follows ODATA URL covention.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves Attribute Groups based on the value provided.This parameter follows ODATA URL covention. For eg $filter=(substringof('functionality', Description) eq true)
/attributeGroup({attributeGroupID})
get
Gets template along with autogenerated ID
delete
Deletes the specified attribute group.
get /attributeGroup({attributeGroupID})
Gets template along with autogenerated ID
Secured by basic
REST API supports Basic Authentication
URI Parameters
- attributeGroupID: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"deprecated": true,
"type": "string",
"description": "Name of the attribute group to be created.",
"maxLength": 255
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the attribute group.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for an attribute group.",
"maxLength": 32
},
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for an attribute group.",
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a attribute group.",
"maxLength ": 5000
}
}
},
"adminData": {
"type": "object",
"properties": {
"changedOn": {
"type": "string",
"description": "Last modified date of the attribute group."
},
"createdOn": {
"type": "string",
"description": "Creation date of the attribute group."
}
}
},
"attributes": {
"type": "array",
"description": "List of the of attributes which are added to the attribute group."
}
}
}Example:
{
"description": {
"language": "en",
"short": "Combustion Engine Attributes",
"long": "To demonstrate creation Attribute Group "
},
"name": "Combustion_Engine_Attributes",
"internalId": "Combustion_Engine_Attributes",
"id": "E9DEDF78729E4F32A2318CB14805D0B0",
"attributes": [{
"dataType": "numeric",
"dimension1": null,
"dimension2": null,
"enumValues": [],
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": "Mimosa",
"standardID": "1234"
}],
"description": {
"language": "en",
"short": "TO demonstrate updation of Attribute ",
"long": "To demonstrate updation of Attribute with numeric datatype"
},
"name": "Number_of_cylinders",
"internalId": "Number_of_cylinders",
"id": "89BA2FAE86364B95853A4CAB8DB760B1",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": null,
"dimension2Description": null
}, {
"dataType": "picture",
"dimension1": null,
"dimension2": null,
"enumValues": [],
"typeCode": null,
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": ""
}],
"description": {
"language": "en",
"short": "TO check behaviour",
"long": "boolean datatype"
},
"name": "SANImage",
"internalId": "SANImage",
"id": "C72784BCCC4642D99DDFB164F8569AA5",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": null,
"dimension2Description": null
}],
"adminData": null
}HTTP status code 400
Not Found
Body
Type: application/json
Example:
{
"statusCode": 404,
"errorMessage": "Requested AttributeGroup Not Found"
}delete /attributeGroup({attributeGroupID})
Deletes the specified attribute group.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- attributeGroupID: required (string)
HTTP status code 200
If the attibute group gets deleted.
HTTP status code 400
Bad request, when attribute group is used in other business object.
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessages": [
{
"severity": { "type": "string" },
"errorMessage": { "type": "string" },
"repeatedEntities": [
{
"id": { "type": "string" },
"name": { "type": "string" },
"type": { "type": "string" }
}
],
"EntitiesNotFound": []
}
]
}Example:
{
"statusCode": 400,
"errorMessages": [
{
"severity": "ERROR",
"errorMessage": "You cannot delete this attribute/attribute group, as it is used in other objects.You may not be authorized to access some of them. ",
"repeatedEntities": [
{
"id": "4BA809B0D4CF4733BCD0C93241B9B185",
"name": "TestingMPTemplate",
"type": "Model Template"
},
{
"id": "7D959360216D4A22B2100A711E38A02E",
"name": "testmodeltemplatewith2mp1",
"type": "Model"
},
{
"id": "E22F17644D134F0F87E6573BBAF2EF01",
"name": "asdfsdf",
"type": "Equipment"
},
{
"id": "A6A845F3FD70476A95BE8C0C16FDC9A8",
"name": "AS_TEST_123",
"type": "Equipment"
}, {
"id": "8FCC3674303F407C87FDD8AF0C327BD1",
"name": "NML_EQT1",
"type": "Equipment Template"
},
{
"id": "726B1BE1854048F3AF893F8864E0FA9D",
"name": "MPRepeat",
"type": "Attribute Group"
}
],
"EntitiesNotFound": []
}
]
}HTTP status code 500
Internal Server Error, something unexpected happened.
/template
post
Creates a template
get
Allows to search for categories based on query parameters
put
Updates template of specified id and gets the updated template
delete
Allows to delete the list of templates.
post /template
Creates a template
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": {
"name": {
"deprecated": true,
"type": "string",
"description": "This is deprecated since 1705 release and is replcaed with internalId.",
"maxLength": 40
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the template.",
"required": true,
"maxLength": 40
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for a template.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a template.",
"maxLength ": 5000
}
}
},
"parentId": {
"type": "string",
"description": "ID of the Parent Template.",
"maxLength": 32
},
"type": {
"type": "string",
"description": "Template Types where codes refer to 1: Class, 2: Subclass, 3: Model Template, 4: Equipment Template, 5: Location Template, 6: Part Template.",
"required": true,
"enum": [
"1",
"2",
"3",
"4",
"5",
"6"
]
},
"attributeGroups": {
"type": "array",
"description": "List of IDs of Attribute Groups which are to be added to the template.",
"items": {
"id": {
"type": "string",
"required": true,
"maxLength": 32
}
}
}
}
}Example:
{
"internalId": "CombustionEngine_ModelTemplate",
"parentId": "8F157727A52344C19167BD3581B44F76",
"description": {
"short": "Template of type Model Template",
"long": "Sample Template of type class to demonstrate creation of ModelTemplate"
},
"attributeGroups": [{
"id": "E9DEDF78729E4F32A2318CB14805D0B0"
}],
"type": "3"
}HTTP status code 200
template successfully created and returned details of created template along with ID
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for a template."
},
"long": {
"type": "string",
"description": "Defines a long description for a template."
},
"language": {
"type": "string",
"description": "Language of the description for the template."
}
}
},
"name": {
"deprecated": true,
"type": "string",
"description": "This is deprecated since 1705 release and is replcaed with internalId."
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the template."
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for a template."
},
"parentId": {
"type": "string",
"description": "ID of the Parent Template."
},
"type": {
"type": "string",
"description": "Type Description of the created template."
},
"source": {
"type": "string",
"description": "Source organization of the template."
},
"isSourceActive": {
"type": "integer",
"description": "Is the source of the template still active."
},
"modelUnits": {
"type": "integer",
"description": "No of models created out of the template."
},
"attributeGroups": {
"type": "array",
"description": "List of the of attribute groups which are added to the template."
},
"changedOn": {
"type": "string",
"description": "Last modified date of the template."
},
"createdOn": {
"type": "string",
"description": "Creation date of the template."
},
"typeCode": {
"type": "string",
"description": "Type of the created template."
},
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
}
}
}Example:
[
{
"description": {
"language": "en",
"short": "DF Pump Class",
"long": "DF Pump Class"
},
"internalId": "DF-Pump",
"id": "3E6571496E474B7D803CA8146BA87ACF",
"parentId": null,
"type": "Class",
"source": "acme",
"isSourceActive": 1,
"modelUnits": 2,
"attributeGroups": [
{
"description": {
"language": "en",
"short": "DF Pump Attribute Group",
"long": "DF Pump Attribute Group"
},
"name": "DF-PUMP",
"id": "606F0E549A384C938408B5765A4EAFAA",
"attributes": [
{
"dataType": "enum",
"enumValues": [
" Grinder",
"Self Priming",
" Axial Flow",
" Jet",
" Drum",
" Submersible",
" Centrifugal"
],
"optionCode": "2",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": "ISO 14224"
},
{
"industryStandard": "ISO 15926",
"standardID": "ISO15926"
}
],
"description": {
"language": "en",
"short": "Pump Type",
"long": "Pump Type"
},
"name": "PUMP-TYPE",
"id": "3164212F2D2C4E9DB8392A21FC1E2FDE",
"option": "Mandatory",
"dataTypeDescription": "enum"
},
{
"dataType": "enum",
"enumValues": [
" Petrol Engine",
" Diesel Engine",
"Electric Motor",
" Hand"
],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": "ISO 14224"
}
],
"description": {
"language": "en",
"short": "Drive Type",
"long": "Drive Type"
},
"name": "DRIVE-TYPE",
"id": "DE676BDA5DDA402E83336759AF068C7B",
"option": "Recommended",
"dataTypeDescription": "enum"
},
{
"dataType": "numeric",
"dimension1": "SPEED",
"enumValues": [],
"optionCode": "2",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": "iso14224"
}
],
"description": {
"language": "en",
"short": "Speed",
"long": "Speed"
},
"name": "Speed",
"id": "9783BA82397247E3B35976BE489F16BA",
"option": "Mandatory",
"dimension1Description": "Speed",
"dataTypeDescription": "numeric"
}
],
"adminData": null
}
],
"createdOn": "2016-08-01",
"changedOn": "2016-08-01",
"typeCode": "1"
},
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump Subclass",
"long": "DF Centrifugal Pump Subclass"
},
"internalId": "DF-Centrifugal-Pump",
"id": "06B0E771698F4862A8E93139E33E73D2",
"parentId": "3E6571496E474B7D803CA8146BA87ACF",
"type": "Subclass",
"source": "acme",
"isSourceActive": 1,
"modelUnits": 2,
"attributeGroups": [
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump Attribute Group",
"long": "DF Centrifugal Pump Attribute Group"
},
"name": "DF-CENT-PUMP",
"id": "29DB73CCE9F64E82B41B7338428BFB91",
"attributes": [
{
"dataType": "enum",
"enumValues": [
"Steel",
" Stainless Steel ASTM A216; Stainless Steel ASTM A217"
],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "IEC 60050",
"standardID": "IEC 60050"
}
],
"description": {
"language": "en",
"short": "Case Material",
"long": "Case Material"
},
"name": "CASE-MATERIAL",
"id": "50BBB73297334E5B94BD55726AE0D345",
"option": "Recommended",
"dataTypeDescription": "enum"
},
{
"dataType": "enum",
"enumValues": [
" Stainless Steel ASTM A216",
"Steel",
" Stainless Steel ASTM 217"
],
"optionCode": "2",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": ""
}
],
"description": {
"language": "en",
"short": "Impeller Material",
"long": "Impeller Material"
},
"name": "IMPELLER-MATERIAL",
"id": "6797B1FDA11D493D9CEC111E34F5CE1C",
"option": "Mandatory",
"dataTypeDescription": "enum"
}
],
"adminData": null
}
],
"createdOn": "2016-08-01",
"changedOn": "2016-08-01",
"typeCode": "2"
},
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump Model Template 1000",
"long": "DF Centrifugal Pump Model Template 1000"
},
"internalId": "DF-CENT_PUMP_1000_MT",
"id": "28C318AC56BA4EEC9CCE7FA270CEBCBC",
"parentId": "06B0E771698F4862A8E93139E33E73D2",
"type": "Model Template",
"source": "acme",
"isSourceActive": 1,
"modelUnits": 2,
"attributeGroups": [
{
"description": {
"language": "en",
"short": "DF Measuring Point Attribute Group",
"long": "DF Measuring Point Attribute Group"
},
"name": "DF-MEAS-PT-AG",
"id": "241B27D176674F9FA36A55C5ED07E2BE",
"attributes": [
{
"dataType": "numeric",
"dimension1": "LENGTH",
"enumValues": [],
"optionCode": "1",
"isMeasuringPoint": true,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Vibration",
"long": "Vibration"
},
"name": "Vibration",
"id": "B10A11743171466EA66146B828D080C5",
"option": "Recommended",
"dimension1Description": "Length",
"dataTypeDescription": "numeric"
}
],
"adminData": null
},
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump 1000 Model Templ AG",
"long": "DF Centrifugal Pump 1000 Model Template Attribute Group"
},
"name": "DF-CENT-PUMP-MT-AG",
"id": "27B778BA8AC74F37A240959E03EFBD6D",
"attributes": [
{
"dataType": "numeric",
"dimension1": "NODMNSN",
"enumValues": [],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Number of Stages",
"long": "Number of Stages"
},
"name": "NUMBER-STAGES",
"id": "E0D1B340C7D249CF89303DF2F6A563F3",
"option": "Recommended",
"dimension1Description": "(No Dimensions)",
"dataTypeDescription": "numeric"
},
{
"dataType": "numeric",
"dimension1": "LENGTH",
"enumValues": [],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Pump Size",
"long": "Pump Size"
},
"name": "PUMP-SIZE",
"id": "A447370A38FE400B98B6524BFDAC00CD",
"option": "Recommended",
"dimension1Description": "Length",
"dataTypeDescription": "numeric"
},
{
"dataType": "enum",
"enumValues": [
" CW",
"CCW"
],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Pump Rotation",
"long": "Pump Rotation"
},
"name": "ROTATION",
"id": "C0D1A1B220B44B9AA24D71DBF3898F67",
"option": "Recommended",
"dataTypeDescription": "enum"
}
],
"adminData": null
}
],
"createdOn": "2016-08-02",
"changedOn": "2016-08-02",
"typeCode": "3"
}
]HTTP status code 400
Bad request.Something wrong with the payload
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"statusCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"repeatedEntities": {
"type": "array",
"items": {
"additionalProperties": false,
"properties": {
"id": { "type" : "string" },
"name": { "type" : "string" }
}
}
}
}
}Example:
{
"statusCode": 400,
"errorMessage": category with same name already exists
}
get /template
Allows to search for categories based on query parameters
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
allows you to specify filter conditions. For eg $filter=(substringof('design', name) eq true)
HTTP status code 200
Body
Type: application/json
Example:
[
{
"id": "28C318AC56BA4EEC9CCE7FA270CEBCBC",
"name": "DF-CENT_PUMP_1000_MT",
"type": "Model Template",
"parentId": "06B0E771698F4862A8E93139E33E73D2",
"source": "acme",
"isSourceActive": "1",
"langugaeISOCode": null,
"noOfChildCategory": null,
"shortDescription": "DF Centrifugal Pump Model Template 1000",
"createdOn": "2016-08-01",
"changedOn": "2016-08-02",
"noOfModels": 2,
"typeCode": "3",
"description": "DF Centrifugal Pump Model Template 1000",
"internalId": "DF-CENT_PUMP_1000_MT",
},
{
"id": "06B0E771698F4862A8E93139E33E73D2",
"name": "DF-Centrifugal-Pump",
"type": "Subclass",
"parentId": "3E6571496E474B7D803CA8146BA87ACF",
"source": "acme",
"isSourceActive": "1",
"langugaeISOCode": null,
"noOfChildCategory": "1",
"shortDescription": "DF Centrifugal Pump Subclass",
"createdOn": "2016-08-01",
"changedOn": "2016-08-01",
"noOfModels": 2,
"typeCode": "2",
"description": "DF Centrifugal Pump Subclass",
"internalId": "DF-Centrifugal-Pump",
},
{
"id": "3E6571496E474B7D803CA8146BA87ACF",
"name": "DF-Pump",
"type": "Class",
"parentId": null,
"source": "acme",
"isSourceActive": "1",
"langugaeISOCode": null,
"noOfChildCategory": "1",
"shortDescription": "DF Pump Class",
"createdOn": "2016-07-20",
"changedOn": "2016-08-01",
"noOfModels": 2,
"typeCode": "1",
"description": "DF Pump Class",
"internalId": "DF-Pump",
}
]HTTP status code 400
Bad request, when trying to search using invalid column name
Body
Type: application/json
Schema:
{
"statusCode": { "type": "integer" },
"errorMessage": { "type": "string" }
}Example:
{
"statusCode": 400,
"errorMessage": "No property "Desc" exists "
}put /template
Updates template of specified id and gets the updated template
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": {
"id": {
"type": "string",
"description": "A mandatory field containing the unique identifier for a template.",
"required": true,
"maxLength": 32
},
"description": {
"type": "object",
"required": true,
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for a template.",
"required ": true,
"maxLength": 255
},
"long": {
"type": "string",
"description": "Defines a long description for a template.",
"required ": true,
"maxLength ": 5000
}
}
},
"attributeGroups": {
"type": "array",
"required": true,
"description": "List of IDs of all the attribute groups which are to be added to the template.",
"items": {
"id": {
"type": "string",
"required": true,
"maxLength": 32
}
}
}
}
}Example:
{
"id": "5911C892A70743F4AA52AAD1F9832430",
"description": {
"short": "Template of type Model Template",
"long": "Sample Template of type class to demonstrate updation of ModelTemplate"
},
"attributeGroups": [{
"id": "E9DEDF78729E4F32A2318CB14805D0B0"
}]
}HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for a template."
},
"long": {
"type": "string",
"description": "Defines a long description for a template."
},
"language": {
"type": "string",
"description": "Language of the description for the template."
}
}
},
"name": {
"deprecated": true,
"type": "string",
"description": "This is deprecated since 1705 release and is replcaed with internalId."
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the template."
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for a template."
},
"parentId": {
"type": "string",
"description": "ID of the Parent Template."
},
"type": {
"type": "string",
"description": "Type Description of the created template."
},
"source": {
"type": "string",
"description": "Source organization of the template."
},
"isSourceActive": {
"type": "integer",
"description": "Is the source of the template still active."
},
"modelUnits": {
"type": "integer",
"description": "No of models created out of the template."
},
"attributeGroups": {
"type": "array",
"description": "List of the of attribute groups which are added to the template."
},
"changedOn": {
"type": "string",
"description": "Last modified date of the template."
},
"createdOn": {
"type": "string",
"description": "Creation date of the template."
},
"typeCode": {
"type": "string",
"description": "Type of the created template."
},
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
}
}
}Example:
[{
"description": {
"language": "en",
"short": "Template of type class",
"long": "Sample Template of type class to faciliatate creation of Sublacc"
},
"internalId": "CombustionEngine_class",
"id": "0C82BCCD3A104F0786FA338E5938736C",
"parentId": null,
"type": "Class",
"attributeGroups": [],
"adminData": null,
"changedOn": "2016-01-27"
}, {
"description": {
"language": "en",
"short": "Template of type Subclass",
"long": "Sample Template of type class to faciliatate creation of ModelTemplate"
},
"internalId": "CombustionEngine_Subclass",
"id": "8F157727A52344C19167BD3581B44F76",
"parentId": "0C82BCCD3A104F0786FA338E5938736C",
"type": "Subclass",
"attributeGroups": [],
"adminData": null,
"changedOn": "2016-01-27"
}, {
"description": {
"language": "en",
"short": "Template of type Model Template",
"long": "Sample Template of type class to demonstrate updation of ModelTemplate"
},
"internalId": "CombustionEngine_ModelTemplate",
"id": "5911C892A70743F4AA52AAD1F9832430",
"parentId": "8F157727A52344C19167BD3581B44F76",
"type": "Model Template",
"attributeGroups": [{
"description": {
"language": "en",
"short": "Combustion Engine Attributes",
"long": "To demonstrate creation Attribute Group "
},
"name": "Combustion_Engine_Attributes",
"id": "E9DEDF78729E4F32A2318CB14805D0B0",
"attributes": [{
"dataType": "numeric",
"dimension1": null,
"dimension2": null,
"enumValues": [],
"unitOfMeasure1": [],
"unitOfMeasure2": [],
"typeCode": null,
"optionCode": null,
"isMandatory": false,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [{
"industryStandard": "Mimosa",
"standardID": "1234"
}],
"description": {
"language": "en",
"short": "TO demonstrate updation of Attribute ",
"long": "To demonstrate updation of Attribute with numeric datatype"
},
"name": "Number_of_cylinders",
"id": "89BA2FAE86364B95853A4CAB8DB760B1",
"adminData": null,
"type": null,
"option": null,
"dimension1Description": null,
"dimension2Description": null
}],
"adminData": null
}],
"adminData": null,
"changedOn": "2016-01-27"
}]HTTP status code 400
Not Found
delete /template
Allows to delete the list of templates.
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": {
"idList": {
"type": "array",
"description": "List of IDs of all the templates which are to be deleted.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"required": true,
"maxLength": 32
}
}
}
}
}Example:
{
"idList": [{
"id": "694B88B0ED454960A8904DD85721BFF9"
}, {
"id": "694B88B0ED454960A8914DD85721BFF9"
}]
}get
Provides you the number of all Templates or the number of Templates retrieved based on the text provided in the filter parameter.This parameter follows ODATA URL covention.
get /template/$count
Provides you the number of all Templates or the number of Templates retrieved based on the text provided in the filter parameter.This parameter follows ODATA URL covention.
Secured by basic
REST API supports Basic Authentication
Query Parameters
- filter: (string)
Retrieves Templates based on the value provided.This parameter follows ODATA URL covention. For eg $filter=(substringof('functionality', Description) eq true)
/template({id})
get
Gets template along with autogenerated ID
delete
Allows to delete the template.
get /template({id})
Gets template along with autogenerated ID
Secured by basic
REST API supports Basic Authentication
URI Parameters
- id: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"description": {
"type": "object",
"properties": {
"short": {
"type": "string",
"description": "Defines a short description for a template."
},
"long": {
"type": "string",
"description": "Defines a long description for a template."
},
"language": {
"type": "string",
"description": "Language of the description for the template."
}
}
},
"name": {
"deprecated": true,
"type": "string",
"description": "This is deprecated since 1705 release and is replcaed with internalId."
},
"internalId": {
"type": "string",
"description": "A mandatory field that defines a unique internal ID for the template."
},
"id": {
"type": "string",
"description": "A unique identifier generated by the system for a template."
},
"parentId": {
"type": "string",
"description": "ID of the Parent Template."
},
"type": {
"type": "string",
"description": "Type Description of the created template."
},
"source": {
"type": "string",
"description": "Source organization of the template."
},
"isSourceActive": {
"type": "integer",
"description": "Is the source of the template still active."
},
"modelUnits": {
"type": "integer",
"description": "No of models created out of the template."
},
"attributeGroups": {
"type": "array",
"description": "List of the of attribute groups which are added to the template."
},
"changedOn": {
"type": "string",
"description": "Last modified date of the template."
},
"createdOn": {
"type": "string",
"description": "Creation date of the template."
},
"typeCode": {
"type": "string",
"description": "Type of the created template."
},
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string"
},
"standardID": {
"type": "string"
}
}
}
}
}
}Example:
[
{
"description": {
"language": "en",
"short": "DF Pump Class",
"long": "DF Pump Class"
},
"internalId": "DF-Pump",
"id": "3E6571496E474B7D803CA8146BA87ACF",
"parentId": null,
"type": "Class",
"source": "acme",
"isSourceActive": 1,
"modelUnits": 2,
"attributeGroups": [
{
"description": {
"language": "en",
"short": "DF Pump Attribute Group",
"long": "DF Pump Attribute Group"
},
"name": "DF-PUMP",
"id": "606F0E549A384C938408B5765A4EAFAA",
"attributes": [
{
"dataType": "enum",
"enumValues": [
" Grinder",
"Self Priming",
" Axial Flow",
" Jet",
" Drum",
" Submersible",
" Centrifugal"
],
"optionCode": "2",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": "ISO 14224"
},
{
"industryStandard": "ISO 15926",
"standardID": "ISO15926"
}
],
"description": {
"language": "en",
"short": "Pump Type",
"long": "Pump Type"
},
"name": "PUMP-TYPE",
"id": "3164212F2D2C4E9DB8392A21FC1E2FDE",
"option": "Mandatory",
"dataTypeDescription": "enum"
},
{
"dataType": "enum",
"enumValues": [
" Petrol Engine",
" Diesel Engine",
"Electric Motor",
" Hand"
],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": "ISO 14224"
}
],
"description": {
"language": "en",
"short": "Drive Type",
"long": "Drive Type"
},
"name": "DRIVE-TYPE",
"id": "DE676BDA5DDA402E83336759AF068C7B",
"option": "Recommended",
"dataTypeDescription": "enum"
},
{
"dataType": "numeric",
"dimension1": "SPEED",
"enumValues": [],
"optionCode": "2",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": "iso14224"
}
],
"description": {
"language": "en",
"short": "Speed",
"long": "Speed"
},
"name": "Speed",
"id": "9783BA82397247E3B35976BE489F16BA",
"option": "Mandatory",
"dimension1Description": "Speed",
"dataTypeDescription": "numeric"
}
],
"adminData": null
}
],
"createdOn": "2016-08-01",
"changedOn": "2016-08-01",
"typeCode": "1"
},
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump Subclass",
"long": "DF Centrifugal Pump Subclass"
},
"internalId": "DF-Centrifugal-Pump",
"id": "06B0E771698F4862A8E93139E33E73D2",
"parentId": "3E6571496E474B7D803CA8146BA87ACF",
"type": "Subclass",
"source": "acme",
"isSourceActive": 1,
"modelUnits": 2,
"attributeGroups": [
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump Attribute Group",
"long": "DF Centrifugal Pump Attribute Group"
},
"name": "DF-CENT-PUMP",
"id": "29DB73CCE9F64E82B41B7338428BFB91",
"attributes": [
{
"dataType": "enum",
"enumValues": [
"Steel",
" Stainless Steel ASTM A216; Stainless Steel ASTM A217"
],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "IEC 60050",
"standardID": "IEC 60050"
}
],
"description": {
"language": "en",
"short": "Case Material",
"long": "Case Material"
},
"name": "CASE-MATERIAL",
"id": "50BBB73297334E5B94BD55726AE0D345",
"option": "Recommended",
"dataTypeDescription": "enum"
},
{
"dataType": "enum",
"enumValues": [
" Stainless Steel ASTM A216",
"Steel",
" Stainless Steel ASTM 217"
],
"optionCode": "2",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [
{
"industryStandard": "ISO 14224",
"standardID": ""
}
],
"description": {
"language": "en",
"short": "Impeller Material",
"long": "Impeller Material"
},
"name": "IMPELLER-MATERIAL",
"id": "6797B1FDA11D493D9CEC111E34F5CE1C",
"option": "Mandatory",
"dataTypeDescription": "enum"
}
],
"adminData": null
}
],
"createdOn": "2016-08-01",
"changedOn": "2016-08-01",
"typeCode": "2"
},
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump Model Template 1000",
"long": "DF Centrifugal Pump Model Template 1000"
},
"internalId": "DF-CENT_PUMP_1000_MT",
"id": "28C318AC56BA4EEC9CCE7FA270CEBCBC",
"parentId": "06B0E771698F4862A8E93139E33E73D2",
"type": "Model Template",
"source": "acme",
"isSourceActive": 1,
"modelUnits": 2,
"attributeGroups": [
{
"description": {
"language": "en",
"short": "DF Measuring Point Attribute Group",
"long": "DF Measuring Point Attribute Group"
},
"name": "DF-MEAS-PT-AG",
"id": "241B27D176674F9FA36A55C5ED07E2BE",
"attributes": [
{
"dataType": "numeric",
"dimension1": "LENGTH",
"enumValues": [],
"optionCode": "1",
"isMeasuringPoint": true,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Vibration",
"long": "Vibration"
},
"name": "Vibration",
"id": "B10A11743171466EA66146B828D080C5",
"option": "Recommended",
"dimension1Description": "Length",
"dataTypeDescription": "numeric"
}
],
"adminData": null
},
{
"description": {
"language": "en",
"short": "DF Centrifugal Pump 1000 Model Templ AG",
"long": "DF Centrifugal Pump 1000 Model Template Attribute Group"
},
"name": "DF-CENT-PUMP-MT-AG",
"id": "27B778BA8AC74F37A240959E03EFBD6D",
"attributes": [
{
"dataType": "numeric",
"dimension1": "NODMNSN",
"enumValues": [],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Number of Stages",
"long": "Number of Stages"
},
"name": "NUMBER-STAGES",
"id": "E0D1B340C7D249CF89303DF2F6A563F3",
"option": "Recommended",
"dimension1Description": "(No Dimensions)",
"dataTypeDescription": "numeric"
},
{
"dataType": "numeric",
"dimension1": "LENGTH",
"enumValues": [],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": false,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Pump Size",
"long": "Pump Size"
},
"name": "PUMP-SIZE",
"id": "A447370A38FE400B98B6524BFDAC00CD",
"option": "Recommended",
"dimension1Description": "Length",
"dataTypeDescription": "numeric"
},
{
"dataType": "enum",
"enumValues": [
" CW",
"CCW"
],
"optionCode": "1",
"isMeasuringPoint": false,
"isMeasuringPointShared": false,
"isMandatory": true,
"isMultivalue": false,
"isLanguage": false,
"isRange": false,
"isEnumeration": true,
"hasNormalValue": false,
"industryStandards": [],
"description": {
"language": "en",
"short": "Pump Rotation",
"long": "Pump Rotation"
},
"name": "ROTATION",
"id": "C0D1A1B220B44B9AA24D71DBF3898F67",
"option": "Recommended",
"dataTypeDescription": "enum"
}
],
"adminData": null
}
],
"createdOn": "2016-08-02",
"changedOn": "2016-08-02",
"typeCode": "3"
}
]HTTP status code 400
Not Found
Body
Type: application/json
Example:
{
"statusCode": 404,
"errorMessage": "Requested Template Not Found"
}delete /template({id})
Allows to delete the template.
Secured by basic
REST API supports Basic Authentication
get
Gets specified template along with industry standard data.
put
Adds industry standards each with a standard ID to the specified template.
get /template({id})/industrystandard
Gets specified template along with industry standard data.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- id: required (string)
Query Parameters
- id: (string)
The template ID for the template whose details have to be retireved.
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"templateID": {
"type": "string",
"maxLength": "32"
},
"type": {
"type": "string",
"maxLength": "20"
},
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string",
"maxLength": 40
},
"standardID": {
"type": "string",
"maxLength": 40
}
}
}
}
}
}Example:
{
"templateID": "E46A2DAA48E84062A64910E6DBD6894D",
"type": "Class",
"industryStandards": [{
"industryStandard": "ISO 15926",
"standardID": "1745328"
}, {
"industryStandard": "IEC 60050",
"standardID": "153820"
}]
}HTTP status code 400
Bad request, when template doesn't exists.
HTTP status code 500
Internal Server Error, something unexpected happened.
put /template({id})/industrystandard
Adds industry standards each with a standard ID to the specified template.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- id: required (string)
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string",
"maxLength": 40
},
"standardID": {
"type": "string",
"maxLength": 40
}
}
}
}
}
}Example:
[{
"industryStandard": "ISO 15926",
"standardID": "1745328"
}, {
"industryStandard": "IEC 60050",
"standardID": "153820"
}]HTTP status code 200
Industry standard successfully created and returned details of updated template.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"templateID": {
"type": "string",
"maxLength": "32"
},
"type": {
"type": "string",
"maxLength": "20"
},
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string",
"maxLength": 40
},
"standardID": {
"type": "string",
"maxLength": 40
}
}
}
}
}
}Example:
{
"templateID": "E46A2DAA48E84062A64910E6DBD6894D",
"type": "Class",
"industryStandards": [{
"industryStandard": "ISO 15926",
"standardID": "1745328"
}, {
"industryStandard": "IEC 60050",
"standardID": "153820"
}]
}HTTP status code 400
Bad request.Something wrong with the payload
delete
Deletes the specified industry standards added to the specified template or all the templates if the indstd is blank.
delete /template({id})/industrystandard({indstd})
Deletes the specified industry standards added to the specified template or all the templates if the indstd is blank.
Secured by basic
REST API supports Basic Authentication
URI Parameters
- id: required (string)
- indstd: required (string)
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"templateID": {
"type": "string",
"maxLength": "32"
},
"type": {
"type": "string",
"maxLength": "20"
},
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string",
"maxLength": 40
},
"standardID": {
"type": "string",
"maxLength": 40
}
}
}
}
}
}Example:
{
"templateID": "E46A2DAA48E84062A64910E6DBD6894D",
"type": "Class",
"industryStandards": [{
"industryStandard": "ISO 15926",
"standardID": "1745328"
}, {
"industryStandard": "IEC 60050",
"standardID": "153820"
}]
}HTTP status code 400
Bad request, when template doesn't exists.
HTTP status code 403
User is not authorized to update the template.
HTTP status code 500
Internal Server Error, something unexpected happened.
/industrystandard
get
Gets the list of allowed Industry Standard codes.
get /industrystandard
Gets the list of allowed Industry Standard codes.
Secured by basic
REST API supports Basic Authentication
HTTP status code 200
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"industryStandards": {
"type": "array",
"items": {
"properties": {
"industryStandard": {
"type": "string",
"maxLength": 40
}
}
}
}
}
}Example:
[{
"industryStandard": "ISO 15926"
}, {
"industryStandard": "IEC 60050"
}, {
"industryStandard": "ISO 14224"
}, {
"industryStandard": "MIMOSA"
}, {
"industryStandard": "IO-Link"
}]HTTP status code 500
Internal Server Error, something unexpected happened.
/enumeration/attributedimensions
get
Gets all the attributedimensions enumerations.
get /enumeration/attributedimensions
Gets all the attributedimensions enumerations.
Secured by basic
REST API supports Basic Authentication
HTTP status code 200
Gets all the attributedimensions enumerations.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array",
"items": [{
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Code"
},
"description": {
"type": "string"
},
"uoms": {
"type": "enum"
}
}
}]
}Example:
{
"attributeDimensions": [
{
"code": "NODMNSN",
"description": "(No Dimensions)",
"uoms": [
"Activity unit",
"Ampere hour",
"Bag",
"Bottle",
"Bushel",
"Canister",
"Cardboard box",
"Carton",
"Case",
"Copies",
"Crate",
"Data in GB",
"Data in KB",
"Data in MB",
"Degree",
"Dozen",
"Drum",
"Each",
"Enzyme units/milliliter",
"Gram active ingredient/liter",
"Gram active ingredient/ton",
"Gram gold",
"Gram silver",
"Gross",
"Group proportion",
"International unit",
"Kg active ingredient/kg",
"Kilogram active ingredient",
"Kit",
"MBL",
"Milliliter act. ingr.",
"Moisture (tons)",
"NJ Test",
"No Items",
"Number of persons",
"One ",
"Pack",
"Pair",
"Pallet",
"Piece",
"Pieces",
"Reel",
"Role",
"SCM",
"Set",
"Sheet",
"Thousands",
"Ton Arsenic",
"Ton ash",
"Ton copper",
"Ton dry",
"Troy ounces/ton",
"Troy oz/ton",
"Value-only material"
]
},
{
"code": "ACCEL",
"description": "Acceleration",
"uoms": [
"Meter per second squared"
]
},
{
"code": "ACBAC",
"description": "Acid/Base Capacity",
"uoms": [
"Millimole per liter",
"Mole per cubic meter",
"Mole per liter"
]
},
{
"code": "SURFAC",
"description": "Area",
"uoms": [
"Acre",
"Hectare",
"Liters per 100 km",
"Square centimeter",
"Square foot",
"Square inch",
"Square kilometer",
"Square meter",
"Square mile (statute mile)",
"Square millimeter",
"Square yard"
]
},
{
"code": "CONDUC",
"description": "Conductivity",
"uoms": [
"Microsiemens per centimeter",
"Siemens per meter"
]
},
{
"code": "DENSI",
"description": "Density",
"uoms": [
"Gram per cubic centimeter",
"Gram per cubic meter",
"Gram per liter",
"Kilogram per cubic decimeter",
"Kilogram per cubic meter",
"Kilogram/US Barrel",
"Microgram per cubic meter",
"Microgram per liter",
"Milligram per cubic meter",
"Milligram per liter",
"Pound per cubic foot",
"Pound per gallon (US)",
"Ton/US Barrel",
"Tonne per cubic meter",
"US Ton/US Gallon"
]
},
{
"code": "STEXKZ",
"description": "Dust Explosion Ratio",
"uoms": [
"Meterbar/second",
"Meterpascal/second"
]
},
{
"code": "VISDYN",
"description": "Dynamic viscosity",
"uoms": [
"Centipoise",
"Millipascal seconds",
"Pascal second"
]
},
{
"code": "VOLTAG",
"description": "Electr. Tension",
"uoms": [
"Kilovolt",
"Megavolt",
"Microvolt",
"Millivolt",
"Picovolt",
"Volt"
]
},
{
"code": "ECURR",
"description": "Electric Current",
"uoms": [
"Ampere",
"Kiloampere",
"Megaampere",
"Microampere",
"Milliampere",
"Nanoampere"
]
},
{
"code": "CAPACI",
"description": "Electrical Capacity",
"uoms": [
"Farad",
"Microfarad",
"Millifarad",
"Nanofarad",
"Picofarad"
]
},
{
"code": "RESIST",
"description": "Electrical Resistance",
"uoms": [
"Gigaohm",
"Kiloohm",
"Megaohm",
"Ohm"
]
},
{
"code": "ENERGY",
"description": "Energy",
"uoms": [
"Gigajoule",
"Gigawatt hour",
"Joule",
"Kilojoule",
"Kilovolt - ampere",
"Kilowatt hours",
"Megajoule",
"Megawatt hour (1000 kW.h)",
"Millijoule",
"Petajoule"
]
},
{
"code": "FORCE",
"description": "Force",
"uoms": [
"Kilonewton",
"Meganewton",
"Newton",
"Newton meter"
]
},
{
"code": "FREQU",
"description": "Frequency",
"uoms": [
"1/Minute",
"Bottles per Minute",
"Hertz",
"Kilohertz",
"Megahertz",
"Revolutions per minute",
"Revolutions per second"
]
},
{
"code": "THCOND",
"description": "Heat Conductivity",
"uoms": [
"Watt per meter Kelvin"
]
},
{
"code": "HYDROL",
"description": "Hydrolysis Rate",
"uoms": [
"Liters/Molsecond"
]
},
{
"code": "SURINV",
"description": "Inverse Area",
"uoms": [
"1/Square meter",
"Miles per gallon (US)"
]
},
{
"code": "VISKIN",
"description": "Kinematic viscosity",
"uoms": [
"Square meter per second",
"Square millimeter per second"
]
},
{
"code": "LENGTH",
"description": "Length",
"uoms": [
"Centimeter",
"Decimeter",
"Foot",
"Inch",
"Kilometer",
"Meter",
"Micrometer (micron)",
"Mile (statute mile)",
"Millimeter",
"Nanometer",
"Yards"
]
},
{
"code": "LIGHT",
"description": "Luminous Intensity",
"uoms": [
"Candela"
]
},
{
"code": "MAGNFD",
"description": "Magnetic Field Density",
"uoms": [
"Millitesla",
"Tesla"
]
},
{
"code": "MASS",
"description": "Mass",
"uoms": [
"Gram",
"Hundred weight (UK)",
"Kilogram",
"Kilotonne",
"Milligram",
"Ounce (avoirdupois)",
"Pound",
"Ton (US)",
"Tonne (metric ton)"
]
},
{
"code": "MASSBD",
"description": "Mass Coverage",
"uoms": [
"Gram per square meter",
"Kilogram per square meter",
"Milligram per square centimeter"
]
},
{
"code": "MASFLO",
"description": "Mass Flow",
"uoms": [
"Gram per hour",
"Kilogram per day",
"Kilogram per hour",
"Kilogram per minute",
"Kilogram per second",
"Tonne per day",
"Tonne per hour",
"Tonne per year"
]
},
{
"code": "MPROPO",
"description": "Mass Proportion",
"uoms": [
"Gram/hectogram",
"Gram/kilogram",
"Kilogram per kilogram",
"Kilogram/US Ton",
"Mass parts per billion",
"Mass parts per million",
"Mass parts per trillion",
"Miligram per kilogram",
"Milligram/Gram",
"Percent mass",
"Permille mass",
"Pound per pound",
"Ton/Ton",
"US Pound/US Ton"
]
},
{
"code": "MAPER",
"description": "Mass per Energy",
"uoms": [
"Kilogram/Joule",
"Ton/British Thermal Unit",
"Ton/Joule",
"Ton/Terajoule",
"US Pound/British Thermal Unit",
"US Pound/Million BTU"
]
},
{
"code": "MOENER",
"description": "Molar Energy",
"uoms": [
"Joule per mole",
"Kilojoule per mole"
]
},
{
"code": "MOLMAS",
"description": "Mole Mass",
"uoms": [
"Kilogram/Kilogram mole",
"US Pound/US Pound Mole"
]
},
{
"code": "MOLQU",
"description": "Mole Quantity",
"uoms": [
"Kilomole",
"Millimole",
"Mole"
]
},
{
"code": "TKONZ",
"description": "Particle concentrat.",
"uoms": [
"1/Cubic centimeter",
"1/Cubic meter"
]
},
{
"code": "PERMEA",
"description": "Permeability",
"uoms": [
"Permeation rate",
"Permeation rate SI"
]
},
{
"code": "POINTS",
"description": "Points",
"uoms": [
"Points"
]
},
{
"code": "POWER",
"description": "Power",
"uoms": [
"Gigawatt",
"Kilowatt",
"Megavolt - ampere",
"Megawatt",
"Milliwatt",
"Volt - ampere",
"Watt"
]
},
{
"code": "PRESS",
"description": "Pressure",
"uoms": [
"Bar",
"British Thermal Unit/Cubic Foot",
"British Thermal Unit/US Barrel",
"British Thermal Unit/US Gallon",
"Conventional millimeter of mercury",
"Gigajoule/1000 cubic meters",
"Gigajoule/Cubic meter",
"Hectopascal",
"Joule/Cubic meter",
"Kilopascal",
"Megapascal",
"Millibar",
"Million BTU/US Barrel",
"Newton per square millimeter",
"Pascal",
"Pound-force per square inch",
"Torr"
]
},
{
"code": "PROPOR",
"description": "Proportion",
"uoms": [
"Parts per billion",
"Parts per million",
"Parts per trillion",
"Percentage",
"Permille"
]
},
{
"code": "TEMPRT",
"description": "Rate of Temperature Change",
"uoms": [
"Kelvin per minute",
"Kelvin per second"
]
},
{
"code": "SDL",
"description": "Sound Level",
"uoms": [
"Decibel"
]
},
{
"code": "SPARAD",
"description": "Spec.act.radioac.sub",
"uoms": [
"Becquerel per kilogram",
"Kilobecquerel per kilogram"
]
},
{
"code": "SPREST",
"description": "Specific Electrical Resistance",
"uoms": [
"Ohm centimetre",
"Ohm metre"
]
},
{
"code": "SPENER",
"description": "Specific Energy",
"uoms": [
"British Thermal Unit/US Pound",
"Gigajoule/US Ton",
"Joule/Kilogram",
"Kilojoule/Kilogram",
"Million BTU/US Ton"
]
},
{
"code": "SPAEQU",
"description": "Specific Equivalent",
"uoms": [
"Millimole per gram",
"Millimole per gram",
"Mole per kilogram"
]
},
{
"code": "SPHCAP",
"description": "Specific Heat Capacity",
"uoms": [
"Joule per kilogram kelvin"
]
},
{
"code": "SPEED",
"description": "Speed",
"uoms": [
"Centimeter per hour",
"Centimeter per second",
"Kilometer per hour",
"Meter per Minute",
"Meter per second",
"Meter/Hour",
"Miles per hour (statute mile)",
"Millimeter per hour",
"Millimeter per second",
"Millimeter per year",
"Pages per minute"
]
},
{
"code": "SURFTE",
"description": "Surface Tension",
"uoms": [
"Millinewton per meter",
"Newton per meter"
]
},
{
"code": "TEMP",
"description": "Temperature",
"uoms": [
"Degree Celsius",
"Degree Fahrenheit",
"Kelvin"
]
},
{
"code": "TIME",
"description": "Time",
"uoms": [
"Day",
"Hour",
"Microsecond",
"Millisecond",
"Minute",
"Month",
"Nanosecond",
"Picosecond",
"Second",
"Week",
"Year"
]
},
{
"code": "EVARA",
"description": "Vaporization Speed",
"uoms": [
"Vaporization Speed"
]
},
{
"code": "VOLUME",
"description": "Volume",
"uoms": [
"Barrel (US)",
"Bushel (UK)",
"Centiliter",
"Cubic centimeter",
"Cubic decimeter",
"Cubic foot",
"Cubic inch",
"Cubic meter",
"Cubic millimeter",
"Cubic yard",
"Fluid Ounce (US)",
"Gallon (US)",
"Hectoliter",
"Kiloliter",
"Liter",
"Microliter",
"Milliliter",
"Pint (US)",
"Quart (US)"
]
},
{
"code": "VPROPO",
"description": "Volume proportion",
"uoms": [
"Cubic meter per Cubic meter",
"Milliliter per Cubic meter",
"Percent volume",
"Permille volume",
"Volume parts per billion",
"Volume parts per million",
"Volume parts per trillion"
]
},
{
"code": "VOLFLO",
"description": "Volume rate of flow",
"uoms": [
"Cubic centimeter per second",
"Cubic meter per day",
"Cubic meter per hour",
"Cubic meter per minute",
"Cubic meter per second",
"Gallon (US) per hour",
"Gallon (US) per minute",
"Liter per day",
"Liter per minute",
"Liters per hour"
]
}
]
}HTTP status code 400
Bad request.
HTTP status code 500
Internal Server Error, something unexpected happened.
/templatetypes
get
Gets all the types and their description for template types.
get /templatetypes
Gets all the types and their description for template types.
Secured by basic
REST API supports Basic Authentication
HTTP status code 200
Gets all the types and their description for template types.
Body
Type: application/json
Schema:
{
"$schema": "http://json-schema.org/draft-4/schema",
"type": "object",
"additionalProperties": false,
"properties": {
"industryStandards": {
"type": "array",
"items": {
"properties": {
"type": {
"type": "string",
"maxLength": 40
},
"code": {
"type": "string",
"maxLength": 20
},
"languageIsoCode": {
"type": "string",
"maxLength": 2
},
"description": {
"type": "string",
"maxLength": 5000
}
}
}
}
}
}Example:
[
{
"type": "TemplateType",
"code": "3",
"languageIsoCode": "en",
"description": "Model Template"
},
{
"type": "TemplateType",
"code": "4",
"languageIsoCode": "en",
"description": "Equipment Template"
},
{
"type": "TemplateType",
"code": "5",
"languageIsoCode": "en",
"description": "Location Template"
},
{
"type": "TemplateType",
"code": "6",
"languageIsoCode": "en",
"description": "Spare Part Template"
}
]HTTP status code 400
Bad request.
HTTP status code 500
Internal Server Error, something unexpected happened.