Get Public Links API Catalog
get
/documents/api/{version}/metadata-catalog/publiclinks
Return metadata information for the publiclinks resource, including supported services.
Request
Supported Media Types
- application/json
- application/xml
Path Parameters
-
version: string
Version value
Response
Supported Media Types
- application/json
- application/xml
200 Response
The request was fulfilled. Public link metadata includes links to supported services.
Examples
The following example returns information for the public link resource.
GET .../api/1.2/metadata-catalog/publiclinks
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 'publiclink'"
},
"assignedUsers": {
"type": "String",
"description": "list of users or groups that can access this link"
},
"createdDate": {
"type": "string",
"description": "public link creation time"
},
"lastModifiedDate": {
"type": "string",
"description": "public link last modified time"
},
"expirationDate": {
"type": "string",
"description": "public link expiration time"
},
"linkID": {
"type": "string",
"description": "public link identifier"
},
"linkName": {
"type": "string",
"description": "public link name"
},
"ownedBy": {
"type": "object",
"properties": {
"displayName" : {
"type": "string",
"description": "full name of file owner"
},
"id" : {
"type": "string",
"description": "ID of file owner"
},
"loginName": {
"type": "string",
"description": "login name of file owner"
},
"type" : {
"type": "string",
"description": "has value 'user'"
}
}
},
"role": {
"type": "string",
"description": "indicate the role allowed for the user of the public link"
},
"links": {
"type": "array",
"items": {
"$ref": "rest-schemas/link#"
}
},
"required": ["id", "type", "assignedUsers", "createdDate", "lastModifiedDate", "linkID", "linkName", "ownedBy", "role"]
},
"links": [
{
"rel": "describedBy",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/metadata-catalog/publiclinks"
},
{
"rel": "self",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/metadata-catalog/publiclinks",
"method": "GET"
},
{
"rel": "create-folder-publiclink",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/publiclinks/folder/{id}",
"method": "POST"
},
{
"rel": "create-file-publiclink",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/publiclinks/file/{id}",
"method": "POST"
},
{
"rel": "get-folder-publiclinks",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/publiclinks/folder/{id}",
"method": "GET"
},
{
"rel": "get-file-publiclinks",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/publiclinks/file/{id}",
"method": "GET"
},
{
"rel": "get-publiclink-info",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/publiclinks/{linkID}",
"method": "GET"
},
{
"rel": "edit-publiclink",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/publiclinks/{linkID}",
"method": "PUT"
},
{
"rel": "delete-publiclink",
"href": "http://service1-defaulttenant:8080/documents/api/1.2/publiclinks/{linkID}",
"method": "DELETE"
}
]
}