uri
/members/{member}/groups/{group}/uris/{uri} [PATCH]
API Support | Available since | Last updated | Output |
---|---|---|---|
4.9500 | 5.9600 | xml, json |
Description
Sets the URI Properties.
Saves the core properties of a URI.
Only the parameters which are specified are taken into account.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
description | The new description | no | string | |
documentid | The new document ID | no | string | |
labels | A comma-separated list of label values, use empty string to clear the existing labels | no | labels | |
name | The new name. If the URI is a folder, a thread is launched | no | string | |
publicationid | The new publication ID (makes this URI the root document of the publication) | no | publicationid | |
publicationtype | The type of the publication (requires publicationid ) | no | publicationtype | |
title | The new title | no | string |
Permission
This service requires contributor or higher.
Response
The output has the following format:
<uri-modification> <uri id="[id]" path="[path]" ...> <displaytitle>[title]</displaytitle> </uri> </uri-modification>
Error Handling
Code | Cause / Description |
---|---|
0x1209 | The documentid already exists |
0x120A | The documentid contains invalid characters |
0x122E | The labels parameter is invalid |