edit psml inlinelabel
/members/{member}/groups/{group}/uris/{uri}/editinlinelabel [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
4.9000 | 5.9800 | xml |
Description
Edit an inline label found in a fragment of the URI provided.
The fragment can be specified using the parameter fragment
. If it is not present, the parameter oldcontent
must be specified as it is used to retrieve the fragment from the content.
If the parameters fragment
and oldcontent
are both specified, only the inline labels containing the content specified are edited.
Only the first fragment containing the inline label found (if not specified) is modified, but all the occurrences of the inline label matching the parameters provided are edited in that fragment.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
label | The name of the label to edit | yes | string | |
newcontent | The new content for the label (XML markup is treated as text) | yes | string | |
fragment | The fragment ID to edit (required if oldcontent is not specified) | maybe | string | |
oldcontent | The old content of the label (required if fragment is not specified) | maybe | string |
Permission
This service requires contributor or higher.
Response
The XML output follows this format:
<label-modification fragment="123" uriid="456"> <inline label="mylabel">my new value</inline> </label-modification>
Error Handling
Code | Cause / Description |
---|---|
0x1206 | Invalid media type |
0x120B | Error processing XRefs |
0x120C | Error creating fragment |
0x120D | Content validation error |
0x1218 | Fragment not found with specified content |