REST API for Oracle Integration

Retrieve a DesignTime Process by ID

get

/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}

Retrieves the details of a designtime process based on the specified Id.

Request

Path Parameters

processId(required): string

The process ID
projectId(required): string

The project ID
spaceId(required): string

The space ID

Response

Supported Media Types

application/json
application/xml;qs=0.9

200 Response

Success. Retrieve Process.

Root Schema : process

Type: object

process data

401 Response

Unauthorized

500 Response

Error in retrieving process

Examples

The following example shows how to retrieve a process based on the ID by submitting a GET request on the REST resource.

Send Request

The following example shows the contents of the send request:

https://example.com/ic/api/process/<version>/spaces/<spaceId>/projects/<projectId>/processes/<processId>

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
<projectId> is the unique ID for a project. To retrieve available projects, see Retrieve projects.
<processId> is the unique ID for a process. To retrieve available processes, see Retrieve all processes.

Example of Response Header

Status Code: 200 OK
Date:   Mon, 03 Apr 2017 09:39:39 GMT 
Content-Type:  application/json

Example of Response Body

{
  "id": "MyProcess",
  "name": "MyProcess",
  "description": "My process description",
  "author": "jsmith",
  "entryPoints": [
    {
      "id": "EVT18969244474387",
      "bpmnType": "START_EVENT",
      "interfaceElements": {}
    }
  ],
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/old%20project/processes/MyProcess",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/old%20project/processes/MyProcess",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/old%20project",
      "rel": "parent"
    }
  ]
}