Skip to content

Get all resource category assignments

POST
/api/connector/v1/resourceCategoryAssignments/getAll

Returns all resource category assignments. This operation uses Pagination.

ResourceCategoryAssignmentFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

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

Array<string>
nullable >= 1 items <= 1000 items
ResourceCategoryAssignmentIds

Unique identifiers of Resource category assignment.

Array<string>
nullable <= 1000 items
ResourceCategoryIds
required

Unique identifiers of Resource categories to which the resource category assignment belong.

Array<string>
<= 1000 items
UpdatedUtc
TimeFilterInterval

Interval in which the resource category assignments were updated.

object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
ActivityStates

Whether to return only active, only deleted or both records.

Array<string>
nullable
Allowed values: Deleted Active
ResourceIds

Unique identifiers of resources to which the resource category assignments belong.

Array<string>
nullable >= 1 items <= 1000 items
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ResourceCategoryAssignmentIds": [
"fb69fc51-c4e9-4ef6-874a-24bcfe74a894",
"28704948-77df-4bb4-8f39-f8380dc8a914"
],
"ResourceCategoryIds": [
"5c0804f9-d03a-4b13-a57d-b00300781a41",
"47d6b462-35ec-467e-a565-b00300781a41"
],
"UpdatedUtc": {
"StartUtc": "2023-11-01T00:00:00Z",
"EndUtc": "2023-11-30T00:00:00Z"
},
"ActivityStates": [
"Active"
],
"ResourceIds": [
"5ee074b1-6c86-48e8-915f-c7aa4702086f",
"c32386aa-1cd2-414a-a823-489325842fbe"
],
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
],
"Limitation": {
"Count": 10,
"Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7"
}
}

OK

ResourceCategoryAssignmentResult
object
ResourceCategoryAssignments
required

Resource category assignments.

Array<object>
<= 1000 items
Resource category assignment
object
Id
required

Unique identifier of the assignment.

string format: uuid
IsActive
required

Whether the assignment is still active.

boolean
ResourceId
required

Unique identifier of the Resource assigned to the Resource category.

string format: uuid
CategoryId
required

Unique identifier of the Resource category.

string format: uuid
CreatedUtc
required

Creation date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Cursor

Unique identifier of the last and hence oldest resource category assignment returned. This can be used in Limitation in a subsequent request to fetch the next batch of older resource category assignments.

string format: uuid
nullable
Example
{
"ResourceCategoryAssignments": [
{
"Id": "fb69fc51-c4e9-4ef6-874a-24bcfe74a894",
"ResourceId": "e5a34a69-d35e-4e85-a645-a9bc4ee3a80f",
"CategoryId": "5c0804f9-d03a-4b13-a57d-b00300781a41",
"IsActive": true,
"CreatedUtc": "2023-10-01T11:48:57Z",
"UpdatedUtc": "2023-10-28T11:48:57Z"
},
{
"Id": "28704948-77df-4bb4-8f39-f8380dc8a914",
"ResourceId": "90908a65-35fc-4856-b659-106f60b591e5",
"CategoryId": "47d6b462-35ec-467e-a565-b00300781a41",
"IsActive": true,
"CreatedUtc": "2023-10-01T11:48:57Z",
"UpdatedUtc": "2023-10-28T11:48:57Z"
}
],
"Cursor": "28704948-77df-4bb4-8f39-f8380dc8a914"
}

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable