機械翻訳について

移動先

• リクエスト
• レスポンス

プロセス実行のリスト

get

/process/api/v1/dp-executions

現在のユーザーのすべてのプロセス実行のリストを取得します。

リクエスト

問合せパラメータ

• createdAfter: string
  指定された日付より後に作成されたインスタンスに制限します。 日付の形式はyyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTC timezomeの場合は2013-01-23T14:42:45.000Zです。
• createdBefore: string
  指定された日付より前に作成されたインスタンスに制限します。 日付の形式はyyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTC timezomeの場合は2013-01-23T14:42:45.000Zです。
• endedAfter: string
  指定日より後に終了したインスタンスに制限されます。 日付の形式はyyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTC timezomeの場合は2013-01-23T14:42:45.000Zです。
• endedBefore: string
  指定日より前に終了したインスタンスに制限されます。 日付の形式はyyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。たとえば、UTC timezomeの場合は2013-01-23T14:42:45.000Zです。
• finished: boolean
  完了したプロセス・アクティビティ・インスタンスのみを含める。 falseはデフォルトの動作であるため、値は真になります。
• limit: integer
  最大値: 500

  結果のページ番号付け。 返す結果の最大数を指定します。 結果がなくなると、結果数が少なくなります。

  デフォルト値: 25
• offset: integer
  結果のページ番号付け。 返される最初の結果のインデックスを指定します。

  デフォルト値: 0
• parentProcessActivityInstanceId: string
  親プロセス・アクティビティ・インスタンスIDでフィルタ
• 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パラメータと組み合わせて使用する必要があります。

  デフォルト値: processExecutionId

  許容値: [ "processActivityInstanceId", "processInstanceId", "processExecutionId", "processActivityId", "processActivityName", "processActivityType", "processDefinitionId", "createTime", "endTime", "duration" ]
• sortOrder: string
  指定した順序で結果を並べ替えます。 値は昇順の場合はasc、降順の場合はdescです。 sortByパラメータと組み合わせて使用する必要があります。

  デフォルト値: ASC

  許容値: [ "ASC", "DESC" ]
• state: string
  状態でフィルタします。
• totalResults: boolean
  trueの場合、フィルタのある特定の問合せに対してtotalResultsカウントを返します

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

ヘッダー・パラメータ

• oci-original-url: 文字列
  顧客がリクエストした実際のエンドポイント

この操作のリクエスト本文がありません。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : ProcessExecutions

型: object

すべてに一致

ソースを表示

• object CommonModel
• object ProcessExecutions-allOf[1]
• object PaginationResponse
  ページ区切り詳細

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

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

型: object

ソースを表示

• links: array links

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

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

型: object

ソースを表示

• items: array items

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

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

型: object

ページ区切り詳細

ソースを表示

• count: integer
  現在の結果で返されたアイテムの数
• hasMore: boolean
  フェッチするページがさらにあるかどうか
• limit: integer
  ページ区切りレスポンスの最大サイズ
• offset: integer
  ページ区切りレスポンスのオフセット
• totalResults: integer
  フィルタ基準が適用された合計数

{
    "description":"Pagination details",
    "properties":{
        "count":{
            "type":"integer",
            "description":"count of items returned in current result"
        },
        "totalResults":{
            "type":"integer",
            "description":"total count with the applied filter criteria"
        },
        "limit":{
            "type":"integer",
            "description":"max size for the paginated response"
        },
        "offset":{
            "type":"integer",
            "description":"offset for the paginated response"
        },
        "hasMore":{
            "type":"boolean",
            "description":"whether there are more pages to fetch"
        }
    }
}

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

型: array

ソースを表示

• Array of: object Link
  リンクの定義

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

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

型: object

リンクの定義

ソースを表示

• code: integer
  最小値: 100

  最大値: 600
• href(required): string
• hreflang: string
• length: integer (int32)
• mediaType: string
• message: string
• rel(required): string
• title: string
• type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":100,
            "maximum":600
        }
    }
}

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

型: array

ソースを表示

• Array of: ProcessExecution

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

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

すべてに一致

ソースを表示

• object CommonModel
• object ProcessExecution-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "processExecutionId":{
                    "type":"string",
                    "description":"The ID of the process execution instance."
                },
                "processInstanceId":{
                    "type":"string",
                    "description":"The ID of the process instance that this execution instance belongs to."
                },
                "assignee":{
                    "type":"string",
                    "description":"The assignee incase the activity is a user task."
                },
                "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."
                },
                "executionId":{
                    "type":"string",
                    "description":"The ID of the execution."
                },
                "taskId":{
                    "type":"string",
                    "description":"Task Id"
                },
                "taskTitle":{
                    "type":"string",
                    "description":"Task Title"
                },
                "bpmnProcessTitle":{
                    "type":"string",
                    "description":"Sructured Process Title"
                },
                "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"
                },
                "calledProcessInstance":{
                    "type":"string",
                    "description":"The name of the calledProcessInsatnce"
                },
                "state":{
                    "type":"string",
                    "description":"state of the process activity instance",
                    "default":"ACTIVE",
                    "enum":[
                        "AVAILABLE",
                        "ENABLED",
                        "DISABLED",
                        "ACTIVE",
                        "COMPLETED",
                        "TERMINATED",
                        "FAILED",
                        "SUSPENDED"
                    ]
                },
                "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"
                },
                "faultData":{
                    "$ref":"#/components/schemas/FaultData"
                }
            }
        }
    ]
}

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

型: object

ソースを表示

• activityId: string
  アクティビティのID。
• activityName: string
  アクティビティの名前。
• activityType: string
  アクティビティのタイプ。
• assignee: string
  アクティビティが発生する割当先はユーザー・タスクです。
• availableActions: array availableActions
• availablePermissions: array availablePermissions
• bpmnProcessTitle: string
  構造化プロセス・タイトル
• calledProcessInstance: string
  calledProcessInsatnceの名前
• 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
  これは、アクティビティが失敗状態のときの失敗事由を示します。
• faultData: object FaultData
• id: string
  プロセス実行インスタンスのID。
• parentProcessActivityInstanceId: string
  このインスタンスが属する親プロセス・アクティビティのID。
• processDefinitionId: string
  このプロセス・アクティビティ・インスタンスが属するプロセス定義のID。
• processExecutionId: string
  プロセス実行インスタンスのID。
• processInstanceId: string
  この実行インスタンスが属するプロセス・インスタンスのID。
• required: boolean
  このアクティビティが必須の場合
• state: string
  デフォルト値: ACTIVE

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

  プロセス・アクティビティ・インスタンスの状態
• taskId: string
  タスクID
• taskTitle: string
  タスクのタイトル
• userId: string
  このアクティビティ・インスタンスが割り当てられているユーザーのID。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "processExecutionId":{
            "type":"string",
            "description":"The ID of the process execution instance."
        },
        "processInstanceId":{
            "type":"string",
            "description":"The ID of the process instance that this execution instance belongs to."
        },
        "assignee":{
            "type":"string",
            "description":"The assignee incase the activity is a user task."
        },
        "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."
        },
        "executionId":{
            "type":"string",
            "description":"The ID of the execution."
        },
        "taskId":{
            "type":"string",
            "description":"Task Id"
        },
        "taskTitle":{
            "type":"string",
            "description":"Task Title"
        },
        "bpmnProcessTitle":{
            "type":"string",
            "description":"Sructured Process Title"
        },
        "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"
        },
        "calledProcessInstance":{
            "type":"string",
            "description":"The name of the calledProcessInsatnce"
        },
        "state":{
            "type":"string",
            "description":"state of the process activity instance",
            "default":"ACTIVE",
            "enum":[
                "AVAILABLE",
                "ENABLED",
                "DISABLED",
                "ACTIVE",
                "COMPLETED",
                "TERMINATED",
                "FAILED",
                "SUSPENDED"
            ]
        },
        "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"
        },
        "faultData":{
            "$ref":"#/components/schemas/FaultData"
        }
    }
}

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

型: array

ソースを表示

• Array of: string

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

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

型: array

ソースを表示

• Array of: string

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

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

型: object

ソースを表示

• errorCause: string
  エラー原因
• errorCode: string
  エラー・コード
• errorMessage: string
  エラー・メッセージ
• errorStatus: integer
  エラー・ステータス

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "description":"Error Message"
        },
        "errorCause":{
            "type":"string",
            "description":"Error Cause"
        },
        "errorStatus":{
            "type":"integer",
            "description":"Error Status"
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        }
    }
}

401レスポンス

未認可

404レスポンス

sortOrderパラメータが指定されているがsortByが指定されていない場合など、問合せパラメータの一部が無効な場合に返されます

429レスポンス

リクエストが多すぎます

500レスポンス

内部サーバー・エラー

503レスポンス

例外が多すぎるか、リクエストの処理が遅すぎます

先頭に戻る