Get Characters

Description

This endpoint provides a list of characters on a job at the level of a specific order.

Endpoint

/v1/jobs/{entityId}/orders/{orderId}/characters

Request parameters

Responses

{
  "data": [
    {
      "characterId": "752af4e0-5edd-4ea0-a53d-637b2b3a7123",
      "characterName": "Mickey Mouse",
      "sourceSystem": "manual"
    },
    {
      "characterName": "Angela Montenegro",
      "sourceSystem": "ctam"
    }
  ],
  "meta": {
    "query": "jobId=d2545f30-50d0-48fd-8e73-aa689999061f&orderId=7ed1a0e6-6f9d-43b6-9d1a-df0ba7c2c5bc",
    "pageNumber": 1,
    "totalElements": 2,
    "limit": 0,
    "offset": 0
  }
}

Examples

Description	Example Request
Search	`/v1/jobs/{entityId}/orders/{orderId}/characters`
Search by Container IDs	`/v1/jobs/{entityId}/orders/{orderId}/characters?containerIds={containerId},{containerId}`

Create Character: Add a manual character to a job.
Delete Character: Remove a manual character from a job.
API Reference: See all available endpoints and details.

Description

Endpoint

Request parameters

Responses

Examples

Related Documentation