Update the Task Payload
post
/ic/api/process/v1/tasks/{id}/payload
Updates the payload of a task. For External UI task payload, we support updating business payload and not URL element of payload.
Request
Supported Media Types
- application/json
Path Parameters
-
id(required): string
Task Number
Updated Task Payload in JSON
Root Schema : schema
Type:
string
Response
Supported Media Types
- text/plain
- application/json
200 Response
Task payload successfully updated.
Root Schema : schema
Type:
string
400 Response
Bad request
401 Response
Unauthorized
409 Response
Conflict
500 Response
Internal Server Error
Examples
The following example shows how to update task payload using a POST request on the REST resource.
Send Request
https://example.com/ic/api/process/v1/tasks/<taskId>/payload
Where,
-
example.com
is the host where Oracle Integration is running. - <taskId
> is the task ID that you get using Retrieve a Task List.
Example of Response Header
Authentification header: username:password or Basic encoded64 format. Content-Type: application/json Cache-Control: no-cache
Example of Request Body
Request body of a web form in the JSON format:
{ "fullName": "James Allen Stein", "startDate": "2016-08-08" }
Note:
Ensure the following for a web form:
-
Payload for a web form is in JSON format and the JSON content should be a complete task-payload as returned by:
GET /ic/api/process/v1/tasks/<taskId>/payload
request.
Example of Response Body
Task payload successfully updated