Jump to

• Request
• Response
• Examples

Get Dynamic Process Definition Interface

get

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

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

Request

Supported Media Types

• application/json

Path Parameters

• id(required): string
  Process Definition ID.

Query Parameters

• expand: string
  Use the query parameter to expand the resources.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ProcessDefinitionInterface

Type: object

Match All

Show Source

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "processDefinitionId":{
                    "type":"string",
                    "description":"Process definition ID"
                },
                "inputs":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessIOParam"
                    }
                },
                "outputs":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessIOParam"
                    }
                }
            }
        }
    ]
}

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 : ProcessDefinitionInterface-allOf[1]

Type: object

Show Source

• inputs: array inputs
• outputs: array outputs
• processDefinitionId: string
  Process definition ID

{
    "properties":{
        "processDefinitionId":{
            "type":"string",
            "description":"Process definition ID"
        },
        "inputs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessIOParam"
            }
        },
        "outputs":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ProcessIOParam"
            }
        }
    }
}

Nested Schema : inputs

Type: array

Show Source

• Array of: object ProcessIOParam
  Process I/O param object

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

Nested Schema : outputs

Type: array

Show Source

• Array of: object ProcessIOParam
  Process I/O param object

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

Nested Schema : ProcessIOParam

Type: object

Process I/O param object

Show Source

• name: string
  Display name of the param
• type: string
  Allowed Values: [ "PRIMITIVE", "REFERENCE" ]

  Type of the param
• typeValue: object typeValue
  Value of the type either url for reference or primitive type name

{
    "description":"Process I/O param object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Display name of the param"
        },
        "type":{
            "type":"string",
            "description":"Type of the param",
            "x-nullable":"boolean",
            "enum":[
                "PRIMITIVE",
                "REFERENCE"
            ]
        },
        "typeValue":{
            "type":"object",
            "description":"Value of the type either url for reference or primitive type name"
        }
    }
}

Nested Schema : typeValue

Type: object

Value of the type either url for reference or primitive type name

401 Response

Unauthorized

404 Response

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

405 Response

Forbidden

500 Response

Internal Server Error

Back to Top

Examples

The following example shows how to retrieve the interface of the dynamic process definition with the specified process definition 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/v1/dp-definitions/{Id}/interface

You can use the query parameter expand to retrieve all the type value of the resource.

https://example.com/ic/api/process/v1/dp-definitions/{id}/interface?expand=type

Where,

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

• <id> is the unique ID for a dynamic process definition. To retrieve the ID of the dynamic process definition, see Get a List of Dynamic Process Definitions..

Example of Response Header

Status Code: 200 OK
Date:  Thu, 15 Nov 2018 08:26:57 GMT
Content-Type: application/json

Example of Response Body

The following example shows the response body without the query parameter, expand:

{
    "links": [
        {
            "href": "http://example.com/7001/ic/api/process/v1/dp-definitions/cm_DP7ajglr6ad8:1:385/interface",
            "rel": "self"
        },
        {
            "href": "http://example.com/7001/ic/api/process/v1/dp-definitions/cm_DP7ajglr6ad8:1:385",
            "rel": "parent"
        }
    ],
    "processDefinitionId": "cm_DP7ajglr6ad8:1:385",
    "inputs": [
        {
            "name": "input",
            "type": "PRIMITIVE",
            "typeValue": "string"
        },
        {
            "name": "input1",
            "type": "REFERENCE",
            "typeValue": "http://example.com/7001/ic/api/process/v1/dp-resources/generated/json-schemas/WebForm.schema.json?deploymentId=380"
        },
        {
            "name": "input2",
            "type": "REFERENCE",
            "typeValue": "http://example.com/7001/ic/api/process/v1/dp-resources/generated/json-schemas/Person.schema.json?deploymentId=380"
        }
    ],
    "outputs": []
}

The following example shows the response body with the query parameter, expand:

{
    "links": [
        {
            "href": "http://example.com/7001/ic/api/process/v1/dp-definitions/cm_DP7ajglr6ad8:1:385/interface",
            "rel": "self"
        },
        {
            "href": "http://example.com/7001/ic/api/process/v1/dp-definitions/cm_DP7ajglr6ad8:1:385",
            "rel": "parent"
        }
    ],
    "processDefinitionId": "cm_DP7ajglr6ad8:1:385",
    "inputs": [
        {
            "name": "input",
            "type": null,
            "typeValue": "string"
        },
        {
            "name": "input1",
            "type": null,
            "typeValue": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "$id": "WebForm",
                "$name": "WebForm",
                "$namespace": "http://xmlns.oracle.com/bpm/forms/schemas/WebForm",
                "type": "object",
                "properties": {
                    "person": {
                        "$ref": "#/definitions/Person"
                    },
                    "dept": {
                        "$ref": "#/definitions/Dept"
                    }
                },
                "definitions": {
                    "Person": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "$id": "#/definitions/Person",
                        "$name": "Person",
                        "$namespace": "http://xmlns.oracle.com/bpm/bpmobject/BusinessData/Person",
                        "type": "object",
                        "properties": {
                            "name": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            },
                            "dept": {
                                "$ref": "#/definitions/Dept"
                            },
                            "age": {
                                "type": [
                                    "number",
                                    "null"
                                ],
                                "format": "int"
                            }
                        },
                        "$nullable": [
                            "name",
                            "dept",
                            "age"
                        ],
                        "required": [
                            "name",
                            "dept",
                            "age"
                        ]
                    },
                    "Dept": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "$id": "#/definitions/Dept",
                        "$name": "Dept",
                        "$namespace": "http://xmlns.oracle.com/bpm/bpmobject/BusinessData/Dept",
                        "type": "object",
                        "properties": {
                            "number": {
                                "type": [
                                    "number",
                                    "null"
                                ],
                                "format": "int"
                            },
                            "name": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            }
                        },
                        "$nullable": [
                            "number",
                            "name"
                        ],
                        "required": [
                            "number",
                            "name"
                        ]
                    }
                }
            }
        },
        {
            "name": "input2",
            "type": null,
            "typeValue": {
                "$schema": "http://json-schema.org/draft-04/schema#",
                "$id": "Person",
                "$name": "Person",
                "$namespace": "http://xmlns.oracle.com/bpm/bpmobject/BusinessData/Person",
                "type": "object",
                "properties": {
                    "name": {
                        "type": [
                            "string",
                            "null"
                        ]
                    },
                    "dept": {
                        "$ref": "#/definitions/Dept"
                    },
                    "age": {
                        "type": [
                            "number",
                            "null"
                        ],
                        "format": "int"
                    }
                },
                "$nullable": [
                    "name",
                    "dept",
                    "age"
                ],
                "required": [
                    "name",
                    "dept",
                    "age"
                ],
                "definitions": {
                    "Dept": {
                        "$schema": "http://json-schema.org/draft-04/schema#",
                        "$id": "#/definitions/Dept",
                        "$name": "Dept",
                        "$namespace": "http://xmlns.oracle.com/bpm/bpmobject/BusinessData/Dept",
                        "type": "object",
                        "properties": {
                            "number": {
                                "type": [
                                    "number",
                                    "null"
                                ],
                                "format": "int"
                            },
                            "name": {
                                "type": [
                                    "string",
                                    "null"
                                ]
                            }
                        },
                        "$nullable": [
                            "number",
                            "name"
                        ],
                        "required": [
                            "number",
                            "name"
                        ]
                    }
                }
            }
        }
    ],
    "outputs": []
}

Back to Top