Resources

Get all resources

Returns all resources of an enterprise associated with the connector integration. Note that when any of the extents is set to true, the response contains the entities that are associated to a resource. If the extent is not associated to a resource (e.g. resource category not assigned to any resource), this information is not returned. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/resources/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

ResourceIdsstring[] nullable

Unique identifiers of the requested resources.

Namesstring[] nullable

Names of the requested resources.

Response

OK

Cursorstring uuid nullable

Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.

Changes

Changed in 2 of the 10 revisions of this API.31

    • added the optional property Resources/items/DeletedUtc to the response with the 200 status

      response-optional-property-added

    • added the new Cabin enum value to the ResourceCategories/items/Type response property for the response status 200

      response-property-enum-value-added

    • added the new Pod enum value to the ResourceCategories/items/Type response property for the response status 200

      response-property-enum-value-added

    • added the new SunBed enum value to the ResourceCategories/items/Type response property for the response status 200

      response-property-enum-value-added