機械翻訳について

移動先

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

動的プロセス実行詳細の取得

get

/ic/api/process/v1/dp-executions/{id}

指定された実行IDのプロセス実行の詳細を取得します。

リクエスト

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

• application/json

パス・パラメータ

• id(required): string
  プロセス実行ID

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功した操作

本文()

ルート・スキーマ : 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"
                }
            }
        }
    ]
}

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

型: object

識別子: links

ソースを表示

• links: array links

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

ネストされたスキーマ : 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レスポンス

指定されたIdのプロセス実行は存在しません。

500レスポンス

内部サーバー・エラー

先頭に戻る