# Object APIs

String Length Limit

All properties, variables, and attributes that have a string data type cannot exceed a length of 64135 characters when part of a PUT, POST, or PATCH operation payload.

# POST Create a New Object Model

# /objects

Object Model Limitation

Models created using this endpoint cannot contain more than 9000 short or 3000 complex properties and values in the body, while the maximum object model payload size allowed is 64KB. Whichever limit is crossed first will cause an error.

# Description

Insert based on either objectId + model or unique properties + type.
If no objectId is given and it cannot be determined from related models (using unique properties), a new objectId will be safely generated and assigned to the object model.
If an existing objectId is provided but the given model does not yet exist, the object model given in the request git payload will be used.
Unique properties (as defined in the referenced type) are used to validate that the model does not already exist.
If either the combination of objectId and model already exist or an existing object model can be found by the unique properties an error (409 Conflict) will be raised.
References may NOT be included here. Use the /objects/{objectId}/models/{modelId}/references API for that.
- If referenced type contains related models, the models will also be created.
- The response contains the IDs of created object identities. The root element is the main object; relatedModels is an array of created related models.

Model creation by background application

Background applications are by default considered tenant agnostic (they have access to all data in an instance and no tenant is mapped to the application).

Model creation operation requires tenant to be known, therefore the request shall be decorated with the header:

Application-Tenant-Id: {your-tenant-id}.

# Responses

Code	Description	Schema
201	Created	objectModelCreated
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
409	Conflict	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieves Object Models by filter criteria

# /objects

# Description

Returns paginated response of object models according to the filter criteria.

Filterable properties:

model, type, tags, Name and objectId

# Parameters

Name	Located in	Description	Required	Schema
filter	query	A boolean expression used to filter the results	No	WhereClause
sort	Sorts the value based on SortColumn SortDirection eg: lastModified desc	query	sortClause	No
pageAfter	query	ObjectId for next page	No	string
pageBefore	query	ObjectId for previous page	No	string
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause
includeWorkflow	query	Join results with with their workflow information	No	boolean

# Responses

Code	Description	Schema
200	Success	objectModelList
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieve the list of group/Type

# /objects/aggregate/{groupBy}

# Description

Returns a list of groups/Types and their corresponding instance counts.

Filterable properties:

group
Type

# Parameters

Name	Located in	Description	Required	Schema
groupBy	query	Default value_ : group	Yes	GroupClause
filter	query	A boolean expression used to filter the results	No	WhereClause
sort	Sorts the value based on SortColumn SortDirection eg: lastUpdatedTimeStamp desc	query	sortClause	No
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause
pageAfter	query	ObjectId for next page	No	string
pageBefore	query	ObjectId for previous page	No	string

# Responses

Code	Description	Schema
200	Success	Groups
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieve Object Models

# /objects

# Description

Filterable properties:
- model: string
- type: string
- name: string
- tags: array[string]

# Parameters

Name	Located in	Description	Required	Schema
filter	query	A boolean expression used to filter the results	No	WhereClause
isHolistic	query	Join results with their type definition, adding all components (e.g., variables, methods, etc) and their attributes that are on their respective type to the returned object models. Example: type: `json { "typeId" : "abb.processAutomation.sensors.tempSensor", "model" : "abb.ability.device", "version" : "1.0.0", "properties" : { "serialNumber" : { "dataType" : "string" } }, "variables" : { "temp" : { "dataType" : "numnber" } } }` instance (isHolistic : false): `json { "objectId" : "someId", "model" : "abb.ability.device", "version" : 1, "lastModified" : "2018-07-05T08:48:30.463Z", "type" : "abb.processAutomation.sensors.tempSensor@1", "properties" : { "prop1" : { "value" : "AXF3434311" } }, }` instance (isHolistic : true): `json { "objectId" : "someId", "model" : "abb.ability.device", "type" : "abb.processAutomation.sensors.tempSensor@1", "version" : 1, //This is the ObjectModel version "lastModified" : "2018-07-05T08:48:30.463Z", "properties" : { "prop1" : { "dataType" : "string", "value" : "AXF3434311" } }, "variables" : { "temp" : { "dataType" : "numnber" } } }`	No	boolean
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause

# Responses

Code	Description	Schema
200	Success	objectModelList
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieve Model Identifiers

# /objects/{objectId}/models

# Description

Returns an array of model identifiers (modelIds, e.g., "abb.ability.device") for which object models exist for a given objectId.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	ObjectId for which to list the stored models.	Yes	string

# Responses

Code	Description	Schema
200	List of modelIds for which an object model is available.	modelList
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieve Object Model

# /objects/{objectId}/models/{modelId}

# Description

Returns object with objectId associated with the modelId along with metadata , for example, cre-ated timestamp , updated timestamp, etc.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Objectid	Yes	string
modelId	path	Model identifier	Yes	string
isHolistic	query	Join results with their type definition, adding all components (e.g., variables, methods, etc) and their attributes that are on their respective type to the returned object models. Example: type: `json { "typeId" : "abb.processAutomation.sensors.tempSensor", "model" : "abb.ability.device", "version" : "1.0.0", "properties" : { "serialNumber" : { "dataType" : "string" } }, "variables" : { "temp" : { "dataType" : "numnber" } } }` instance (isHolistic : false): `json { "objectId" : "someId", "model" : "abb.ability.device", "version" : 1, "lastModified" : "2018-07-05T08:48:30.463Z", "type" : "abb.processAutomation.sensors.tempSensor@1", "properties" : { "prop1" : { "value" : "AXF3434311" } }, }` instance (isHolistic : true): `json { "objectId" : "someId", "model" : "abb.ability.device", "type" : "abb.processAutomation.sensors.tempSensor@1", "version" : 1, //This is the ObjectModel version "lastModified" : "2018-07-05T08:48:30.463Z", "properties" : { "prop1" : { "dataType" : "string", "value" : "AXF3434311" } }, "variables" : { "temp" : { "dataType" : "numnber" } } }`	No	boolean
includeWork-flow	query	Join results with their workflow information	No	boolean

The “includeWorkflow” parameter gives the instance metadata details

# Responses

Code	Description	Schema
200	Success	objectModel
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Update Existing Object Model

# /objects/{objectId}/models/{modelId}

# Description

Update existing object model based on given objectId and modelId. If values of unique properties do not match the ones in the database, the request will be rejected with a 400 error. The version must be present in the payload. If a version provided in the payload does not match the one in the database, the request will be rejected with a 409 error.

TIP

Type change functionality allows users to change Type Definition associated with object model during its update (if compatible). See Object Type Modification for more information.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string

# Responses

Code	Description	Schema
204	object model successfully updated.
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
409	Conflict	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PATCH Patch an Existing Object Model

# /objects/{objectId}/models/{modelId}

# Description

Partially update (patch) an existing object model based on a given objectId and modelId.

The payload may consist of a partial object, i.e. only those property values that should be updated or added.
In order to delete an element such as a property, it must be set to NULL in the payload.

For example:

PATCH /objects/ec9581d3-8ff6-4542-85b1-059db23242d5/models/abb.ability.device
"properties" : {"prop1" : null 
}

There is no protection against concurrent writes on this endpoint. In case there are overlapping patches the last one will always apply.
If the value of a unique property is changed, the request is rejected with a 400 error.
The version attribute can be provided optionally. If it is provided, it will be checked the same way as for a PUT operation. If it is not provided, there will be NO cuncurrency check performed.
The version attribute on the object model will be increased by this operation.

# Parameters

Name	Located in	Description	Required	Schema
Return-Object-Model	header	Whether to include object model in the response. Defaults to "false"	No	boolean
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string

# Responses

Code	Description	Schema
200	Success. Returned if an object model was requested (Return-Object-Model=true)	objectModel
204	Success. Retuirned if an object model was not requested (Return-Object-Model=false)
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Remove an Existing Object Model

# /objects/{objectId}/models/{modelId}

# Description

Removes from the database an existing object model identified by objectId and modelId.
Incoming and outgoing references will also be deleted.
Object models referenced by outgoing references with isContainment=true will also be deleted. This will cascade along outgoing references of those object models as well.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string

# Responses

Code	Description	Schema
200	object model(s) successfully deleted. Returns a list of deleted object identifiers.	objectModelDeleted
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Remove an Owner of an Object Model

# /objects/{objectId}/models/{modelId}/owner

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string

# Responses

Code	Description	Schema
204	Success
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Update an Owner of an Object Model

# /objects/{objectId}/models/{modelId}/owner/{ownerId}

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string
ownerId	path	Owner identifier	Yes	string

# Responses

Code	Description	Schema
204	Success
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Update an Owner Object Models

# /objects/owner/{ownerId}

# Parameters

Name	Located in	Description	Required	Schema
ownerId	path	Owner ID	Yes	string

# Responses

Code	Description	Schema
204	Success
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Create a New Type Extension

# /objects/{objectId}/models/{modelId}/extension

# Description

Creates new type definition extension for a specific object model. If the extension for this object model already exists, a new version is created and acts as the current extension for the object model. Historical extensions are preserved for telemetry check purposes.

# Update Extensions

Extensions PUT calls are applicable in both scenarios.

To change the already-existing components, such as variables, properties etc.
To delete the properties from current extensions, even if the extended property has been updated in the object model.

For instance, if a user wants to delete properties from an existing extension that has already been updated in the Object Model with version v2, those same properties will be removed internally from the Object Model as well, and the version will be increased (i.e., if existing version is v2 it will be updated to v3).

Below are some of the sample examples:

GET:Existing Extension

{
 "properties":{
   "length": {
     "dataType": "number",
     "value": 32
   },
  "height": {
      "dataType": "number"
    }
  }
}

ObjectModel with Extended Properties

{
  "model": "abb.ability.device",
  "type": "extensions@1",
  "version": 2,
  "properties": {
    "length": {
      "value": 32
    }
  },
  "objectId": "8e053a1e-4cd3-4fdf-ab41-be3ef33e71c2",
  "tenantId": "97d11902-8505-40bc-9af0-b6c7287a2d2c"
}

PUT:Update Extensions (removed property length)

{
 "properties":{
  "height": {
      "dataType": "number"
    }
  }
}

Updated ObjectModel (length property removed and version incremented)

{
  "model": "abb.ability.device",
  "type": "extensions@1",
  "version": 3, // version updated
  "properties": {},
  "objectId": "8e053a1e-4cd3-4fdf-ab41-be3ef33e71c2",
  "tenantId": "97d11902-8505-40bc-9af0-b6c7287a2d2c"
}

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string

# Responses

Code	Description	Schema
200	Success	extensionVersion
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Get the Latest Type Extension

# /objects/{objectId}/models/{modelId}/extension

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string

# Responses

Code	Description	Schema
200	Success	typeExtensionResponse
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Object model not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Get a Version of a Type Extension

# /objects/{objectId}/models/{modelId}/extension/{version}

# Description

Gets a specified version of a type definition extension for an object model.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string
version	path	Type Extension version	Yes	integer

# Responses

Code	Description	Schema
200	Success	typeExtensionResponse
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Specified object model not found or no extension exist. Response must specify.	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Query All References

# /objects/{objectId}/models/{modelId}/references

# Description

Filterable properties:

name: string, reference name

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string
filter	query	A boolean expression used to filter the results	No	WhereClause
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause

# Responses

Code	Description	Schema
200	List of references.	referenceList
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found - No ObjectModel found for specified resource in the database	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# POST Add Outgoing References

# /objects/{objectId}/models/{modelId}/references/out

# Description

The references provided will be added to the given object model as outgoing references.
Existing references (uniquely identified by source, reference name, and target) will not be duplicated.
References not existing in this request are outside the scope of this request and will not be touched and thus also not deleted. To completely replace a specific reference by name, first a call to DELETE /objects/{objectId}/{models}/{modelId}/references/out/{name} must be issued followed by a POST to this endpoint containing the new set of references.
If the request contains references that are not defined in the type definition of the source, the WHOLE request will be rejected.
If any reference violates constraints for isHierarchical (no cycles, maximum one incoming 'hierarchical' reference per model) or isContainment (maximum one incoming 'containment' reference per model), the WHOLE request will be rejected.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string

# Responses

Code	Description	Schema
201	Successfully added references. Returns the list of reference identifiers in the same order as in the request	[ object ]
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found - No ObjectModel found for specified resource in the database	ServiceErrors
409	Conflict	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Remove All Outgoing References

# /objects/{objectId}/models/{modelId}/references/out/{name}

# Description

Removes all outgoing references based on their name where the source is the given objectId.
Object models that are the target of outgoing references which have isContainment set to "true" will also be deleted. This will cascade along outgoing references of those object models as well.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string
name	path	Reference name	Yes	string

# Responses

Code	Description	Schema
200	Reference(s) successfully deleted. Returns a list of deleted references identifiers.	deletedReferenceList
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Remove Outgoing Reference

# /objects/{objectId}/models/{modelId}/references/out/{name}/{referenceID}

# Description

Removes outgoing reference based on the specified name and referenceId where the source is the given objectId.
Object models that are the target of outgoing references which have isContainment set to "true" will also be deleted. This will cascade along outgoing references of those object models as well.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model identifier	Yes	string
name	path	Reference name	Yes	string
referenceID	path	Reference ID	Yes	string

# Responses

Code	Description	Schema
200	Reference(s) successfully deleted. Returns a list of deleted references identifiers.	deletedReferenceList
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# POST Invoke a Method

# /objects/{objectId}/models/{modelId}/methods/{name}

# Description

A method must be specified in the type of this model. Input payload is specified in the request body. If a callbackUrl has been provided, a method response (whether successful or not) will be delivered there.

# Parameters

Name	Located in	Description	Required	Schema
objectId	path	Object ID	Yes	string
modelId	path	Model definition of object	Yes	string
name	path	Method name	Yes	string

# Responses

Code	Description	Schema
200	Method invoked successfully (sync). Contains the output of this method.	syncMethodResponse
202	Method accepted (async)
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

← Process Metadata Publishers →