REST API for Oracle Integration

機械翻訳について

プロセス・インスタンスのデータ・オブジェクトの取得

get

/ic/api/process/v1/processes/{processId}/dataobjects

プロセス・レベルでプロセス・インスタンスのデータ・オブジェクトを取得します。

リクエスト

パス・パラメータ

processId(required): string

プロセスIDの値

問合せパラメータ

includeInstanceAttributes: boolean

インスタンス・レベル属性を含む

デフォルト値: false
suspendInstance: boolean

インスタンスを一時停止するかどうか - ユーザーがオープン・アクティビティを取得してそれに対する作業を行う間、インスタンスが移動しないようにします。

デフォルト値: false
type: string

データ・オブジェクト構造タイプ - フラットまたはツリー

デフォルト値: flat

トップに戻る

レスポンス

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

application/json

200レスポンス

成功

ルート・スキーマ : ActivityFlowResponse

型: object

ソースを表示

dataVariableFlatTree: array dataVariableFlatTree
dataVariableTree: object DataVariableNodeRes
flowChanges: array flowChanges
levels: integer(int32)
links: array links
title: string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "dataVariableTree":{
            "$ref":"#/definitions/DataVariableNodeRes"
        },
        "dataVariableFlatTree":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariableNodeRes"
            }
        },
        "flowChanges":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FlowChangeItemRes"
            }
        }
    }
}

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

型: array

ソースを表示

Array of: object DataVariableNodeRes

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

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

型: object

ソースを表示

children: array children
correlationKeyPropertyName: object QName
editable: boolean
levels: integer(int32)
links: array links
name: string
nodeType: string
scope: string
title: string
value: string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DataVariableNodeRes"
            }
        },
        "correlationKeyPropertyName":{
            "$ref":"#/definitions/QName"
        },
        "editable":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "nodeType":{
            "type":"string"
        },
        "scope":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

Array of: object FlowChangeItemRes

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

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

型: array

ソースを表示

Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

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

型: array

ソースを表示

Array of: object DataVariableNodeRes

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

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

型: object

ソースを表示

localPart: string
namespaceURI: string
prefix: string

{
    "type":"object",
    "properties":{
        "namespaceURI":{
            "type":"string"
        },
        "localPart":{
            "type":"string"
        },
        "prefix":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

Array of: object Link

{
    "type":"array",
    "items":{
        "xml":{
            "name":"links"
        },
        "$ref":"#/definitions/Link"
    }
}

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

型: object

ソースを表示

href: string
mediaType: string
rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

activityLocation: string
sourceActivity: object OpenActivityInfo
targetActivityId: string
targetGrabActivities: array targetGrabActivities
taskNumber: integer(int32)

{
    "type":"object",
    "properties":{
        "activityLocation":{
            "type":"string"
        },
        "sourceActivity":{
            "$ref":"#/definitions/OpenActivityInfo"
        },
        "taskNumber":{
            "type":"integer",
            "format":"int32"
        },
        "targetActivityId":{
            "type":"string"
        },
        "targetGrabActivities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ActivityInfo"
            }
        }
    }
}

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

型: object

ソースを表示

attributes: array attributes

一意のアイテムが必要: true
container: boolean
locationInfo: object ILocationInfo
path: object ActivityPathInfo
threadId: integer(int32)
workItemKeyURI: string

{
    "type":"object",
    "properties":{
        "attributes":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/IVariableItem"
            }
        },
        "locationInfo":{
            "$ref":"#/definitions/ILocationInfo"
        },
        "path":{
            "$ref":"#/definitions/ActivityPathInfo"
        },
        "workItemKeyURI":{
            "type":"string"
        },
        "threadId":{
            "type":"integer",
            "format":"int32"
        },
        "container":{
            "type":"boolean"
        }
    }
}

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

型: array

ソースを表示

Array of: object ActivityInfo

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

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

型: array

一意のアイテムが必要: true

ソースを表示

Array of: object IVariableItem

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/IVariableItem"
    }
}

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

型: object

ソースを表示

activityInfo: object IActivityInfo
processInstanceInfo: object IProcessInstanceInfo
root: boolean

{
    "type":"object",
    "properties":{
        "activityInfo":{
            "$ref":"#/definitions/IActivityInfo"
        },
        "processInstanceInfo":{
            "$ref":"#/definitions/IProcessInstanceInfo"
        },
        "root":{
            "type":"boolean"
        }
    }
}

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

型: object

ソースを表示

endLocation: object LocationInfo
length: integer(int32)
locations: object IterableILocationInfo
startLocation: object LocationInfo
stringPath: string

{
    "type":"object",
    "properties":{
        "locations":{
            "$ref":"#/definitions/IterableILocationInfo"
        },
        "stringPath":{
            "type":"string"
        },
        "startLocation":{
            "$ref":"#/definitions/LocationInfo"
        },
        "endLocation":{
            "$ref":"#/definitions/LocationInfo"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースを表示

editable: boolean
expressionString: string
name: string
namespaceMapping: object namespaceMapping

許可される追加のプロパティ: additionalProperties
type: object QName
value: string

{
    "type":"object",
    "properties":{
        "namespaceMapping":{
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "format":"uri"
            }
        },
        "expressionString":{
            "type":"string"
        },
        "editable":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/QName"
        }
    }
}

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

型: object

使用可能なその他のプロパティ

ソースを表示

string(uri)

{
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "format":"uri"
    }
}

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

型: object

ソースを表示

displayName: string
id: string
processId: string

{
    "type":"object",
    "properties":{
        "processId":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

id: integer(int64)
thread: integer(int32)

{
    "type":"object",
    "properties":{
        "thread":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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

型: object

ソースを表示

absoluteScopeId: string
activityInfo: object IActivityInfo
loopCounter: object loopCounter
multiInstance: boolean
processInstanceInfo: object ProcessInstanceInfo
root: boolean

{
    "type":"object",
    "properties":{
        "absoluteScopeId":{
            "type":"string"
        },
        "activityInfo":{
            "$ref":"#/definitions/IActivityInfo"
        },
        "multiInstance":{
            "type":"boolean"
        },
        "loopCounter":{
            "type":"object"
        },
        "processInstanceInfo":{
            "$ref":"#/definitions/ProcessInstanceInfo"
        },
        "root":{
            "type":"boolean"
        }
    }
}

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

型: object

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

型: object

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

型: object

ソースを表示

id: integer(int64)
thread: integer(int32)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "thread":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: object

ソースを表示

displayName: string
id: string
processId: string

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "processId":{
            "type":"string"
        }
    }
}

400レスポンス

不正なリクエスト。

401レスポンス

未認可

404レスポンス

Not Found

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例は、RESTリソースにGETリクエストを送信することによって、プロセス・レベルでプロセス・インスタンスのデータ・オブジェクトを取得する方法を示しています:

リクエストの送信

https://example.com/ic/api/process/v1/processes/{processId}/dataobjects

説明:

example.comは、Oracle Integrationが実行されているホストです。
<version>はREST APIバージョンです。
<Process ID>はプロセスのIDです。

たとえば、 1 「プロセス・インスタンス・リストの取得」を使用して<Process ID>を取得できます。

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

Status Code: 200 OK

レスポンス本文の例

{
   "dataVariableNodesFlatRes": [
        {
            "levels": 0,
            "editable": true,
            "name": "startWebFormDataObject",
            "nodeType": "NODE_TYPE_VARIABLE",
            "scope": "MainProcess",
            "value": "{ \"travelPurpose\" : \"tsss\" , \"cost\" : \"134\" }"
        },
        {
            "levels": 0,
            "editable": true,
            "name": "TaskOutcomeDataObject",
            "nodeType": "NODE_TYPE_VARIABLE",
            "scope": "MainProcess"
        },
        {
            "levels": 0,
            "editable": false,
            "name": "ownerType",
            "nodeType": "NODE_TYPE_INSTANCE_ATTRIBUTE",
            "scope": "MainProcess",
            "value": "ROLE"
        },
    ]
}

先頭に戻る