Update Document Set Metadata Properties

Submits a request to update (and replace) the metadata properties for a specific Document Set entity in the Server.

Request takes a JSON Name/Value List as content (the Document Set ID and the new metadata properties), and on success returns a response containing the result of the request for update/replacement (“true”).

Type: PUT
URI: /rest/serverengine/entity/documentsets/{documentSetId}/metadata
Parameters:

Path:

  • documentSetId – the ID of the Document Set entity in Server
Request:
Add. Headers: auth_token – Authorization Token (if server security settings enabled)
Content: JSON Name/Value List of metadata properties for Document Set
Content Type: application/json
Response:
Add. Headers: –
Content: Result of request to update Document Set
Content Type: text/plain
Status:
  • 200 OK – Update of Document Set metadata properties successfully requested (response of “true” for success)
  • 401 Unauthorized – Server authentication required
  • 403 Forbidden – Server authentication has failed or expired
  • 500 Internal Server Error – Server error or Document Set ID mismatch in JSON