ConfigurationItemRelatedItems

This entity enables you to view, add, and remove related child or parent Assets in Autotask.

NOTE  You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.

Entity details

Entity Name: ConfigurationItemRelatedItem

Entity Path:

/atservicesrest/v1.0/ConfigurationItemRelatedItems
Can Create:
Can Update:  
Can Query:
Can Delete:
Can Have UDFs:  

If this entity has a Parent relationship, you must perform all Create, Update, and Delete actions on the parent entity. If this entity is a child of a parent, you can leverage our Swagger instance to find the URLs you should use in your API calls. For more information, refer to Finding resource and child access URLs of REST API entities. To learn how to access Swagger, refer to Using Swagger UI to explore REST API requests.

Parent ConfigurationItems
Children Any compatible entity
URLs ConfigurationItemRelatedItems/{id} (GET)
ConfigurationItemRelatedItems/query (GET, POST)
ConfigurationItemRelatedItems/query/count (GET, POST)
ConfigurationItemRelatedItems/entityInformation (GET)
ConfigurationItemRelatedItems/entityInformation/fields (GET)
ConfigurationItems ConfigurationItems/{parentId}/RelatedItems(GET, POST)
ConfigurationItems/{parentId}/RelatedItems/{id} (GET, DELETE)
ConfigurationItems/{parentId}/RelatedItems/entityInformation (GET)
ConfigurationItems/{parentId}/RelatedItems/entityInformation/fields (GET)

Conditions and requirements

General

  • To create or update children of this entity, your API User must have corresponding feature access and object permissions for the child entity you wish to manage.

  • The combination cannot already exist.

  • When creating a parent association, the API will exclude grandchildren.

  • When creating a child association, the API will exclude grandchildren.

Special field attributes

Field Conditions and Requirements
relatedConfigurationItemID must belong to an active account. must be active.
configurationItemID configurationItemID & RelatedConfigurationItemID cannot match
   

Field definitions

The following table describes the standard Autotask fields for this entity. Refer to the following articles for more information about working with these fields:

To learn how to query picklist endpoints, refer to Understanding picklists.

Notes

  • For string datatypes, the number in parentheses ( ) indicates the maximum number of characters allowed.
  • LT indicates Local Term.
  • If this entity has child collections, they will appear in a Child collection access URLs or an Entity URLs and relationships drop-down in the Entity details section of this article.
  • You can call the /query/count/ endpoint of a resource to determine how many records a collection holds.
Field Name Datatype Read-Only Is Required Reference Name Picklist
configurationItemID integer ConfigurationItems  
id long    
relatedConfigurationItemID integer ConfigurationItems  
relationship integer  

Additional resources