ComanagedAssociations
This entity describes the link between the accounts that are co-managed, and the resources with a co-managed security level who have access to them.
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: | ComanagedAssociations |
Entity Path: |
/atservicesrest/v1.0/ComanagedAssociations |
Can Create: | |
Can Update: | |
Can Query: | |
Can Delete: | |
Can Have UDFs: |
Conditions and requirements
Special field attributes
Field | Conditions and Requirements |
---|---|
companyID | Must match the account ID of an account that is enabled for Co-Management. |
isPrimaryCoManagedResource | The primary co-managed resource cannot refer to an inactive resource during create. During update, it cannot change to an inactive resource. If a resource is associated as the primary co-managed resource and then made inactive, the update will succeed if the primary co-managed resource has not changed. During update, only the isPrimaryComanagedResource field can be changed. |
resourceID | Must match the resource ID of a resource whose security level is of license type "Co-Managed Help Desk" |
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:
- The entityInformation REST API call
- Making basic query calls to the REST API
- Advanced query features of the REST API
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 |
---|---|---|---|---|---|
companyID | integer | Companies | |||
id | long | ||||
isPrimaryCoManagedResource |
boolean |
|
|
|
|
resourceID | integer | Resources |