REST API for Content Management 1.1

Get Share API Catalog

get

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

Return metadata information for the shares 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. Share metadata includes links to supported services.

Examples

The following example returns information for the shares resource.

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

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"
    },
    "id": {
      "type": "string",
      "description": "folder identifier"
    },
    "type": {
      "type": "String",
      "description": "has value 'share'"
    },
    "items": {
      "type": "array",
      "description": "list of users",
      "items": {
        "type": {
          "type": "String",
          "description": "indicate item is a share"
        },
        "user": {
          "type": "object",
          "properties": {
            "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"
	        }
          }
        },
        "role": {
          "type": "string",
          "description": "indicate the role of the shared user"
        }
      }
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "rest-schemas/link#"
      }
    },
    "required": ["count", "id", "type"]
  },
  "links": [
    {
      "rel": "describedBy",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/metadata-catalog/shares"
    },
    {
      "rel": "self",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/metadata-catalog/shares",
      "method": "GET"
    },
    {
      "rel": "add-shared-user",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/shares/{id}",
      "method": "POST"
    },
    {
      "rel": "remove-share",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/shares/{id}",
      "method": "DELETE"
    },
    {
      "rel": "list-shared-users",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/shares/{id}/items",
      "method": "GET"
    },
    {
      "rel": "modify-role",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/shares/{id}/role",
      "method": "PUT"
    },
    {
      "rel": "delete-user",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/shares/{id}/user",
      "method": "DELETE"
    },
    {
      "rel": "delete-myuser",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/shares/{id}/myuser",
      "method": "DELETE"
    }
  ]
}