API Docs

__METHOD= GET . __PATH= /almaws/v1/conf/jobs/{job_id}/instances .

Retrieve Job Instances

This Web service returns all the job instances (runs) for a given job id.

Resource URL

GET /almaws/v1/conf/jobs/{job_id}/instances

API Description

URL Parameters

ParameterTypeDescription
job_idxs:stringUnique id of the job. Mandatory.

Querystring Parameters

ParameterTypeRequiredDescription
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
submit_date_fromxs:stringRequiredRetrieve instances from this Date (YYYY-MM-DD). Optional.
submit_date_toxs:stringRequiredRetrieve instances until this Date, included (YYYY-MM-DD). Optional.
statusxs:stringRequiredOnly instances with the specified status will be retrieved. Optional.

Body Parameters

None

Output

This method returns a Job Instances List object. See doc

Possible Error Codes

CodeMessage
402215Invalid job id format.
402216Invalid job id.
402217Invalid date format.
40166410Invalid status.