REST API for Oracle Integration

機械翻訳について

動的プロセス・リソースのリストの取得

get

/ic/api/process/v1/dp-resources

指定されたデプロイメントIDの動的プロセス・リソースのリストを取得します。

動的プロセス・リソースを取得するには、deploymentId問合せパラメータを使用する必要があります。

リクエスト

サポートされているメディア・タイプ

application/json

問合せパラメータ

deploymentId(required): string

リソースのデプロイメントID。動的プロセス・リソースを取得中に、この問合せパラメータを使用する必要があります。そうでない場合、内部サーバー・エラーが発生します。

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

成功した操作

ルート・スキーマ : ProcessResources

型: object

すべてに一致

ソースを表示

object CommonModel

識別子: links
object ProcessResources-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessResource"
                    }
                }
            }
        }
    ]
}

ネストされたスキーマ : CommonModel

型: object

識別子: links

ソースを表示

links: array links

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

ネストされたスキーマ : ProcessResources-allOf[1]

型: object

ソースを表示

items: array items

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

ネストされたスキーマ: items

型: array

ソースを表示

Array of: object ProcessResource

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

ネストされたスキーマ : ProcessResource

型: object

すべてに一致

ソースを表示

object CommonModel

識別子: links
object ProcessResource-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The id of the deployment resource."
                },
                "name":{
                    "type":"string",
                    "description":"The name of the deployment resource."
                },
                "deploymentId":{
                    "type":"string",
                    "description":"The deployment ID"
                },
                "schema":{
                    "type":"object",
                    "description":"The schema of the resource."
                }
            }
        }
    ]
}

ネストされたスキーマ : ProcessResource-allOf[1]

型: object

ソースを表示

deploymentId: string

デプロイメントID
id: string

デプロイメント・リソースのId。
name: string

デプロイメント・リソースの名前。
schema: object schema

リソースのスキーマ。

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The id of the deployment resource."
        },
        "name":{
            "type":"string",
            "description":"The name of the deployment resource."
        },
        "deploymentId":{
            "type":"string",
            "description":"The deployment ID"
        },
        "schema":{
            "type":"object",
            "description":"The schema of the resource."
        }
    }
}

ネストされたスキーマ: schema

型: object

リソースのスキーマ。

401レスポンス

未認可

404レスポンス

指定されたデプロイメントIDは存在しません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、RESTリソースにGETリクエストを送信することによって、指定されたデプロイメントIDの動的プロセス・リソースのリストを取得する方法を示しています。

リクエストの送信

次の例では、送信リクエストのコンテンツを示しています。

https://example.com/ic/api/process/v1/ic/api/process/v1/dp-resources?deploymentId=<deploymentId>

説明

example.comは、Oracle Integrationが実行されているホストです。

<deploymentId>は、リソースの一意の預入IDです。リソースのデプロイメントIDを取得するには、「IDによる動的プロセス定義の取得」を参照してください。

次の例は、「IDによる動的プロセス定義の取得」 RESTリソースのレスポンス本文に含まれるデプロイメントIDの例を示しています:

"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",

レスポンス・ヘッダーの例

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

レスポンス本文の例

{
    "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=\"${&quot;DPName&quot;}\">\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"
                        ]
                    }
                }
            }
        },
        
    ]
}

先頭に戻る