移動先

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

プロジェクトの取得

get

/api/v2/projects/{id}/

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

• id: このプロジェクトのデータベースID。(整数)
• type: このプロジェクトのデータ型。(選択)
• url: このプロジェクトのURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このプロジェクトが作成されたときのタイムスタンプ。(日時)
• modified: このプロジェクトが最後に変更されたときのタイムスタンプ。(日時)
• name: このプロジェクトの名前。(文字列)
• description: このプロジェクトのオプションの説明。(文字列)
• local_path: このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。(文字列)
• scm_type: プロジェクトを格納するために使用するソース・コントロール・システムを指定します。(選択)
  • "": 手動
  • git: Git
  • svn: Subversion
  • insights: Red Hat Insights
  • archive: リモート・アーカイブ
• scm_url: プロジェクトが格納される場所。(文字列)
• scm_branch: チェックアウトする特定のブランチ、タグまたはコミット。(文字列)
• scm_refspec: gitプロジェクトについて、フェッチする追加のrefspec。(文字列)
• scm_clean: プロジェクトを同期化する前にローカルの変更を破棄します。(ブール)
• scm_track_submodules: 定義済ブランチにおけるサブモジュールの最新コミットを追跡します。(ブール)
• scm_delete_on_update: 同期化する前にプロジェクトを削除します。(ブール)
• credential: (id)
• timeout: タスクが取り消されるまでの実行時間(秒)。(整数)
• scm_revision: プロジェクト更新によってフェッチされた最後のリビジョン(文字列)
• last_job_run: (日時)
• last_job_failed: (ブール)
• next_job_run: (日時)
• status: (選択)
  • new: 新規
  • pending: 保留中
  • waiting: 待機中
  • running: 実行中
  • successful: 成功
  • failed: 失敗
  • error: エラー
  • canceled: 取消し済
  • never updated: 更新なし
  • ok: OK
  • missing: 不明
• organization: このテンプレートへのアクセス権を決定するために使用される組織。(id)
• scm_update_on_launch: プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。(ブール)
• scm_update_cache_timeout: 最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。(整数)
• allow_override: このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。(ブール)
• custom_virtualenv: 使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス(文字列)
• default_environment: このプロジェクトを使用して実行されるジョブのデフォルトの実行環境。(id)
• signature_validation_credential: プロジェクト内のファイルに予期しない変更がないかを検証するために使用されるオプションの資格証明。(id)
• last_update_failed: (ブール)
• last_updated: (日時)

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : Project

型: object

ソースを表示

• allow_override: ブール
  タイトル: Allow override

  このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。
• created: 文字列
  タイトル: Created

  読取り専用: true
• credential: 整数
  タイトル: Credential
• custom_virtualenv: 文字列
  タイトル: Custom virtualenv

  読取り専用: true

  最小長: 1

  使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス
• default_environment: 整数
  タイトル: Default environment

  このプロジェクトを使用して実行されるジョブのデフォルトの実行環境。
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• last_job_failed: ブール
  タイトル: Last job failed

  読取り専用: true
• last_job_run: 文字列(日付-時間)
  タイトル: Last job run

  読取り専用: true
• last_update_failed: ブール
  タイトル: Last update failed

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

  読取り専用: true
• local_path: 文字列
  タイトル: Local path

  最大長: 1024

  このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。
• modified: 文字列
  タイトル: Modified

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

  最小長: 1

  最大長: 512
• next_job_run: 文字列(日付-時間)
  タイトル: Next job run

  読取り専用: true
• organization: 整数
  タイトル: Organization

  このテンプレートへのアクセス権を決定するために使用される組織。
• related: 文字列
  タイトル: Related

  読取り専用: true
• scm_branch: 文字列
  タイトル: SCM Branch

  最大長: 256

  チェックアウトする特定のブランチ、タグまたはコミット。
• scm_clean: ブール
  タイトル: Scm clean

  プロジェクトを同期化する前にローカルの変更を破棄します。
• scm_delete_on_update: ブール
  タイトル: Scm delete on update

  同期化する前にプロジェクトを削除します。
• scm_refspec: 文字列
  タイトル: SCM refspec

  最大長: 1024

  gitプロジェクトについて、フェッチする追加のrefspec。
• scm_revision: 文字列
  タイトル: SCM Revision

  読取り専用: true

  最小長: 1

  プロジェクト更新によってフェッチされた最後のリビジョン
• scm_track_submodules: ブール
  タイトル: Scm track submodules

  定義済ブランチにおけるサブモジュールの最新コミットを追跡します。
• scm_type: 文字列
  タイトル: SCM Type

  指定できる値: [ "", "git", "svn", "insights", "archive" ]

  プロジェクトを格納するために使用するソース・コントロール・システムを指定します。
• scm_update_cache_timeout: 整数
  タイトル: Scm update cache timeout

  最小値: 0

  最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。
• scm_update_on_launch: ブール
  タイトル: Scm update on launch

  プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。
• scm_url: 文字列
  タイトル: SCM URL

  最大長: 1024

  プロジェクトが格納される場所。
• signature_validation_credential: 整数
  タイトル: Signature validation credential

  プロジェクト内のファイルに予期しない変更がないかを検証するために使用されるオプションの資格証明。
• status: 文字列
  タイトル: Status

  読取り専用: true

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

  読取り専用: true
• timeout: 整数
  タイトル: Timeout

  タスクが取り消されるまでの実行時間(秒)。
• type: 文字列
  タイトル: Type

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

  読取り専用: true

{
    "properties":{
        "allow_override":{
            "description":"Allow changing the SCM branch or revision in a job template that uses this project.",
            "title":"Allow override",
            "type":"boolean",
            "x-nullable":true
        },
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "credential":{
            "title":"Credential",
            "type":"integer",
            "x-nullable":true
        },
        "custom_virtualenv":{
            "description":"Local absolute file path containing a custom Python virtualenv to use",
            "minLength":"1",
            "readOnly":true,
            "title":"Custom virtualenv",
            "type":"string",
            "x-nullable":true
        },
        "default_environment":{
            "description":"The default execution environment for jobs run using this project.",
            "title":"Default environment",
            "type":"integer",
            "x-nullable":true
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "last_job_failed":{
            "readOnly":true,
            "title":"Last job failed",
            "type":"boolean"
        },
        "last_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last job run",
            "type":"string",
            "x-nullable":true
        },
        "last_update_failed":{
            "readOnly":true,
            "title":"Last update failed",
            "type":"boolean"
        },
        "last_updated":{
            "format":"date-time",
            "readOnly":true,
            "title":"Last updated",
            "type":"string"
        },
        "local_path":{
            "description":"Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project.",
            "maxLength":"1024",
            "title":"Local path",
            "type":"string",
            "x-nullable":true
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "next_job_run":{
            "format":"date-time",
            "readOnly":true,
            "title":"Next job run",
            "type":"string",
            "x-nullable":true
        },
        "organization":{
            "description":"The organization used to determine access to this template.",
            "title":"Organization",
            "type":"integer",
            "x-nullable":true
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "scm_branch":{
            "description":"Specific branch, tag or commit to checkout.",
            "maxLength":"256",
            "title":"SCM Branch",
            "type":"string",
            "x-nullable":true
        },
        "scm_clean":{
            "description":"Discard any local changes before syncing the project.",
            "title":"Scm clean",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_delete_on_update":{
            "description":"Delete the project before syncing.",
            "title":"Scm delete on update",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_refspec":{
            "description":"For git projects, an additional refspec to fetch.",
            "maxLength":"1024",
            "title":"SCM refspec",
            "type":"string",
            "x-nullable":true
        },
        "scm_revision":{
            "description":"The last revision fetched by a project update",
            "minLength":"1",
            "readOnly":true,
            "title":"SCM Revision",
            "type":"string"
        },
        "scm_track_submodules":{
            "description":"Track submodules latest commits on defined branch.",
            "title":"Scm track submodules",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_type":{
            "description":"Specifies the source control system used to store the project.",
            "enum":[
                "",
                "git",
                "svn",
                "insights",
                "archive"
            ],
            "title":"SCM Type",
            "type":"string",
            "x-nullable":true
        },
        "scm_update_cache_timeout":{
            "description":"The number of seconds after the last project update ran that a new project update will be launched as a job dependency.",
            "minimum":"0",
            "title":"Scm update cache timeout",
            "type":"integer"
        },
        "scm_update_on_launch":{
            "description":"Update the project when a job is launched that uses the project.",
            "title":"Scm update on launch",
            "type":"boolean",
            "x-nullable":true
        },
        "scm_url":{
            "description":"The location where the project is stored.",
            "maxLength":"1024",
            "title":"SCM URL",
            "type":"string",
            "x-nullable":true
        },
        "signature_validation_credential":{
            "description":"An optional credential used for validating files in the project against unexpected changes.",
            "title":"Signature validation credential",
            "type":"integer",
            "x-nullable":true
        },
        "status":{
            "enum":[
                "new",
                "pending",
                "waiting",
                "running",
                "successful",
                "failed",
                "error",
                "canceled",
                "never updated",
                "ok",
                "missing"
            ],
            "readOnly":true,
            "title":"Status",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "timeout":{
            "description":"The amount of time (in seconds) to run before the task is canceled.",
            "title":"Timeout",
            "type":"integer"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "required":[
        "name"
    ],
    "type":"object"
}

先頭に戻る