POST /links/{linkId}/requests
Submit an ODAG request.
This method submits a new app generation request to the ODAG service. This method attempts to validate the user's current selection app session state by applying the LinkPropSetting rules applicable to the user. If the validation succeeds, the request to create the application is queued and the method returns successfully with a summary of the created request (note that it is the caller's responsibility to monitor the status of the ODAG request using subsequent GET calls to the created request). If the validation fails, the method returns the 400 error code along with a relevant error object. If no 'engineGroup' property applies to this link and user combination, the data load phase of this request will be queued on the single engine queue for the same engine serving the selection app. If an engineGroup property does apply to the submitting user but the engine group does not exist or has been paused, the request validation will fail with an error.
Path parameters
| Name | Description | Type |
|---|---|---|
| linkId | The ID of a link to match objects to be returned. |
String |
Request Body
JSON payload to send to RequestCreate
| Name | Type | Required |
|---|---|---|
| selectionApp | RequestCreatePayload | Yes |
| sheetname | RequestCreatePayload | |
| clientContextHandle | RequestCreatePayload | |
| actualRowEst | RequestCreatePayload | Yes |
| bindSelectionState | RequestCreatePayload | Yes |
| selectionState | RequestCreatePayload |
Responses
| Name | Description | Type |
|---|---|---|
| 201 | Successful response - the request has been queued. |
RequestStateFull |
| 400 | The selection app was in an invalid state to proceeed with this app generation (see error object for details). |
Error |
| 404 | Invalid link ID. |
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!