1. REST API for Oracle Integration
  2. Tasks
  3. Process
  4. Dynamic Process Definitions

Get a List of Dynamic Process Definitions

get

/ic/api/process/v1/dp-definitions

Get a list of dynamic process definitions that the user can access.

Request

Supported Media Types
Query Parameters
  • Dynamic process definition on which this action can be performed.
    Allowed Values: [ "read", "update", "create" ]
  • Filter by dynamic process definition category. Exact match.
  • Filter by dynamic process definition categories that the parameter is a substring of. The string can include the wildcard character '%' to express like-strategy. For example, starts with (string%), ends with (%string) or contains (%string%).
  • Filter by the deployment the ID belongs to.
  • Pagination of results. Specifies the index of the first result to return.
  • Filter by dynamic process definition key. For example, the ID in the CMMN file. Exact match.
  • Filter by dynamic process definition keys that the parameter is a substring of. The string can include the wildcard character '%' to express like-strategy. For example, starts with (string%), ends with (%string) or contains (%string%).
  • Only include the latest version of dynamic process definitions. Value may only be true, as false is the default behavior.
  • Pagination of results. Specifies the maximum number of results to return. Will return fewer results if there are no more results left.
  • Filter by dynamic process name. Exact match.
  • Filter by dynamic process definition names that the parameter is a substring of. The string can include the wildcard character '%' to express like-strategy. For example, starts with (string%), ends with (%string) or contains (%string%).
  • Filter by dynamic process definition ID.
  • Collection Format: multi
    Filter by dynamic process definition IDs in the array.
  • Sort the results lexicographically by a given criterion. Valid values are category, key, id, name, version and deploymentId. Must be used in conjunction with the sortOrder parameter.
  • Sort the results in a given order. Values may be asc for ascending order, or desc for descending order. Must be used in conjunction with the sortBy parameter.
  • Filter by dynamic process definition version.
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : ProcessDefinitions
Type: object
Match All
Show Source
Nested Schema : CommonModel
Type: object
Discriminator: links
Show Source
Nested Schema : ProcessDefinitions-allOf[1]
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : ProcessDefinition
Type: object
Match All
Show Source
Nested Schema : ProcessDefinition-allOf[1]
Type: object
Show Source

400 Response

Returned if some of the query parameters are not valid. For example, if a sortOrder parameter is supplied, but no sortBy.

401 Response

Unauthorized

500 Response

Internal Server Error
Back to Top

Examples

These examples show how to get a dynamic process definition by ID or key.

Use the API /ic/api/process/v1/dp-definitions with a GET to retrieve a list of deployed dynamic process definitions with the associated IDs and keys. Then, use the dynamic process definition ID or key to retrieve more information about a specific dynamic process definition.

Send Request: Get a Deployed Dynamic Process Definition by ID 

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept: application/json" https://example.com/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi:2:2534

Where,

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

Send Request: Get a Deployed Dynamic Process Definition by key

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept: application/json" https://example.com/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi?idType=key

Where,

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

Response: 

{
  "links": [
    {
      "href": "https://localhost:443/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi",
      "rel": "self"
    },
    {
      "href": "https//:localhost:443/ic/api/process/v1/dp-definitions",
      "rel": "parent"
    },
    {
      "href": "https//:localhost:443/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi/metadata",
      "rel": "rel"
    },
    {
      "href": "https//:localhost:443/ic/api/process/v1/dp-definitions/cm_DPikkv9ujdfi/interface",
      "rel": "rel"
    }
  ],
  "id": "cm_DPikkv9ujdfi:2:2534",
  "key": "cm_DPikkv9ujdfi",
  "category": "pcs/isDP3!3.0*soa_29901635-ad30-4003-9c50-29d193d971bd",
  "name": "isDP3",
  "version": 2,
  "resource": "DPikkv9ujdfi.cmmn",
  "deploymentId": "2529",
  "description": "isDP3",
  "formMetadataURL": "webforms/pcs~isDP3!3.0*soa_29901635-ad30-4003-9c50-29d193d971bd~6284aad4-9bfe-4505-b66c-3ed9a49c794a~43fa020e-96e3-42b1-a420-f9dfc67c4c4e",
  "formInputParam": "formArg"
}
Back to Top