機械翻訳について

移動先

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

ワークフロー・ジョブの取得

get

/api/v2/workflow_jobs/{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: 取消し済
• failed: (ブール)
• started: ジョブが開始のためにキューに入れられた日時。(日時)
• finished: ジョブの実行が終了した日時。(日時)
• canceled_on: 取消しリクエストが送信された日時。(日時)
• elapsed: ジョブが実行された経過時間(秒)。(10進)
• job_args: (文字列)
• job_cwd: (文字列)
• job_env: (json)
• job_explanation: stdoutを実行および取得できなかった場合のジョブの状態を示すステータス・フィールド(文字列)
• result_traceback: (文字列)
• launched_by: (フィールド)
• work_unit_id: このジョブに関連付けられた受信者作業ユニットID。(文字列)
• workflow_job_template: (id)
• extra_vars: (json)
• allow_simultaneous: (ブール)
• job_template: スライスされたジョブの実行用に自動的に作成された場合、ワークフロー・ジョブの作成元となったジョブ・テンプレート。(id)
• is_sliced_job: (ブール)
• inventory: プロンプトとして適用されるインベントリ(ジョブ・テンプレートによってインベントリの指定を求めるプロンプトが表示されると仮定する) (id)
• limit: (文字列)
• scm_branch: (文字列)
• webhook_service: Webフック・リクエストを受け入れるサービス(選択)
  • "": ---------
  • github: GitHub
  • gitlab: GitLab
  • bitbucket_dc: BitBucket DataCenter
• webhook_credential: サービスAPIにステータスをポスト・バックするための個人アクセス・トークン(id)
• webhook_guid: このWebフックをトリガーしたイベントの一意の識別子(文字列)
• skip_tags: (文字列)
• job_tags: (文字列)

リクエスト

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

• application/json

パス・パラメータ

• id(required): string

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : WorkflowJob

型: object

ソースを表示

• allow_simultaneous: boolean
  タイトル: Allow simultaneous
• canceled_on: string(date-time)
  タイトル: Canceled on

  読取り専用: true

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

  読取り専用: true
• description: string
  タイトル: Description
• elapsed: string(decimal)
  タイトル: Elapsed

  読取り専用: true

  ジョブが実行された経過時間(秒)。
• extra_vars: string
  タイトル: Extra vars
• failed: boolean
  タイトル: Failed

  読取り専用: true
• finished: string(date-time)
  タイトル: Finished

  読取り専用: true

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

  読取り専用: true
• inventory: integer
  タイトル: Inventory

  ジョブ・テンプレートがインベントリを要求すると仮定して、プロンプトとして適用されたインベントリ
• is_sliced_job: boolean
  タイトル: Is sliced job
• job_args: string
  タイトル: Job args

  読取り専用: true

  最小長: 1
• job_cwd: string
  タイトル: Job cwd

  読取り専用: true

  最小長: 1
• job_env: object job_env
  タイトル: job_env

  読取り専用: true
• job_explanation: string
  タイトル: Job explanation

  読取り専用: true

  最小長: 1

  ジョブが実行および取得できなかった場合にジョブの状態を示すステータス・フィールド
• job_tags: string
  タイトル: Job tags
• job_template: string
  タイトル: Job template

  スライスされたジョブの実行に対して自動的に作成された場合、ワークフロー・ジョブの作成元のジョブ・テンプレート。
• launch_type: string
  タイトル: Launch type

  読取り専用: true

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

  読取り専用: true
• limit: string
  タイトル: Limit
• modified: string
  タイトル: Modified

  読取り専用: true
• name(required): string
  タイトル: Name

  最小長: 1

  最大長: 512
• related: string
  タイトル: Related

  読取り専用: true
• result_traceback: string
  タイトル: Result traceback

  読取り専用: true

  最小長: 1
• scm_branch: string
  タイトル: Scm branch
• skip_tags: string
  タイトル: Skip tags
• started: string(date-time)
  タイトル: Started

  読取り専用: true

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

  読取り専用: true

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

  読取り専用: true
• type: string
  タイトル: Type

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

  読取り専用: true
• url: string
  タイトル: Url

  読取り専用: true
• webhook_credential: integer
  タイトル: Webhook credential

  サービスAPIにステータスを転記するための個人アクセス・トークン
• webhook_guid: string
  タイトル: Webhook guid

  最大長: 128

  このwebフックをトリガーしたイベントの一意識別子
• webhook_service: string
  タイトル: Webhook service

  指定できる値: [ "github", "gitlab", "bitbucket_dc" ]

  webフック・リクエストを受け入れるサービス
• work_unit_id: string
  タイトル: Work unit id

  読取り専用: true

  最小長: 1

  このジョブに関連付けられた受容体作業ユニットID。
• workflow_job_template: string
  タイトル: Workflow job template

{
    "properties":{
        "allow_simultaneous":{
            "title":"Allow simultaneous",
            "type":"boolean",
            "x-nullable":true
        },
        "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"
        },
        "extra_vars":{
            "title":"Extra vars",
            "type":"string",
            "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"
        },
        "inventory":{
            "description":"Inventory applied as a prompt, assuming job template prompts for inventory",
            "title":"Inventory",
            "type":"integer",
            "x-nullable":true
        },
        "is_sliced_job":{
            "title":"Is sliced job",
            "type":"boolean",
            "x-nullable":true
        },
        "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"
        },
        "job_tags":{
            "title":"Job tags",
            "type":"string",
            "x-nullable":true
        },
        "job_template":{
            "description":"If automatically created for a sliced job run, the job template the workflow job was created from.",
            "title":"Job template",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "limit":{
            "title":"Limit",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "scm_branch":{
            "title":"Scm branch",
            "type":"string",
            "x-nullable":true
        },
        "skip_tags":{
            "title":"Skip tags",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "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"
        },
        "webhook_credential":{
            "description":"Personal Access Token for posting back the status to the service API",
            "title":"Webhook credential",
            "type":"integer",
            "x-nullable":true
        },
        "webhook_guid":{
            "description":"Unique identifier of the event that triggered this webhook",
            "maxLength":"128",
            "title":"Webhook guid",
            "type":"string",
            "x-nullable":true
        },
        "webhook_service":{
            "description":"Service that webhook requests will be accepted from",
            "enum":[
                "github",
                "gitlab",
                "bitbucket_dc"
            ],
            "title":"Webhook service",
            "type":"string",
            "x-nullable":true
        },
        "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
        },
        "workflow_job_template":{
            "title":"Workflow job template",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

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

型: object

タイトル: job_env

読取り専用: true

先頭に戻る