機械翻訳について

移動先

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

ユーザーのロールのリスト

get

/api/v2/users/{id}/roles/

このリソースに対してGETリクエストを行って、選択したユーザーに関連付けられたロールのリストを取得します。

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

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

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

結果

それぞれのロール・データ構造には次のフィールドが含まれます。

• id: このロールのデータベースID。(整数)
• type: このロールのデータ型。(選択)
• url: このロールのURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。 一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• name: このロールの名前。(フィールド)
• description: このロールのオプションの説明。(フィールド)

ソート

ロールが特定の順序で返されるように指定するには、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

パス・パラメータ

• id(required): string

問合せパラメータ

• 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/RoleSerializerWithParentAccess"
            },
            "type":"array"
        }
    },
    "required":[
        "count",
        "results"
    ],
    "type":"object"
}

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

型: array

ソースを表示

• Array of: object RoleSerializerWithParentAccess

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

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

型: object

ソースを表示

• description: string
  タイトル: Description

  読取り専用: true
• id: integer
  タイトル: ID

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

  読取り専用: true
• related: string
  タイトル: Related

  読取り専用: true
• summary_fields: string
  タイトル: Summary fields

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

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

  読取り専用: true

{
    "properties":{
        "description":{
            "readOnly":true,
            "title":"Description",
            "type":"string"
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "name":{
            "readOnly":true,
            "title":"Name",
            "type":"string"
        },
        "related":{
            "readOnly":true,
            "title":"Related",
            "type":"string"
        },
        "summary_fields":{
            "readOnly":true,
            "title":"Summary fields",
            "type":"string"
        },
        "type":{
            "readOnly":true,
            "title":"Type",
            "type":"string"
        },
        "url":{
            "readOnly":true,
            "title":"Url",
            "type":"string"
        }
    },
    "type":"object"
}

先頭に戻る