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: string
Process Definition ID.
Query Parameters
-
expand(optional): string
Use the query parameter to expand the resources.
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ProcessDefinitionInterface
Type:
objectMatch All
Show Source
-
object
CommonModel
Discriminator:
links -
object
ProcessDefinitionInterface-allOf[1]
Nested Schema : ProcessDefinitionInterface-allOf[1]
Type:
Show Source
object-
inputs(optional):
array inputs
-
outputs(optional):
array outputs
-
processDefinitionId(optional):
string
Process definition ID
Nested Schema : inputs
Type:
Show Source
array-
Array of:
object ProcessIOParam
Process I/O param object
Nested Schema : outputs
Type:
Show Source
array-
Array of:
object ProcessIOParam
Process I/O param object
Nested Schema : ProcessIOParam
Type:
objectProcess I/O param object
Show Source
-
name(optional):
string
Display name of the param
-
type(optional):
string
Allowed Values:
[ "PRIMITIVE", "REFERENCE" ]Type of the param -
typeValue(optional):
object typeValue
Value of the type either url for reference or primitive type name
Nested Schema : typeValue
Type:
objectValue 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
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.comis 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": []
}