Get a List of Dynamic Process Resources
/ic/api/process/v1/dp-resources
You must use the deploymentId
query parameter to retrieve the dynamic process resources.
Request
- application/json
-
deploymentId: string
The deployment ID of the resource. While retrieving the dynamic process resource, you must use this query paramenter. If not, you will encounter an internal server error.
Response
- application/json
200 Response
object
-
object
CommonModel
Discriminator:
links
-
object
ProcessResources-allOf[1]
object
-
object
CommonModel
Discriminator:
links
-
object
ProcessResource-allOf[1]
object
-
deploymentId(optional):
string
The deployment ID
-
id(optional):
string
The id of the deployment resource.
-
name(optional):
string
The name of the deployment resource.
-
schema(optional):
object schema
The schema of the resource.
object
401 Response
404 Response
500 Response
Examples
The following example shows how to retrieve a list of dynamic process resources for the specified deployment 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/ic/api/process/v1/dp-resources?deploymentId=<deploymentId>
Where,
-
example.com
is the host where Oracle Integration is running. -
<deploymentId> is the unique depoloyment ID for a resource. To retrieve the deployment ID of the resource, see Get a Dynamic Process Definition by ID.
The following sample shows the example of the deployment ID in the response body of the Get a Dynamic Process Definition by ID REST resource:
"id": "cm_DP78:1:385", "key": "cm_DP76ad8", "category": "oracleinternalpcs/DPInterfaceTestApp!1.1*soa_735a702c-73ac-4b83-a7ea-a8958bf2e90b", "name": "DPName", "version": 1, "revision": "1.1", "resource": "DP7a6ad8.cmmn", "deploymentId": "380", "description": "Some description for DP process",
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
{ "links": [ { "href": "http://example.oracle.com:7001/ic/api/process/v1", "rel": "parent" }, { "href": "http://example.oracle.com:7001/ic/api/process/v1/dp-resources?deploymentId=380", "rel": "self" } ], "items": [ { "links": [ { "href": "http://example.oracle.com:7001/ic/api/process/v1/dp-resources/DP7ajglr6ad8.cmmn?deploymentId=380", "rel": "self" }, { "href": "http://example.oracle.com:7001/ic/api/process/v1/dp-resources?deploymentId=380", "rel": "parent" } ], "id": "381", "name": "DP7ajglr6ad8.cmmn", "deploymentId": "380", "schema": "<?xml version='1.0' encoding='UTF-8'?>\n<definitions xmlns=\"http://www.omg.org/spec/CMMN/20151109/MODEL\" xmlns:ora=\"http://xmlns.oracle.com/bpm/OracleExtensions\" exporter=\"PCS Composer - Runtime Asset Generator\" exporterVersion=\"1.0\" id=\"Definitions\" name=\"Definitions\" targetNamespace=\"http://bpmn.io/schema/cmmn\">\n <case id=\"cm_DP7ajglr6ad8\" name=\"DPName\">\n <documentation id=\"dc_cm_DP7ajglr6ad8\">Some description for DP process</documentation>\n <extensionElements>\n <ora:connectors/>\n </extensionElements>\n <casePlanModel id=\"DP7ajglr6ad8\" name=\"${"DPName"}\">\n <documentation id=\"dc_DP7ajglr6ad8\">Some description for DP process</documentation>\n <planItem definitionRef=\"at_dpsx39ajkxyrrpiop\" id=\"dpsx39ajkxyrrpiop\" name=\"Activity \">\n <itemControl id=\"ic_dpsx39ajkxyrrpiop\">\n <requiredRule id=\"rq_ic_dpsx39ajkxyrrpiop\">\n <condition id=\"cn_rq_ic_dpsx39ajkxyrrpiop\">${true}</condition>\n </requiredRule>\n <manualActivationRule id=\"ac_ic_dpsx39ajkxyrrpiop\">\n <condition id=\"cn_ac_ic_dpsx39ajkxyrrpiop\">${false}</condition>\n </manualActivationRule>\n </itemControl>\n </planItem>\n <task id=\"at_dpsx39ajkxyrrpiop\">\n <extensionElements>\n <ora:humanTask def=\"HTdpsx39ajkxyrrpiop\" id=\"ht_dpsx39ajkxyrrpiop\" routingType=\"SINGLE\">\n <ora:title>Activity </ora:title>\n <ora:owner type=\"ROLE\">Process Owner</ora:owner>\n <ora:assignees type=\"ROLE\">Process Owner</ora:assignees>\n </ora:humanTask>\n </extensionElements>\n <input id=\"dpsx39ajkxyrrpiop_input\" name=\"WebForm\">\n <extensionElements>\n <ora:type ref=\"generated/json-schemas/WebForm.schema.json\"/>\n <ora:copy>\n <ora:from>${input1}</ora:from>\n <ora:to>${WebForm}</ora:to>\n </ora:copy>\n </extensionElements>\n </input>\n </task>\n </casePlanModel>\n <caseRoles>\n <role id=\"owner\" name=\"Process Owner\">\n <extensionElements>\n <ora:permissions>\n <ora:permission>\n <ora:resources>\n <ora:resource resourceRef=\"DP7ajglr6ad8\" resourceType=\"CASE_INSTANCE\"/>\n </ora:resources>\n <ora:actions>ALL</ora:actions>\n </ora:permission>\n </ora:permissions>\n <ora:members/>\n </extensionElements>\n </role>\n <role id=\"viewer\" name=\"Process Viewer\">\n <extensionElements>\n <ora:permissions>\n <ora:permission>\n <ora:resources>\n <ora:resource resourceRef=\"DP7ajglr6ad8\" resourceType=\"CASE_INSTANCE\"/>\n </ora:resources>\n <ora:actions>READ</ora:actions>\n </ora:permission>\n </ora:permissions>\n <ora:members/>\n </extensionElements>\n </role>\n </caseRoles>\n <input id=\"dPName_input\" name=\"input\">\n <extensionElements>\n <ora:type name=\"string\"/>\n </extensionElements>\n </input>\n <input id=\"dPName_input1\" name=\"input1\">\n <extensionElements>\n <ora:type ref=\"generated/json-schemas/WebForm.schema.json\"/>\n </extensionElements>\n </input>\n <input id=\"dPName_input2\" name=\"input2\">\n <extensionElements>\n <ora:type ref=\"generated/json-schemas/Person.schema.json\"/>\n </extensionElements>\n </input>\n </case>\n</definitions>\n" }, { "links": [ { "href": "http://example.oracle.com:7001/ic/api/process/v1/dp-resources/contentMetadata.xml?deploymentId=380", "rel": "self" }, { "href": "http://example.oracle.com:7001/ic/api/process/v1/dp-resources?deploymentId=380", "rel": "parent" } ], "id": "382", "name": "contentMetadata.xml", "deploymentId": "380", "schema": "<?xml version='1.0' encoding='UTF-8'?>\n<ns0:contentMetadata xmlns:ns0=\"http://xmlns.oracle.com/bpel/workflow/contentMetadata\" targetNamespace=\"http://xmlns.oracle.com/bpel/workflow/contentMetadata\">\n <ns0:isDocsEnabled>false</ns0:isDocsEnabled>\n <ns0:contentApplicationRoot>DPInterfaceTestApp</ns0:contentApplicationRoot>\n <ns0:instanceFolderTitle>DPInterfaceTestApp</ns0:instanceFolderTitle>\n <ns0:contentFolders>\n <ns0:contentFolder defaultPermission=\"contributor\" isStartup=\"true\">\n <ns0:name>Application Documents</ns0:name>\n <ns0:displayName type=\"STATIC\">Application Documents</ns0:displayName>\n </ns0:contentFolder>\n </ns0:contentFolders>\n</ns0:contentMetadata>\n" }, { "links": [ { "href": "http://example.oracle.com:7001/ic/api/process/v1/dp-resources/generated/json-schemas/Person.schema.json?deploymentId=380", "rel": "self" }, { "href": "http://example.oracle.com:7001/ic/api/process/v1/dp-resources?deploymentId=380", "rel": "parent" } ], "id": "384", "name": "generated/json-schemas/Person.schema.json", "deploymentId": "380", "schema": { "$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" ] } } } }, ] }