Returns a list of workflow jobs submitted to the workflow engine that match the specified query parameters.
The operation enables you to filter the workflow jobs returned. Workflow jobs may be identified by job id (ids
) name (workflowname
), type (workflowtype
), job submitter (username
), and submission date using the from
and to
parameters.
A successful response returns the Workflow object, which provides detailed information about this workflow job including the submitTime
, startTime
, type
, job details, and its status:
Status | Description |
---|---|
QUEUED | Indicates that the workflow engine has created the job and added it to the queue for processing. |
PENDING | Indicates that the workflow engine is about to be processed. |
RUNNING | Indicates that the workflow engine is processing the job. |
FINISHED | Indicates that the workflow engine has finished processing the job. |
FAILED | Indicates that the job has failed. |
CANCEL_REQUESTED | Indicates that the client has requested that the workflow engine cancel job using the Cancel Job resource. |
CANCELLING | Indicates that the workflow engine is cancelling the job. |
CANCELLED | Indicates that the job has been cancelled. |
Once the job is complete (FINISHED
), the response may display a URL that enables the client to download the product of the job. The following job types produce database artifacts and export those artifacts to a storage bucket on Amazon S3:DOWNLOAD_EDM
, DOWNLOAD_RDM
, DOWNLOAD_LOCATION_RESULTS
, DOWNLOAD_RESULTS
, and EDM2EDM
jobs.
Download Link Security
Download Link Security is an optional feature that restricts access to the download links returned by this resource.
If enabled, the response will only display download links if the principal requesting information about a job is the principal that originally submitted the job itself.
To enable, contact your Customer Success Manager and request that Moody's RMS implement Download Link Security for your Risk Modeler tenant.