Jump to

• Request
• Response
• Examples

Retrieve a Form Instance for a Webform

get

/ic/api/process/v1/process-definitions/{processDefId}/{serviceName}/webform

Retrieves the form instance and optional payoad for the process definitions with the given ID. The payload attribute and its value in JSON format will be set only when the form payload is saved during process initiation using the Save action.

Request

Path Parameters

• processDefId: string
  Value of process definition ID.
• serviceName: string
  Value of service name of the process.

Query Parameters

• includeAttachments(optional): boolean
  If true (default), returns any saved attachments as body parts along with the form URL

  Default Value: true
• operation: string
  Specifies the operation performed. Use the Retrieve Process Definitions endpoint to list process definition data, including operations.

Back to Top

Response

Supported Media Types

• multipart/mixed

200 Response

Success. Returns a multipart response. The first body part is a JSON containing the form instance URL and optional payload if saved earlier. The remaining body parts will be attachments if the process contains any saved attachments.

401 Response

Unauthorized

404 Response

Form not found.

500 Response

Error in retrieving the form Instance URL

Back to Top

Examples

The following example shows how to retrieve a form instance for a web form on the REST resource:

Send Request

https://example.com/ic/api/process/v1/process-definitions/{processDefId}/{serviceName}/webform?operation=<operation>

Where,

• example.com is the host where Oracle Integration is running.

• <version> is the REST API version.

• <processDefId> is the process definition ID obtained from the /process-definitions endpoint. For more information see, Retrieve Process Definitions.

• <serviceName> is the service name of the process definition obtained from the  /process-definitions endpoint. For more information, see Retrieve Process Definitions.

• <operation> is the operation of the process definition obtained from the /process-definitions endpoint; for example,  start. For more information, see Retrieve Process Definitions.

Example of Response Body

The API returns a multipart response. The following example shows the first part, which contains the form URL and optional payload.

Example 1:

--Boundary_5_532764984_1485338960344
Content-Type: text/plain
{"form": http://example.com/ic/api/process/<version>/process-definitions/{processDefId}/{serviceName}/webforms/default~NewFormsRestApp!1.0~NewPCSForms~d5fb3e55-682b-4dd7-8836-3f670d1c9b3a~c162fd27-99d7-4f81-944d-33ae26c0f089"}
--Boundary_5_532764984_1485338960344--

The payload attribute and its value in JSON format will be set only when the form payload is saved during process initiation using the Save action.

Example 2:

The following example contains optional payload:

--Boundary_6_543235965_1488307245682
Content-Type: text/plain
{"form":
"http://example.com/ic/api/process/<version>/process-definitions/{processDefId}/{serviceName}/webforms/default~SequentialApplication!1.0~SeqProcess~033924ee-94fe-407c-8441-8e0bad75c553~e7b6b5ea-3f3b-4901-9532-9a65e032c9b3", "payload":
{"travelPurpose":"purpose","travelJustification":"justification","travelCost":


"111","approvers.assignees":["jstein","achrist","cdoyle"]}}
--Boundary_6_543235965_1488307245682--

Back to Top