機械翻訳について

ジャンプ先

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

割り当てられたすべてのユーザー・キー値を取得

get

/km/api/v1/users/{id}/customKeyValues

このメソッドは、指定されたIDパラメータを持つユーザー・オブジェクトに関連付けられたUserKeyValueオブジェクトのリストを返します。

このリソースは、orderByリクエスト・パラメータをサポートしています。 このパラメータをHTTPサービス・リクエストとともに使用して、返されたリストをソートできます。

orderByパラメータでは、次の値を使用できます:

• dateAdded
• dateModified
• key
• recordId
• value

URIの例:

このメソッドのURIの例を次に示します:

• http://<IM_REST_API_HOST>/km/api/latest/users/{id}/customKeyValues

  このメソッドは、指定されたIDパラメータを持つユーザー・オブジェクトに関連付けられたUserKeyValueオブジェクトのリストを昇順で追加された日付でソートして返します。

• http://<IM_REST_API_HOST>/km/api/latest/users/{id}/customKeyValues?orderBy=dateAdded:desc

  このメソッドは、指定されたIDパラメータを持つユーザー・オブジェクトに関連付けられたUserKeyValueオブジェクトのリストを、日付の降順で追加された日付でソートして返します。

リクエスト

パス・パラメータ

• id: string
  ユーザー・オブジェクトの一意の識別子

トップに戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

「OK」をクリックします。

本文( )

ルート・スキーマ : ResultList UserKeyValueKey

タイプ: object

タイトル: ResultList UserKeyValueKey

ソースを表示

• count(optional): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(optional): boolean
  サーバーで使用可能なリソースが現在のページで返されたサブセットよりも多い場合にtrueに設定されるブール値。
• items(optional): array items
• limit(optional): integer
  サーバーが使用する実際のページング・サイズ。
• links(optional): array links
• offset(optional): integer
  現在のページで使用される相殺値。
• totalResults(optional): integer
  現在の範囲内のインスタンスと、リクエストを満たすサーバー上のインスタンスの両方を含む、リソース・インスタンスの合計数。

{
    "title":"ResultList UserKeyValueKey",
    "properties":{
        "hasMore":{
            "description":"Boolean value that is set to true if more resources are available on the server than the subset returned in current page.",
            "type":"boolean"
        },
        "limit":{
            "description":"Actual paging size used by the server.",
            "type":"integer"
        },
        "count":{
            "description":"Number of resource instances returned in the current range.",
            "type":"integer"
        },
        "totalResults":{
            "description":"Total count of the resource instances, including both the instances in the current range and the instances on the server that satisfy the request.",
            "type":"integer"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/UserKeyValueKey"
            },
            "type":"array"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "offset":{
            "description":"Offset value used in the current page. ",
            "type":"integer"
        }
    },
    "type":"object"
}

ネストされたスキーマ : アイテム

タイプ: array

ソースを表示

• Array of: object UserKeyValueKey
  タイトル: UserKeyValueKey

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

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

• Array of: object instanceLink
  JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

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

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

タイプ: object

タイトル: UserKeyValueKey

ソースを表示

• links(optional): array links
• recordId(optional): string
  userKeyValueリソースを表す一意の識別子。

{
    "title":"UserKeyValueKey",
    "properties":{
        "recordId":{
            "description":"The unique identifier that represents a userKeyValue resource.",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

• Array of: object instanceLink
  JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

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

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

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

• href: string
  URI [RFC3986]またはURIテンプレート[RFC6570]。 値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
• mediaType(optional): string
  RFC 2046で定義された、リンク・ターゲットを説明するメディア・タイプ。
• method(optional): string
  リンクのターゲットをリクエストするためのHTTPメソッド。
• profile(optional): string
  ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
• rel: string
  リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。 たとえば、hrefやprofileです。
• templated(optional): boolean
  hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。 プロパティがURIテンプレートの場合は、この値をtrueに設定します。 デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定されたIDパラメータを持つユーザー・オブジェクトに関連付けられているすべてのユーザー・キー値オブジェクトを検索する方法を示しています。

cURLコマンドの例

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/users/{id}/customKeyValues" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "items": [
    {
      "recordId": "5E9251D2AE454BE88BB7534A5256B067",
      "links": [
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues/5E9251D2AE454BE88BB7534A5256B067",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    },
    {
      "recordId": "75F56044C4D94DC181CDA898D0F0B3E2",
      "links": [
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues/75F56044C4D94DC181CDA898D0F0B3E2",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        },
        {
          "rel": "collection",
          "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/userKeyValues",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    }
  ],
  "hasMore": false,
  "limit": 20,
  "offset": 0,
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/users/62AE91CBB23A49668BC7B9A220B696C7/customKeyValues/?limit=20&offset=0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    }
  ],
  "count": 2
}

「トップに戻る」