Get workflows

get

https://{host}/riskmodeler/v1/workflows

Query Params

ids

string

Comma-separated list of workflow IDs.

limit

int32

Number of records returned.

offset

int32

Number of records offset before the first record returned. By default, 0.

status

string

Status of the workflow, e.g. QUEUED,RUNNING, FINISHED, FAILED, CANCELLED, PENDING, CANCELLING, CANCEL_REQUESTED.

workflowtype

string

Type of the workflow, e.g. ANALYTICS_JOB.

from

string

Date of earliest submission.

string

Timestamp of latest submission date.

username

string

Name of principal that submitted the workflow.

workflowname

string

Name of workflow.

sortby

string

Attribute on which to sort returned records.

sortorder

string

Sort order (alphabetical or numerical) of returned records. One of ASC or DESC.

scheduled

string

entitlement

string

enum

Allowed:

includeArchivedJobs

boolean

Defaults to false

Include archived jobs in the response. Jobs are automatically archived after 30 days. If true and the archived data is not yet ready, returns 202 with an empty object. Retry the request to get the full response with 200.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200List of workflows retrieved.

202Accepted: Archived job data is not yet ready. Retry the request after a delay.

400Bad Request: Please check that you are provided all required values.

403Forbidden: Access to this resource has been denied.