Jump to

• Request
• Response
• Examples

Update Contents of a Content Library Document

post

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

Request

Path Parameters

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

Body ()

Request 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

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 update the contents 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" : "/contentlibrary/abn/wsrest_cl.htm",
       "content": "test documentersasefgwdfgsdfg"
    }

	

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/wsrest_cl.htm",
   "content": null,
   "links":    [
      {
         "rel": "self",
         "href": "/rest/api/v1.3/clDocs/contentlibrary/abn/wsrest_cl.htm",
         "method": "POST"
      },
      {
         "rel": "getDocumentContent",
         "href": "/rest/api/v1.3/clDocs/contentlibrary/abn/wsrest_cl.htm",
         "method": "GET"
      },
      {
         "rel": "deleteDocument",
         "href": "/rest/api/v1.3/clDocs/contentlibrary/abn/wsrest_cl.htm",
         "method": "DELETE"
      },
      {
         "rel": "createDocument",
         "href": "/rest/api/v1.3/clDocs",
         "method": "POST"
      }
   ]
}

	

Sample Response: Failure

    {
   "type": "",
   "title": "Invalid request parameters",
   "errorCode": "INVALID_PARAMETER",
   "detail": "Document Path in the URI does not match Document Path in the request payload",
   "errorDetails": []
}



     

Back to Top