Skip to main content

View print jobs in paginated form.

POST 
/api/web/v1/prints/paginated

View print jobs in paginated form.

Request​

Body

required

    attributes string[]

    Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object.

    cursor string

    Identifies the page to return when paging over a result set--if present, search by / order by attributes are ignored.

    limit int32

    Possible values: >= 1 and <= 100

    Identifies the maximum number of items to include in a page (1-100).

    orderByAttribute

    object

    An attribute used to sort the result from a search.

    ascending booleanrequired

    Identifies whether to order results in ascending order.

    name stringrequired

    Identifies the attribute.

    searchByAttributes

    object[]

    Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute.

  • Array [

    • name stringrequired

    Identifies the attribute we are searching for.

    operator stringrequired

    Possible values: [EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, IN, EXISTS, NOT_EXISTS]

    Identifies the operator.

    value string

    Identifies the value of the attribute we are searching for.

  • ]

Responses​

OK

Schema

    paging

    object

    Contains navigation information.

    limit int32required

    Possible values: >= 1 and <= 100

    The page limit used (1-100)

    nextCursor string

    The cursor pointing to the next page.

    prevCursor string

    The cursor pointing to the previous page.

    printJobs

    object[]

  • Array [

    • bulkOperationName string

    Name of associated Bulk Print Operation

    createdOn date-time

    job creation time

    creatorId string

    The unique Id of the creator of this print job.

    creatorName string

    The name of the creator of this print job.

    creatorType string

    Possible values: [USER, API]

    The type of the creator of this print job.

    id int64

    job id

    identifierField string
    identifierValue string
    jobId string

    The unique id of this print job in print queue.

    name string

    job name

    printerId string

    The unique Id of the printer.

    printerName string

    printer name

    queueState string

    Possible values: [UNKNOWN, QUEUED, WAIT_FOR_PRINTER, STARTED, COMPLETED, CANCELLED, FAILED]

    queueStateDetails string

    Details about the queue state of this print job.

    status string

    Possible values: [QUEUED, WAITING_SMARTCARD, IN_PROGRESS, COMPLETED, FAILED, CANCELLED, UNKNOWN]

    statusDetails string

    job status

    updatedOn date-time

    The time this print job was last updated.

  • ]

Loading...