GET /requests
Get a list of ODAG requests.
Returns a list of ODAG request objects matching the combination of search criteria provided. Only a single ID parameter may be supplied in a single request but any combination of the other parameters may be included. The OptEngineGroupNamePattern and OptEngineGroupId further restricts the set of returned requests to those that are (or were) assigned to specific engine groups. These two engine group parameters are only supported in the premium version of the ODAG service and an error will be returned on any attempt to supply values for both parameters in the same method call.
Query parameters
| Name | Description | Type |
|---|---|---|
| optLinkId | The ID of a link to match objects to be returned. |
String |
| optSelectAppId | An optional parameter for specifying the ID of a selection app. |
String |
| createdOnOrAfter | A time range in which an object was created on or after the specified timestamp. |
Date |
| createdBefore | A time range in which an object was created prior to the specified timestamp. |
Date |
| user | The name of the user who submitted the request. |
String |
| state | Any combination of the following request state flags: q = queued, v = validating, i = invalid,c = canceled, h = hold/pending, l = loading, f = done but failed, s = done successfully, d = done (success or failed) |
String |
Responses
| Name | Description | Type |
|---|---|---|
| 200 | Successful response - see array of requests in response. |
RequestArray |
| 400 | An invalid combination of parameters was supplied (see detailed error). |
Error |
Did this page help you?
If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!