機械翻訳について
  1. ドキュメント用REST API
  2. タスク
  3. カタログ

ユーザーAPIカタログの取得

get

/documents/api/{version}/metadata-catalog/users

サポートされているサービスを含む、ユーザー・リソースのメタデータ情報を返します。

リクエスト

サポートされるメディア・タイプ
パス・パラメータ
トップに戻る

レスポンス

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

200レスポンス

リクエストが処理されました。 サポートされるサービスへのリンクを含むユーザー・メタデータ。
トップに戻る

例

次の例では、ユーザー・リソースの情報が返されます。

GET .../api/1.2/metadata-catalog/users

リクエスト・ヘッダー

なし。

リクエスト本文

なし。

HTTPステータス・コード

HTTP_STATUS = 200

JSONレスポンス

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "number of user items"
    },
    "items": {
      "type": "array",
      "description": "list of users",
      "items": {
        "type": {
          "type": "String",
          "description": "has value 'user'"
        },
        "id": {
          "type": "string",
          "description": "item user identifier"
        },
        "displayName": {
          "type": "string",
          "description": "user diplay name"
        },
        "loginName": {
          "type": "string",
          "description": "user login name"
        }
      }
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "rest-schemas/link#"
      }
    },
    "required": ["count"]
  },
  "links": [
    {
      "rel": "describedBy",
      "href": "http://service1-defaulttenant:8080/documents/api/1.2/metadata-catalog/users"
    },
    {
      "rel": "self",
      "href": "http://service1-defaulttenant:8080/documents/api/1.2/metadata-catalog/users",
      "method": "GET"
    },
    {
      "rel": "suggestions",
      "href": "http://service1-defaulttenant:8080/documents/api/1.2/users/items",
      "method": "GET"
    },
    {
      "rel": "search",
      "href": "http://service1-defaulttenant:8080/documents/api/1.2/users/search/items",
      "method": "GET"
    }
  ]
}
先頭に戻る