Jump to

• Request
• Response
• Examples

Get a Dynamic Process Definition by ID

get

/ic/api/process/v1/dp-definitions/{id}

Get the dynamic process definition with the specified dynamic process definition ID.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Process Definition ID.

Query Parameters

• idType: string
  Type of ID. Use process definition id or process definition key.

  Default Value: id

  Allowed Values: [ "id", "key" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ProcessDefinition

Type: object

Match All

Show Source

• object CommonModel
  Discriminator: links
• object ProcessDefinition-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Process definition ID"
                },
                "key":{
                    "type":"string",
                    "description":"Process definition key"
                },
                "category":{
                    "type":"string",
                    "description":"Process definition category"
                },
                "name":{
                    "type":"string",
                    "description":"Process definition title"
                },
                "version":{
                    "type":"integer",
                    "description":"Process definition deployment version"
                },
                "revision":{
                    "type":"string",
                    "description":"Process definition deployment revision"
                },
                "resource":{
                    "type":"string",
                    "description":"Process definition resource file"
                },
                "deploymentId":{
                    "type":"string",
                    "description":"Process definition deployment Id"
                },
                "description":{
                    "type":"string",
                    "description":"Process definition summary"
                },
                "formMetadataURL":{
                    "type":"string",
                    "description":"Form URL associated with the process"
                },
                "formInputParam":{
                    "type":"string",
                    "description":"Input Parameter name required to start the case with a form"
                }
            },
            "required":[
                "id"
            ]
        }
    ]
}

Nested Schema : CommonModel

Type: object

Discriminator: links

Show Source

• links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ProcessDefinition-allOf[1]

Type: object

Show Source

• category: string
  Process definition category
• deploymentId: string
  Process definition deployment Id
• description: string
  Process definition summary
• formInputParam: string
  Input Parameter name required to start the case with a form
• formMetadataURL: string
  Form URL associated with the process
• id(required): string
  Process definition ID
• key: string
  Process definition key
• name: string
  Process definition title
• resource: string
  Process definition resource file
• revision: string
  Process definition deployment revision
• version: integer
  Process definition deployment version

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Process definition ID"
        },
        "key":{
            "type":"string",
            "description":"Process definition key"
        },
        "category":{
            "type":"string",
            "description":"Process definition category"
        },
        "name":{
            "type":"string",
            "description":"Process definition title"
        },
        "version":{
            "type":"integer",
            "description":"Process definition deployment version"
        },
        "revision":{
            "type":"string",
            "description":"Process definition deployment revision"
        },
        "resource":{
            "type":"string",
            "description":"Process definition resource file"
        },
        "deploymentId":{
            "type":"string",
            "description":"Process definition deployment Id"
        },
        "description":{
            "type":"string",
            "description":"Process definition summary"
        },
        "formMetadataURL":{
            "type":"string",
            "description":"Form URL associated with the process"
        },
        "formInputParam":{
            "type":"string",
            "description":"Input Parameter name required to start the case with a form"
        }
    },
    "required":[
        "id"
    ]
}

401 Response

Unauthorized

404 Response

A dynamic process definition with the specified ID or key does not exist.

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