REST API for Content Management 1.1

Get Applink API Catalog

get

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

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

Examples

The following example returns information for the applinks resource.

GET .../API/1.1/metadata-catalog/applinks

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "file or folder identifier"
    },
    "type": {
      "type": "String",
      "description": "has value 'applink'"
    },
    "accessToken": {
      "type": "String",
      "description": "token needed to access the appLink"
    },
    "refreshToken": {
      "type": "String",
      "description": "token needed to refresh an expired accessToken"
    },
    "appLinkID": {
      "type": "string",
      "description": "appLink identifier"
    },
    "appLinkUrl": {
      "type": "string",
      "description": "URL used to access the appLink"
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "rest-schemas/link#"
      }
    },
    "required": ["id", "type", "accessToken", "refreshToken", "appLinkID", "appLinkUrl"]
  },
  "links": [
    {
      "rel": "describedBy",
      "href": "http://service1-tenant2.local:8080/documents/api/1.1/metadata-catalog/applinks"
    },
    {
      "rel": "self",
      "href": "http://service1-tenant2.local:8080/documents/api/1.1/metadata-catalog/applinks",
      "method": "GET"
    },
    {
      "rel": "create-folder-applink",
      "href": "http://service1-tenant2.local:8080/documents/api/1.1/applinks/folder/{id}",
      "method": "POST"
    },
    {
      "rel": "create-file-applink",
      "href": "http://service1-tenant2.local:8080/documents/api/1.1/applinks/file/{id}",
      "method": "POST"
    },
    {
      "rel": "refresh-applink-token",
      "href": "http://service1-tenant2.local:8080/documents/api/1.1/applinks/token",
      "method": "PUT"
    }
  ]
}