Jump to

• Request
• Response
• Examples

Retrieve the Task Payload

get

/ic/api/process/v1/tasks/{id}/payload

Retrieves the payload of a task. For external UI task payload, you can retrieve full payload by default or retrieve only business payload by passing type = BO

Request

Path Parameters

• id: string
  Task Number

Query Parameters

• type(optional): string
  ExternalUI Payload type to fetch. Possible values are BO - Fetches only business Payload, Full - fetches payload with task url.

  Default Value: FULL

  Allowed Values: [ "BO", "FULL" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : payload

Type: object

Show Source

• comment(optional): string
• levels(optional): integer(int32)
• links(optional): array links
• priority(optional): integer(int32)
• summaryFields(optional): array summaryFields
• title(optional): string
• xmlPayload(optional): string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "summaryFields":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GenericMap"
            }
        },
        "comment":{
            "type":"string"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "xmlPayload":{
            "type":"string"
        }
    },
    "xml":{
        "name":"payload",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : summaryFields

Type: array

Show Source

• Array of: object genericMap

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GenericMap"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• mediaType(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : genericMap

Type: object

Show Source

• category(optional): string
• dataType(optional): string
• displayName(optional): string
• name(optional): string
• readOnly(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "readOnly":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "category":{
            "type":"string"
        }
    },
    "xml":{
        "name":"genericMap",
        "namespace":"http://xmlns.oracle.com/bpm/rest/tasks"
    }
}

400 Response

Bad request

401 Response

Unauthorized

404 Response

Task Payload not found

409 Response

Conflict

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to retrieve task payload using a GET 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

Status Code: 200 OK
Date: Wed, 27 Apr 2016 00:53:16 GMT
Content-Type: application/json

Example of Response Body

The following example shows the response body for a web form:

<payload xmlns="http://xmlns.oracle.com/bpel/workflow/task">
<TravelRequestForm xmlns:def="http://xmlns.oracle.com/bpm/webform/formsData/travelRequestForm"
xsi:type="def:TravelRequestFormBOType"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://xmlns.oracle.com/bpel/workflow/task">
<p0:TravelRequestForm xmlns:p0="http://www.frevvo.com/schemas/_xndRMEEiEeWNS89tuvw3FQ">
<FirstName xmlns="">test</FirstName>
<LastName xmlns="">j</LastName>
<Email xmlns="">[e-mail]</Email>
<StartDateOfTravel xmlns="">2016-08-03</StartDateOfTravel>
<EndDateOfTravel xmlns="">2016-08-03</EndDateOfTravel>
<dateValidationError xmlns="">End date of travel cannot be earlier than start date of travel</dateValidationError>
<EstimatedCostOfTravel xmlns="">22</EstimatedCostOfTravel>
<Justification xmlns="">22</Justification>
</p0:TravelRequestForm>
</TravelRequestForm>
</payload>

Note:

• Web forms return payload response in XML format

• If Accept header with value application/json is passed in Request header, the web form returns payload response in JSON format.

Back to Top