Jump to

• Request
• Response
• Examples

Create a copy of a Content Library Document.

put

/rest/api/v1.3/clDocs/{docPath}

Request

Path Parameters

• docPath: string
  Destination Document Path

Body ()

Request Body

Root Schema : copy content document Request

Type: object

Title: copy content document Request

Show Source

• documentPath(optional): string
  Path of source Document

{
    "type":"object",
    "title":"copy content document Request",
    "properties":{
        "documentPath":{
            "description":"Path of source Document",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Content Library Documents

Type: object

Title: Content Library Documents

Show Source

• content: string
  Document content.
• docPath: string
  The complete path of the document starting with '/contentlibrary'.

{
    "title":"Content Library Documents",
    "type":"object",
    "properties":{
        "docPath":{
            "description":"The complete path of the document starting with '/contentlibrary'.",
            "type":"string"
        },
        "content":{
            "description":"Document content.",
            "type":"string"
        }
    },
    "required":[
        "docPath",
        "content"
    ]
}

Back to Top

Examples

This interface is used to create a copy of a content library document.

A successful request requires the following headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Content-Type	application/json

Sample Request Body:

	{
"documentPath": <sourceDocumentPath>
}

Sample Response: Success

Note: The "content" attribute in the response is returned as null always. This is done to avoid returning large contents in the response.

 "documentPath": "/contentlibrary/abn/doc22.htm",
"content": null,
"links": [
{
"rel": "self",
"href": "/rest/api/v1.3/clDocs/contentlibrary/abn/doc22.htm",
"method": "PUT"
},
{
"rel": "getDocumentContent",
"href": "/rest/api/v1.3/clDocs/contentlibrary/abn/doc22.htm",
"method": "GET"
},
{
"rel": "deleteDocument",
"href": "/rest/api/v1.3/clDocs/contentlibrary/abn/doc22.htm",
"method": "DELETE"
}
]
}
	

Sample Response: Failure - Document Not Found

The system sends the following response when it cannot find the source folder or file or the destination folder:

{
	"type": "",
	"title": "Document not found",
	"errorCode": "DOCUMENT_NOT_FOUND",
	"detail": "Document not found:/contentlibrary/abn/wsrest_cl.htm",
	"errorDetails": []
}

Back to Top