# Reference 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.

# GET Get a Reference

# /references/{referenceId}

# Parameters

Name	Located in	Description	Required	Schema
referenceId	path	Referenced ID	Yes	string (uuid)

# Responses

Code	Description	Schema
200	Success	fullReference
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	Reference with this id does not exist	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 a Reference

# /references/{referenceId}

# Description

If the reference has the isContainment flag set to "true", the target object models will be deleted. This delete will cascade along the isContainment references of those object models.

# Parameters

Name	Located in	Description	Required	Schema
referenceId	path	Referenced ID	Yes	string (uuid)

# Responses

Code	Description	Schema
200	Reference(s) successfully deleted. Returns deleted references identifier including deleted object models for containment references.	deletedReference
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	Reference with this id does not exist	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 All Attributes of a Reference

# /references/{referenceId}/attributes

# Parameters

Name	Located in	Description	Required	Schema
referenceId	path	Referenced ID	Yes	string (uuid)

# Responses

Code	Description	Schema
200	Success	referenceAttributes
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	Reference with this id does not exist	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 Set All Attributes of a Reference

Fully replaces all existing attributes.

# /references/{referenceId}/attributes

# Description

There is no protection against concurrent writes for attributes of references.

# Parameters

Name	Located in	Description	Required	Schema
referenceId	path	Referenced ID	Yes	string (uuid)

# Responses

Code	Description	Schema
204	Success
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	Reference with this id does not exist	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 an Attribute of a Reference

# /references/{referenceId}/attributes/{attribute}

# Parameters

Name	Located in	Description	Required	Schema
referenceId	path	Referenced ID	Yes	string (uuid)
attribute	path	Attribute name	Yes	string

# Responses

Code	Description	Schema
200	Success	attributeValue
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

# PUT Set an Attribute of a Reference

# /references/{referenceId}/attributes/{attribute}

# Description

Adds or updates a reference's attribute.

# Parameters

Name	Located in	Description	Required	Schema
referenceId	path	Referenced ID	Yes	string (uuid)
attribute	path	Attribute name	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	Reference with this id does not exist	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 Delete an Attribute of a Reference

# /references/{referenceId}/attributes/{attribute}

# Parameters

Name	Located in	Description	Required	Schema
referenceId	path	Referenced ID	Yes	string (uuid)
attribute	path	Attribute name	Yes	string

# Responses

Code	Description	Schema
204	Success
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

← Query Storage →