Get entity details of a job

get

{protocol}://{server}{basePath}/accounts/{accountId}/communication-managers/{communicationManagerId}/jobs/{jobId}:entity-details

This API requires the Account Administrator role.

Gets details of a sync entity by its job id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

The unique 6 character internal id that represents the customer account.

communicationManagerId

uuid

required

The unique id of the Communication Manager

jobId

uuid

required

The unique 36 character internal id of the Job

Query Params

entityType

string

enum

required

The optional entity type to query

Allowed:

statusCode

string

enum

The optional job status code to query

filter

string

length ≤ 255

Specifies details of a row filter.
The possible fields that can be filtered on are:

Name
Number
StatusCode
Field Names are case-senstive (should be written as it is in description).
The allowed format:

Begins with the column name to be filtered, followed by a colon will be used to find out word that contains given value.

pageNumber

int32

≥ 1

Defaults to 1

The page number of the records to retrieve. Default value is 1.

pageSize

int32

1 to 100

Defaults to 10

The maximum number of results per page. Default value is 10, max value is 100.

orderBy

string

length ≤ 255

Defaults to createdAt desc

Specifies how response data should be sorted. createdAt and updatedAt are valid options.
Field Names are case-senstive (should be written as it is in description).
To specify descending order, a suffix " desc" should be added. For example, "createdAt" for ascending or "createdAt desc" for descending".
The default sorting order is createdAt ascending.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

401Unauthorized

403Forbidden

404Not Found

500All other application errors