Get Collection API Catalog

get

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

Return API catalog information for the collections resource, including supported services.

• Request
• Response
• Examples

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. Response includes links to supported services.

Examples

The following example returns information for the collections resource.

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

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
  "$schema": "http://json-schema.org/schema#",
  "type": "object",
  "properties": {
  	"childItemsCount": {
      "type": "integer",
      "description": "number of child items"
  	},
  	"count": {
      "type": "integer",
      "description": "number of items"
    },
  	"idList" : {
  	  "type": "string",
  	  "description": "comma seperated list of file Ids"
  	},
  	"hasMore": {
      "type": "string",
      "description": "indicates if all collections were returned; if all the collections were returned this is zero (0)."
    },
  	"offset": {
  	  "type": "integer",
      "description": "point at which to begin the list of items or page of results from the complete set."
  	},
  	"totalOwned": {
  	  "type": "integer",
      "description": "number of collections owned by the user"  	
  	},
	"totalResult": {
  	  "type": "integer",
      "description": "total number of collections"
	},
	"totalShared": {
  	  "type": "integer",
      "description": "number of collections shared with the user"
	},
    "id": {
      "type": "string",
      "description": "collection identifier"
    },
    "name": {
      "type": "string",
      "description": "collection name"
    },
    "type": {
      "type": "String",
      "description": "has value 'collection'"
    },
    "description": {
      "type": "String",
      "description": "collection description"
    },
    "createdTime": {
      "type": "string",
      "description": "collection created time"
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName" : {
          "type": "string",
          "description": "full name of collection creator"
        },
        "id" : {
          "type": "string",
          "description": "ID of collection creator"
        },
        "loginName": {
          "type": "string",
          "description": "login name of collection creator"
        },
        "type" : {
          "type": "string",
          "description": "has value 'user'"
        }
      }
    },
    "modifiedTime": {
      "type": "string",
      "description": "collection last modified time"
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName" : {
          "type": "string",
          "description": "full name of collection last modifier"
        },
        "id" : {
          "type": "string",
          "description": "ID of collection last modifier"
        },
        "loginName": {
          "type": "string",
          "description": "login name of collection last modifier"
        },
        "type" : {
          "type": "string",
          "description": "has value 'user'"
        }
      }
    },
    "ownedBy": {
      "type": "object",
      "properties": {
        "displayName" : {
          "type": "string",
          "description": "full name of collection owner"
        },
        "id" : {
          "type": "string",
          "description": "ID of collection owner"
        },
        "loginName": {
          "type": "string",
          "description": "login name of collection owner"
        },
        "type" : {
          "type": "string",
          "description": "has value 'user'"
        }
      }
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "rest-schemas/link#"
      }
    },
    "required": ["id", "name", "type", "createdTime", "createdBy", "modifiedTime", "modifiedBy", "ownedBy"]
  },
  "links": [
    {
      "rel": "describedBy",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/metadata-catalog/collections"
    },
    {
      "rel": "self",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/metadata-catalog/collections"
    },
    {
      "rel": "list",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/collections/items",
      "method": "GET"
    },
    {
      "rel": "create",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/collections",
      "method": "POST"
    },
    {
      "rel": "delete",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/collections/{id}",
      "method": "DELETE"
    },
    {
      "rel": "add-file",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/collections/{id}/files/{file_id}",
      "method": "POST"
    },
    {
      "rel": "remove-file",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/collections/{id}/files/{file_id}",
      "method": "DELETE"
    },
    {
      "rel": "add-files",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/collections/{id}/files",
      "method": "POST"
    },
    {
      "rel": "remove-files",
      "href": "http://service1-defaulttenant:8080/documents/api/1.1/collections/{id}/files",
      "method": "DELETE"
    }
 ]
}