Class: module:api/CustomObjectsApi

module:api/CustomObjectsApi(apiClient)

new module:api/CustomObjectsApi(apiClient)

Constructs a new CustomObjectsApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.

Source:

Methods

getCustomObjectsByIDByID(objectType, key) → {Promise}

Reads a custom object with a given object type ID and a value for the key attribute of the object which represents its unique identifier.

Parameters:
Name Type Description
objectType String

the ID of the object type

key String

the key attribute value of the custom object

Source:
Returns:

a Promise, with data of type module:models/CustomObject

Type
Promise

getCustomObjectsByIDByIDWithHttpInfo(objectType, key) → {Promise}

Reads a custom object with a given object type ID and a value for the key attribute of the object which represents its unique identifier.

Parameters:
Name Type Description
objectType String

the ID of the object type

key String

the key attribute value of the custom object

Source:
Returns:

a Promise, with an object containing data of type module:models/CustomObject and HTTP response

Type
Promise