Retrieve a pending task list.

GET 
/task-status/pending-tasks

Retrieve a list of TaskStatus for pending tasks.

Request

Query Parameters

offset int32
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
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
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

Responses

200

Responds with a list of TaskStatus for pending tasks.

application/json

Schema

Schema

• Array [
id stringrequired

System-generated unique ID of the task this TaskStatus represents

type stringrequired

Possible values: [QUARTZ, QPOC, QUEUED_TASK]

Type of task this TaskStatus represents

uniqueName stringrequired

Name of the task this TaskStatus represents

description stringrequired

Description of the task this TaskStatus represents

parentName stringrequired

Name of the parent of the task this TaskStatus represents

launcher stringrequired

Service to execute the task this TaskStatus represents

created date-timerequired

Creation date of the task this TaskStatus represents

modified date-timerequired

Last modification date of the task this TaskStatus represents

launched date-timerequired

Launch date of the task this TaskStatus represents

completed date-timerequired

Completion date of the task this TaskStatus represents

completionStatus stringrequired

Possible values: [Success, Warning, Error, Terminated, TempError]

Completion status of the task this TaskStatus represents

messages object[]required
Messages associated with the task this TaskStatus represents
Array [
type stringrequired
Possible values: [INFO, WARN, ERROR]
Type of the message
localizedText objectrequired
Localized form of the message
locale stringrequired
Message locale
message stringrequired
Message text
key stringrequired
Key of the message
parameters object[]required
Message parameters for internationalization
]
returns object[]required
Return values from the task this TaskStatus represents
Array [
name stringrequired
Display name of the TaskReturnDetails
attributeName stringrequired
Attribute the TaskReturnDetails is for
]
attributes objectrequired

Attributes of the task this TaskStatus represents

property name* any

Attributes of the task this TaskStatus represents

progress stringrequired

Current progress of the task this TaskStatus represents

percentComplete integerrequired

Current percentage completion of the task this TaskStatus represents

• ]

Example (from schema)

[
  {
    "id": "id12345",
    "type": "QUARTZ",
    "uniqueName": "Big Task",
    "description": "A Really Big Task",
    "parentName": "Parent Task",
    "launcher": "sweep",
    "created": "2020-07-11T21:23:15.000Z",
    "modified": "2020-07-11T21:23:15.000Z",
    "launched": "2020-07-11T21:23:15.000Z",
    "completed": "2020-07-11T21:23:15.000Z",
    "completionStatus": "Success",
    "messages": [
      {
        "type": "INFO",
        "localizedText": {
          "locale": "An error has occurred!",
          "message": "Error has occurred!"
        },
        "key": "akey",
        "parameters": [
          {
            "name": "value"
          }
        ]
      }
    ],
    "returns": [
      {
        "name": "label",
        "attributeName": "identityCount"
      }
    ],
    "attributes": {
      "identityCount": 0
    },
    "progress": "Started",
    "percentComplete": 100
  }
]

204

No content - indicates the request was successful but there is no content to be returned in the response.

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
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.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
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.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages object[]
Generic localized reason for error
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
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.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
locale stringnullable
The locale for the message text, a BCP 47 language tag.
localeOrigin LocaleOriginnullable
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.
]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

Loading...