移動先

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

ワークフロー承認の取得

get

/api/v2/workflow_approvals/{id}/

このリソースに対してGETリクエストを行って、次のフィールドを含む単一のワークフロー承認レコードを取得します。

• id: このワークフロー承認のデータベースID。(整数)
• type: このワークフロー承認のデータ型。(選択)
• url: このワークフロー承認のURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このワークフロー承認が作成されたときのタイムスタンプ。(日時)
• modified: このワークフロー承認が最後に変更されたときのタイムスタンプ。(日時)
• name: このワークフロー承認の名前。(文字列)
• description: このワークフロー承認のオプションの説明。(文字列)
• unified_job_template: (id)
• launch_type: (選択)
  • manual: 手動
  • relaunch: 再起動
  • callback: コールバック
  • scheduled: スケジュール済
  • dependency: 依存性
  • workflow: ワークフロー
  • webhook: Webフック
  • sync: 同期
  • scm: SCM更新
• status: (選択)
  • new: 新規
  • pending: 保留中
  • waiting: 待機中
  • running: 実行中
  • successful: 成功
  • failed: 失敗
  • error: エラー
  • canceled: 取消し済
• execution_environment: 実行に使用されるコンテナ・イメージ。(id)
• failed: (ブール)
• started: ジョブが開始のためにキューに入れられた日時。(日時)
• finished: ジョブの実行が終了した日時。(日時)
• canceled_on: 取消しリクエストが送信された日時。(日時)
• elapsed: ジョブが実行された経過時間(秒)。(10進)
• job_args: (文字列)
• job_cwd: (文字列)
• job_env: (json)
• job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)
• result_traceback: (文字列)
• event_processing_finished: この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。(ブール)
• launched_by: (フィールド)
• work_unit_id: このジョブに関連付けられているレセプタの作業単位ID。(文字列)
• can_approve_or_deny: (フィールド)
• approval_expiration: (フィールド)
• timed_out: (ブール)

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : WorkflowApproval

型: object

ソースを表示

• approval_expiration: 文字列
  タイトル: Approval expiration

  読取り専用: true
• can_approve_or_deny: 文字列
  タイトル: Can approve or deny

  読取り専用: true
• canceled_on: 文字列(日付-時間)
  タイトル: Canceled on

  読取り専用: true

  取消しリクエストが送信された日時。
• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• elapsed: 文字列(10進)
  タイトル: Elapsed

  読取り専用: true

  ジョブが実行された経過時間(秒)。
• event_processing_finished: ブール
  タイトル: Event processing finished

  読取り専用: true

  この統合ジョブによって生成されたすべてのイベントがデータベースに保存されたかどうかを示します。
• execution_environment: 整数
  タイトル: Execution environment

  実行に使用されるコンテナ・イメージ。
• failed: ブール
  タイトル: Failed

  読取り専用: true
• finished: 文字列(日付-時間)
  タイトル: Finished

  読取り専用: true

  ジョブの実行が終了たした日時。
• id: 整数
  タイトル: ID

  読取り専用: true
• job_args: 文字列
  タイトル: Job args

  読取り専用: true

  最小長: 1
• job_cwd: 文字列
  タイトル: Job cwd

  読取り専用: true

  最小長: 1
• job_env: オブジェクト job_env
  タイトル: job_env

  読取り専用: true
• job_explanation: 文字列
  タイトル: Job explanation

  読取り専用: true

  最小長: 1

  ジョブを実行できず、stdoutを取得できなかった場合に、そのジョブの状態を示すステータス・フィールド(文字列)
• launch_type: 文字列
  タイトル: Launch type

  読取り専用: true

  指定できる値: [ "manual", "relaunch", "callback", "scheduled", "dependency", "workflow", "webhook", "sync", "scm" ]
• launched_by: 文字列
  タイトル: Launched by

  読取り専用: true
• modified: 文字列
  タイトル: Modified

  読取り専用: true
• name(必須): 文字列
  タイトル: Name

  最小長: 1

  最大長: 512
• related: 文字列
  タイトル: Related

  読取り専用: true
• result_traceback: 文字列
  タイトル: Result traceback

  読取り専用: true

  最小長: 1
• started: 文字列(日付-時間)
  タイトル: Started

  読取り専用: true

  ジョブが開始のためにキューに入れられた日時。
• status: 文字列
  タイトル: Status

  読取り専用: true

  指定できる値: [ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled" ]
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• timed_out: 文字列
  タイトル: Timed out

  読取り専用: true
• type: 文字列
  タイトル: Type

  読取り専用: true
• unified_job_template: 文字列
  タイトル: unified job template

  読取り専用: true
• url: 文字列
  タイトル: Url

  読取り専用: true
• work_unit_id: 文字列
  タイトル: Work unit id

  読取り専用: true

  最小長: 1

  このジョブに関連付けられているレセプタの作業単位ID。

{
    "properties":{
        "approval_expiration":{
            "readOnly":true,
            "title":"Approval expiration",
            "type":"string"
        },
        "can_approve_or_deny":{
            "readOnly":true,
            "title":"Can approve or deny",
            "type":"string"
        },
        "canceled_on":{
            "description":"The date and time when the cancel request was sent.",
            "format":"date-time",
            "readOnly":true,
            "title":"Canceled on",
            "type":"string",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "elapsed":{
            "description":"Elapsed time in seconds that the job ran.",
            "format":"decimal",
            "readOnly":true,
            "title":"Elapsed",
            "type":"string"
        },
        "event_processing_finished":{
            "description":"Indicates whether all of the events generated by this unified job have been saved to the database.",
            "readOnly":true,
            "title":"Event processing finished",
            "type":"boolean"
        },
        "execution_environment":{
            "description":"The container image to be used for execution.",
            "title":"Execution environment",
            "type":"integer",
            "x-nullable":true
        },
        "failed":{
            "readOnly":true,
            "title":"Failed",
            "type":"boolean"
        },
        "finished":{
            "description":"The date and time the job finished execution.",
            "format":"date-time",
            "readOnly":true,
            "title":"Finished",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "job_args":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job args",
            "type":"string"
        },
        "job_cwd":{
            "minLength":"1",
            "readOnly":true,
            "title":"Job cwd",
            "type":"string"
        },
        "job_env":{
            "readOnly":true,
            "title":"job_env",
            "type":"object"
        },
        "job_explanation":{
            "description":"A status field to indicate the state of the job if it wasn't able to run and capture stdout",
            "minLength":"1",
            "readOnly":true,
            "title":"Job explanation",
            "type":"string"
        },
        "launch_type":{
            "enum":[
                "manual",
                "relaunch",
                "callback",
                "scheduled",
                "dependency",
                "workflow",
                "webhook",
                "sync",
                "scm"
            ],
            "readOnly":true,
            "title":"Launch type",
            "type":"string"
        },
        "launched_by":{
            "readOnly":true,
            "title":"Launched by",
            "type":"string"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "result_traceback":{
            "minLength":"1",
            "readOnly":true,
            "title":"Result traceback",
            "type":"string"
        },
        "started":{
            "description":"The date and time the job was queued for starting.",
            "format":"date-time",
            "readOnly":true,
            "title":"Started",
            "type":"string",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timed_out":{
            "readOnly":true,
            "title":"Timed out",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "unified_job_template":{
            "readOnly":true,
            "title":"unified job template",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        },
        "work_unit_id":{
            "description":"The Receptor work unit ID associated with this job.",
            "minLength":"1",
            "readOnly":true,
            "title":"Work unit id",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

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

型: object

タイトル: job_env

読取り専用: true

先頭に戻る