Oracle Linux Automation Manager CLIおよびAPIリファレンス・ガイド

プロジェクトのリスト

get

/api/v2/projects/

このリソースに対してGETリクエストを行って、プロジェクトのリストを取得します。

結果のデータ構造には次が含まれます。

{
    "count": 99,
    "next": null,
    "previous": null,
    "results": [
        ...
    ]
}

countフィールドは、対象となる問合せで見つかったプロジェクトの合計数を示します。 nextフィールドとpreviousフィールドには、結果が1ページに収まらない場合に、追加の結果へのリンクが表示されます。 resultsリストには、0個以上のプロジェクト・レコードが含まれます。

結果

それぞれのプロジェクトのデータ構造には次のフィールドが含まれます。

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: (日時)

ソート

プロジェクトが特定の順序で返されるように指定するには、GETリクエストでorder_by問合せ文字列パラメータを使用します。

?order_by=name

フィールド名の先頭にダッシュ-を付けると逆の順序でソートされます。

?order_by=-name

フィールド名をカンマ,で区切ると、複数のソート・フィールドを指定できます。

?order_by=name,some_other_field

ページ区切り

リクエストごとに返される結果の数を変更するには、page_size問合せ文字列パラメータを使用します。特定のページの結果を取得するには、page問合せ文字列パラメータを使用します。

?page_size=100&page=2

結果で返されるpreviousリンクおよびnextリンクは、これらの問合せ文字列パラメータを自動的に設定します。

検索

モデルのすべての指定テキスト・フィールド内で大/小文字を区別しない検索を実行するには、search問合せ文字列パラメータを使用します。

?search=findme

(Ansible Tower 3.1.0で追加)関連フィールド全体を検索します。

?related__search=findme

リクエスト

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

application/json

問合せパラメータ

page: integer

ページ区切りが設定された結果セット内のページ番号。
page_size: integer

ページごとに返す結果の数。
search: string

検索条件。

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ : schema

型: object

ソースを表示

count(required): integer
next: string(uri)
previous: string(uri)
results(required): array results

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "next":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "previous":{
            "format":"uri",
            "type":"string",
            "x-nullable":true
        },
        "results":{
            "items":{
                "$ref":"#/definitions/Project"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

Array of: object Project

{
    "items":{
        "$ref":"#/definitions/Project"
    },
    "type":"array"
}

ネストされたスキーマ : プロジェクト

型: 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

タイトル: Related

読取り専用: true
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

{
    "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"
}

先頭に戻る