REST API for Oracle Integration

機械翻訳について

動的プロセス実行のリストを取得

get

/ic/api/process/v1/dp-executions

ユーザーがアクセスできる動的プロセス実行のリストを取得します。

リクエスト

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

application/json

問合せパラメータ

createdAfter: string

指定した日付より後に作成されたインスタンスに制限します。日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTCタイムザーンの2013-01-23T14:42:45.000Z。
createdBefore: string

指定した日付より前に作成されたインスタンスに制限します。日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTCタイムザーンの2013-01-23T14:42:45.000Z。
endedAfter: string

指定した日付より後に終了したインスタンスに制限します。日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTCタイムザーンの2013-01-23T14:42:45.000Z。
endedBefore: string

指定した日付より前に終了したインスタンスに制限します。日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTCタイムザーンの2013-01-23T14:42:45.000Z。
finished: boolean

完了したプロセス・アクティビティ・インスタンスのみを含める。 falseはデフォルトの動作であるため、値は真になります。
firstResult: integer

結果のページ番号付け。返される最初の結果のインデックスを指定します。
maxResults: integer

結果のページ番号付け。返す結果の最大数を指定します。それ以上の結果が残っていない場合は、結果が少なくなります。
processActivityId: string

このオブジェクトがインスタンスであるプロセス・アクティビティのID。
processActivityInstanceId: string

プロセス・アクティビティ・インスタンスIDでフィルタします。
processActivityName: string

このオブジェクトがインスタンスであるプロセス・アクティビティの名前。
processActivityType: string

このプロセス実行が属するアクティビティのタイプ。
processDefinitionId: string

プロセス定義IDでフィルタします。完全一致。
processExecutionId: string

プロセス・アクティビティ・インスタンスを実行したプロセス実行のIDでフィルタします。
processInstanceId: string

プロセス・インスタンスIDでフィルタします。
required: boolean

必須のプロセス・アクティビティ・インスタンスのみを含めます。 falseはデフォルトの動作であるため、値は真になります。
sortBy: string

特定の基準で結果をソートします。有効な値は、processActivityInstanceId、processInstanceId、processExecutionId、processActivityId、processActivityName、processActivityType、processDefinitionId、createTime、endTime、期間です。 sortOrderパラメータと組み合わせて使用する必要があります。
sortOrder: string

結果を指定した順序でソートします。値は昇順の場合は昇順、降順の場合は降順です。 sortByパラメータと組み合わせて使用する必要があります。
state: string

状態でフィルタします。
unfinished: boolean

終了していないプロセス・アクティビティ・インスタンスのみが含まれます。 falseはデフォルトの動作であるため、値は真になります。

トップに戻る

レスポンス

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

application/json

200レスポンス

操作の成功

ルート・スキーマ : ProcessExecutions

型: object

すべてに一致

ソースを表示

object CommonModel

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

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

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

型: object

識別子: links

ソースを表示

links: array links

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

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

型: object

ソースを表示

items: array items

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

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

型: array

ソースを表示

Array of: object ProcessExecution

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

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

型: object

すべてに一致

ソースを表示

object CommonModel

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

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "parentProcessActivityInstanceId":{
                    "type":"string",
                    "description":"The ID of the parent process activity this instance belongs to."
                },
                "activityId":{
                    "type":"string",
                    "description":"The ID of the activity."
                },
                "activityName":{
                    "type":"string",
                    "description":"The name of the activity."
                },
                "activityType":{
                    "type":"string",
                    "description":"The type of the activity."
                },
                "processDefinitionId":{
                    "type":"string",
                    "description":"The ID of the process definition that this process activity instance belongs to."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The ID of the process instance that this  activity instance belongs to."
                },
                "executionId":{
                    "type":"string",
                    "description":"The ID of the execution."
                },
                "userId":{
                    "type":"string",
                    "description":"The ID of the user this activty instance is assigned to."
                },
                "createTime":{
                    "type":"string",
                    "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
                },
                "endTime":{
                    "type":"string",
                    "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
                },
                "durationInMillis":{
                    "type":"integer",
                    "format":"int64",
                    "description":"The time the instance took to finish, in milliseconds."
                },
                "required":{
                    "type":"boolean",
                    "description":"If this activity is required"
                },
                "state":{
                    "type":"string",
                    "description":"state of the process activity instance",
                    "default":"ACTIVE",
                    "enum":[
                        "AVAILABLE",
                        "ENABLED",
                        "DISABLED",
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED",
                        "FAILED"
                    ]
                },
                "availableActions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "availablePermissions":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "failureMessage":{
                    "type":"string",
                    "description":"This shows failure reasons when activity is in failed state"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

activityId: string

アクティビティのID。
activityName: string

アクティビティの名前。
activityType: string

アクティビティのタイプ。
availableActions: array availableActions
availablePermissions: array availablePermissions
createTime: string

インスタンスが作成された時間。形式はyyyy-MM-dd'T'HH:mm:ss.SSSZです。日付はUTCで返します。
durationInMillis: integer(int64)

インスタンスが終了するまでの時間(ミリ秒単位)。
endTime: string

インスタンスが終了した時間。形式はyyyy-MM-dd'T'HH:mm:ss.SSSZです。日付はUTCで返します。
executionId: string

実行のID。
failureMessage: string

これは、アクティビティが失敗状態のときの失敗事由を示します。
id: string

プロセス実行インスタンスのID。
parentProcessActivityInstanceId: string

このインスタンスが属する親プロセス・アクティビティのID。
processDefinitionId: string

このプロセス・アクティビティ・インスタンスが属するプロセス定義のID。
processInstanceId: string

このアクティビティ・インスタンスが属するプロセス・インスタンスのID。
required: boolean

このアクティビティが必須の場合
state: string

デフォルト値: ACTIVE

許容値: [ "AVAILABLE", "ENABLED", "DISABLED", "ACTIVE", "COMPLETED", "TERMINATED", "FAILED" ]

プロセス・アクティビティ・インスタンスの状態
userId: string

このアクティビティ・インスタンスが割り当てられているユーザーのID。

{
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "parentProcessActivityInstanceId":{
            "type":"string",
            "description":"The ID of the parent process activity this instance belongs to."
        },
        "activityId":{
            "type":"string",
            "description":"The ID of the activity."
        },
        "activityName":{
            "type":"string",
            "description":"The name of the activity."
        },
        "activityType":{
            "type":"string",
            "description":"The type of the activity."
        },
        "processDefinitionId":{
            "type":"string",
            "description":"The ID of the process definition that this process activity instance belongs to."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this  activity instance belongs to."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution."
        },
        "userId":{
            "type":"string",
            "description":"The ID of the user this activty instance is assigned to."
        },
        "createTime":{
            "type":"string",
            "description":"The time the instance was created. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
        },
        "endTime":{
            "type":"string",
            "description":"The time the instance ended. Has the format yyyy-MM-dd'T'HH:mm:ss.SSSZ, Returns date in UTC."
        },
        "durationInMillis":{
            "type":"integer",
            "format":"int64",
            "description":"The time the instance took to finish, in milliseconds."
        },
        "required":{
            "type":"boolean",
            "description":"If this activity is required"
        },
        "state":{
            "type":"string",
            "description":"state of the process activity instance",
            "default":"ACTIVE",
            "enum":[
                "AVAILABLE",
                "ENABLED",
                "DISABLED",
                "ACTIVE",
                "COMPLETED",
                "TERMINATED",
                "FAILED"
            ]
        },
        "availableActions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "availablePermissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "failureMessage":{
            "type":"string",
            "description":"This shows failure reasons when activity is in failed state"
        }
    }
}

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

型: array

ソースを表示

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ソースを表示

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401レスポンス

未認可

404レスポンス

一部の問合せパラメータが有効でない場合に返されます。たとえば、sortOrderパラメータが指定されていて、sortByが指定されていない場合などです。

500レスポンス

内部サーバー・エラー

先頭に戻る