REST API for Content Management 1.1

Get User API Catalog

get

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

Return metadata information for the users resource, including supported services.

Request

Supported Media Types

application/json
application/xml

Path Parameters

version: Type: string

Required: true

Version value

Response

Supported Media Types

application/json
application/xml

200 Response

The request was fulfilled. User metadata includes links to supported services.

Examples

The following example returns information for the users resource.

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

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "$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.1/metadata-catalog/users"
    },
    {
      "rel": "self",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/metadata-catalog/users",
      "method": "GET"
    },
    {
      "rel": "suggestions",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/users/items",
      "method": "GET"
    },
    {
      "rel": "search",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/users/search/items",
      "method": "GET"
    }
  ]
}