/{version}/queues/{protocolStepId}
The following operations are supported on this resource:
Obtains the XML representation of a queue, which consists of a list of all the artifacts ready to be run through
its underlying protocol step.
Parameters
name |
description |
type |
default |
protocolStepId |
The identifier for the queue. This is the same as the underlying protocol step.
|
path |
|
workflowname |
Displays only queued artifacts with workflow names that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
workflowid |
Displays only queued artifacts with workflow IDs that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
projectname |
Displays only queued artifacts with project names that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
projectlimsid |
Displays only queued artifacts with project LIMS IDs that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
containername |
Displays only queued artifacts with container names that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
containerlimsid |
Displays only queued artifacts with container LIMS IDs that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
previousstepid |
Displays only queued artifacts with previous step IDs that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
submittedsamplelimsid |
Displays only queued artifacts with submitted sample LIMS IDs that match the specified value. When filtering results, you can repeat this parameter.
|
query |
|
Output Payload
element |
produceable content type(s) |
queue (XML)
|
|
description |
The complete response from the call to the endpoint |