Skip to content

Agent Routes

Agent routes are those used to create, retrieve, update, and delete Agent resources, as well as to retrieve resources they are related to.

Route Methods Description Additional GET features

/2022-10/agents

GET,
POST

Returns a collection of all Agent resources

Pagination^M^,
Sparse Fieldsets,
Inclusion,
Sorting,
Random Sorting,
Filtering,
Searching

/2022-10/agents/:id

GET,
PATCH,
DELETE

Returns the Agent resource identified by the :id parameter

Sparse Fieldsets,
Inclusion

/2022-10/agents/:id /categories

GET

Returns the collection of Category resources that classify the agent

Pagination,
Sparse Fieldsets,
Inclusion,
Sorting,
Random Sorting,
Filtering,
Searching

/2022-10/agents/:id /multimediaDescriptions

GET

Returns the collection of Media Object resources that are multimedia descriptions (e.g., images or videos) of the agent

Pagination,
Sparse Fieldsets,
Inclusion,
Sorting,
Random Sorting,
Filtering,
Searching