移動先

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

グループの取得

get

/api/v2/groups/{id}/

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

• id: このグループのデータベースID。(整数)
• type: このグループのデータ型。(選択)
• url: このグループのURL。(文字列)
• related: 関連リソースのURLを含むデータ構造。(オブジェクト)
• summary_fields: 関連リソースの名前/説明を含むデータ構造。一部のオブジェクトの出力は、パフォーマンス上の理由によって制限される場合があります。(オブジェクト)
• created: このグループが作成されたときのタイムスタンプ。(日時)
• modified: このグループが最後に変更されたときのタイムスタンプ。(日時)
• name: このグループの名前。(文字列)
• description: このグループのオプションの説明。(文字列)
• inventory: (id)
• variables: JSONまたはYAML形式のグループ変数。(json)

リクエスト

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

• application/json

パス・パラメータ

• id(必須): 文字列

先頭に戻る

レスポンス

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

• application/json

200レスポンス

本文()

ルート・スキーマ : Group

型: object

ソースを表示

• created: 文字列
  タイトル: Created

  読取り専用: true
• description: 文字列
  タイトル: Description
• id: 整数
  タイトル: ID

  読取り専用: true
• inventory(必須): 整数
  タイトル: Inventory
• modified: 文字列
  タイトル: Modified

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

  最小長: 1

  最大長: 512
• related: 文字列
  タイトル: Related

  読取り専用: true
• summary_fields: 文字列
  タイトル: Summary fields

  読取り専用: true
• type: 文字列
  タイトル: Type

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

  読取り専用: true
• variables: 文字列
  タイトル: Variables

  JSONまたはYAML形式のグループ変数。

{
    "properties":{
        "created":{
            "readOnly":true,
            "title":"Created",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "type":"string",
            "x-nullable":true
        },
        "id":{
            "readOnly":true,
            "title":"ID",
            "type":"integer"
        },
        "inventory":{
            "title":"Inventory",
            "type":"integer"
        },
        "modified":{
            "readOnly":true,
            "title":"Modified",
            "type":"string"
        },
        "name":{
            "maxLength":"512",
            "minLength":"1",
            "title":"Name",
            "type":"string",
            "x-nullable":true
        },
        "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"
        },
        "variables":{
            "description":"Group variables in JSON or YAML format.",
            "title":"Variables",
            "type":"string",
            "x-nullable":true
        }
    },
    "required":[
        "name",
        "inventory"
    ],
    "type":"object"
}

先頭に戻る