プロジェクトの更新
put
/api/v2/projects/{id}/
このリソースに対してPUTまたはPATCHリクエストを行って、このプロジェクトを更新します。 次のフィールドを変更できます。
name
: このプロジェクトの名前。(文字列、必須)description
: このプロジェクトのオプションの説明。(文字列、デフォルト=""
)local_path
: このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。(文字列、デフォルト=""
)scm_type
: プロジェクトを格納するために使用するソース・コントロール・システムを指定します。(選択)""
: 手動(デフォルト)git
: Gitsvn
: Subversioninsights
: Red Hat Insightsarchive
: リモート・アーカイブ
scm_url
: プロジェクトが格納される場所。(文字列、デフォルト=""
)scm_branch
: チェックアウトする特定のブランチ、タグまたはコミット。(文字列、デフォルト=""
)scm_refspec
: gitプロジェクトについて、フェッチする追加のrefspec。(文字列、デフォルト=""
)scm_clean
: プロジェクトを同期化する前にローカルの変更を破棄します。(ブール、デフォルト=False
)scm_track_submodules
: 定義済ブランチでのサブ・モジュールの最新のコミットを追跡します。(ブール、デフォルト=False
)scm_delete_on_update
: 同期化する前にプロジェクトを削除します。(ブール、デフォルト=False
)credential
: (id、デフォルト=``)-
timeout
: タスクが取り消されるまでの実行時間(秒)。(整数、デフォルト=0
) -
organization
: このテンプレートへのアクセス権を決定するために使用される組織。(id、デフォルト=``) scm_update_on_launch
: プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。(ブール、デフォルト=False
)scm_update_cache_timeout
: 最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。(整数、デフォルト=0
)-
allow_override
: このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。(ブール、デフォルト=False
) -
default_environment
: このプロジェクトを使用して実行されるジョブのデフォルト実行環境。(id、デフォルト=``) signature_validation_credential
: 予期しない変更に対するプロジェクト内のファイルの検証に使用されるオプションの資格証明。(id、デフォルト=``)
PUTリクエストの場合は、リクエストにすべてのフィールドを含めます。
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
ルート・スキーマ : プロジェクト
型:
ソースを表示
object
- allow_override: boolean
タイトル:
Allow override
このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。 - created: string
タイトル:
Created
読取り専用:true
- credential: integer
タイトル:
Credential
- custom_virtualenv: string
タイトル:
Custom virtualenv
読取り専用:true
最小長:1
使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス - default_environment: integer
タイトル:
Default environment
このプロジェクトを使用して実行されるジョブのデフォルト実行環境。 - description: string
タイトル:
Description
- id: integer
タイトル:
ID
読取り専用:true
- last_job_failed: boolean
タイトル:
Last job failed
読取り専用:true
- last_job_run: string(date-time)
タイトル:
Last job run
読取り専用:true
- last_update_failed: boolean
タイトル:
Last update failed
読取り専用:true
- last_updated: string(date-time)
タイトル:
Last updated
読取り専用:true
- local_path: string
タイトル:
Local path
最大長:1024
このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。 - modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_job_run: string(date-time)
タイトル:
Next job run
読取り専用:true
- organization: integer
タイトル:
Organization
このテンプレートへのアクセス権を決定するために使用される組織。 - related: string
- scm_branch: string
タイトル:
SCM Branch
最大長:256
チェックアウトする特定のブランチ、タグまたはコミット。 - scm_clean: boolean
タイトル:
Scm clean
プロジェクトを同期化する前にローカルの変更を破棄します。 - scm_delete_on_update: boolean
タイトル:
Scm delete on update
同期化する前にプロジェクトを削除します。 - scm_refspec: string
タイトル:
SCM refspec
最大長:1024
gitプロジェクトについて、フェッチする追加のrefspec。 - scm_revision: string
タイトル:
SCM Revision
読取り専用:true
最小長:1
プロジェクト更新によってフェッチされた最後のリビジョン - scm_track_submodules: boolean
タイトル:
Scm track submodules
定義済ブランチの最新のコミットを追跡します。 - scm_type: string
タイトル:
SCM Type
指定できる値:[ "", "git", "svn", "insights", "archive" ]
プロジェクトを格納するために使用するソース・コントロール・システムを指定します。 - scm_update_cache_timeout: integer
タイトル:
Scm update cache timeout
最小値:0
最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。 - scm_update_on_launch: boolean
タイトル:
Scm update on launch
プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。 - scm_url: string
タイトル:
SCM URL
最大長:1024
プロジェクトが格納される場所。 - signature_validation_credential: integer
タイトル:
Signature validation credential
予期しない変更に対するプロジェクト内のファイルの検証に使用されるオプションの資格証明。 - status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- timeout: integer
タイトル:
Timeout
タスクが取り消されるまでの実行時間(秒)。 - type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ルート・スキーマ : プロジェクト
型:
ソースを表示
object
- allow_override: boolean
タイトル:
Allow override
このプロジェクトを使用するジョブ・テンプレートでSCMブランチまたはリビジョンの変更を許可します。 - created: string
タイトル:
Created
読取り専用:true
- credential: integer
タイトル:
Credential
- custom_virtualenv: string
タイトル:
Custom virtualenv
読取り専用:true
最小長:1
使用するカスタムPython virtualenvを含むローカルの絶対ファイル・パス - default_environment: integer
タイトル:
Default environment
このプロジェクトを使用して実行されるジョブのデフォルト実行環境。 - description: string
タイトル:
Description
- id: integer
タイトル:
ID
読取り専用:true
- last_job_failed: boolean
タイトル:
Last job failed
読取り専用:true
- last_job_run: string(date-time)
タイトル:
Last job run
読取り専用:true
- last_update_failed: boolean
タイトル:
Last update failed
読取り専用:true
- last_updated: string(date-time)
タイトル:
Last updated
読取り専用:true
- local_path: string
タイトル:
Local path
最大長:1024
このプロジェクトのプレイブックおよび関連ファイルを含む(PROJECTS_ROOTに対して相対的な)ローカル・パス。 - modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- next_job_run: string(date-time)
タイトル:
Next job run
読取り専用:true
- organization: integer
タイトル:
Organization
このテンプレートへのアクセス権を決定するために使用される組織。 - related: string
- scm_branch: string
タイトル:
SCM Branch
最大長:256
チェックアウトする特定のブランチ、タグまたはコミット。 - scm_clean: boolean
タイトル:
Scm clean
プロジェクトを同期化する前にローカルの変更を破棄します。 - scm_delete_on_update: boolean
タイトル:
Scm delete on update
同期化する前にプロジェクトを削除します。 - scm_refspec: string
タイトル:
SCM refspec
最大長:1024
gitプロジェクトについて、フェッチする追加のrefspec。 - scm_revision: string
タイトル:
SCM Revision
読取り専用:true
最小長:1
プロジェクト更新によってフェッチされた最後のリビジョン - scm_track_submodules: boolean
タイトル:
Scm track submodules
定義済ブランチの最新のコミットを追跡します。 - scm_type: string
タイトル:
SCM Type
指定できる値:[ "", "git", "svn", "insights", "archive" ]
プロジェクトを格納するために使用するソース・コントロール・システムを指定します。 - scm_update_cache_timeout: integer
タイトル:
Scm update cache timeout
最小値:0
最後のプロジェクト更新が実行された何秒後に、新しいプロジェクト更新がジョブの依存関係として起動されるか。 - scm_update_on_launch: boolean
タイトル:
Scm update on launch
プロジェクトを使用するジョブが起動されたときにプロジェクトを更新します。 - scm_url: string
タイトル:
SCM URL
最大長:1024
プロジェクトが格納される場所。 - signature_validation_credential: integer
タイトル:
Signature validation credential
予期しない変更に対するプロジェクト内のファイルの検証に使用されるオプションの資格証明。 - status: string
タイトル:
Status
読取り専用:true
指定できる値:[ "new", "pending", "waiting", "running", "successful", "failed", "error", "canceled", "never updated", "ok", "missing" ]
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- timeout: integer
タイトル:
Timeout
タスクが取り消されるまでの実行時間(秒)。 - type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true