Skip to main content

List of Pending Certification Tasks

GET 

/certification-tasks

This API returns a list of pending (QUEUED or IN_PROGRESS) certification tasks. Any authenticated token can call this API, but only certification tasks you are authorized to review will be returned.

Request

Query Parameters

    reviewer-identity string

    The ID of reviewer identity. me indicates the current user.

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq, in

    targetId: eq, in

    type: eq, in

Responses

A list of pending certification tasks

Schema

  • Array [

  • id string

    The ID of the certification task.

    type string

    Possible values: [REASSIGN, ADMIN_REASSIGN, COMPLETE_CERTIFICATION, FINISH_CERTIFICATION, COMPLETE_CAMPAIGN, ACTIVATE_CAMPAIGN, CAMPAIGN_CREATE, CAMPAIGN_DELETE]

    The type of the certification task. More values may be added in the future.

    targetType string

    Possible values: [CERTIFICATION, CAMPAIGN]

    The type of item that is being operated on by this task whose ID is stored in the targetId field.

    targetId string

    The ID of the item being operated on by this task.

    status string

    Possible values: [QUEUED, IN_PROGRESS, SUCCESS, ERROR]

    The status of the task.

    errors

    object[]

    A list of errors that have been encountered by the task.

  • Array [

  • locale stringnullable

    The locale for the message text, a BCP 47 language tag.

    localeOrigin LocaleOrigin (string)nullable

    Possible values: [DEFAULT, REQUEST, null]

    An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

    text string

    Actual text of the error message in the indicated locale.

  • ]

  • reassignmentTrailDTOs

    object[]

    Reassignment trails that lead to self certification identity

  • Array [

  • previousOwner string

    The ID of previous owner identity.

    newOwner string

    The ID of new owner identity.

    reassignmentType string

    The type of reassignment.

  • ]

  • created date-time

    The date and time on which this task was created.

  • ]

Loading...