ワークフロー・ジョブ・ノードのラベルのリスト
get
/api/v2/workflow_job_nodes/{id}/labels/
このリソースに対してGETリクエストを行って、選択したワークフロー・ジョブ・ノードに関連付けられたラベルのリストを取得します。
結果のデータ構造には次のものが含まれます:
{
"count": 99,
"next": null,
"previous": null,
"results": [
...
]
}
count
フィールドは、特定の問合せに対して見つかったラベルの合計数を示します。 next
フィールドとprevious
フィールドには、単一ページに収まる以上の結果へのリンクが表示されます。 results
リストには、0個以上のラベル・レコードが含まれます。
結果
各ラベル・データ構造には次のフィールドが含まれます:
id
: このラベルのデータベースID。(integer)type
: このラベルのデータ型。(choice)url
: このラベルのURL。(string)related
: 関連リソースのURLを持つデータ構造。(オブジェクト)summary_fields
: 関連リソースの名前/説明を持つデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)created
: このラベルが作成されたときのタイムスタンプ。(datetime)modified
: このラベルが最後に変更されたときのタイムスタンプ。(datetime)name
: このラベルの名前。(string)organization
: このラベルが属する組織。(id)
ソート
ラベルが特定の順序で返されることを指定するには、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タワー3.1.0で追加」)関連フィールド全体を検索します:
?related__search=findme
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
問合せパラメータ
- page: integer
ページ区切り結果セット内のページ番号。
- page_size: integer
ページ当たりに返す結果の数。
- search: string
検索条件。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
ネストされたスキーマ : ラベル
型:
ソースを表示
object
- created: string
タイトル:
Created
読取り専用:true
- id: integer
タイトル:
ID
読取り専用:true
- modified: string
タイトル:
Modified
読取り専用:true
- name(required): string
タイトル:
Name
最小長:1
最大長:512
- organization(required): integer
タイトル:
Organization
このラベルが属する組織。 - related: string
- summary_fields: string
タイトル:
Summary fields
読取り専用:true
- type: string
タイトル:
Type
読取り専用:true
- url: string
タイトル:
Url
読取り専用:true