Skip to main content

 Web service API

How to use PageSeeder's Web service API

edit psml inlinelabel

/members/{member}/groups/{group}/uris/{uri}/editinlinelabel [POST]

com.pageseeder.psml.EditInlineLabel

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

NameDescriptionRequiredTypeDefault value
labelThe name of the label to edityesstring
newcontentThe new content for the label (XML markup is treated as text)yesstring
fragmentThe fragment ID to edit (required if oldcontent is not specified)maybestring
oldcontentThe old content of the label (required if fragment is not specified)maybestring

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

CodeCause / Description
0x1206Invalid media type
0x120BError processing XRefs
0x120CError creating fragment
0x120DContent validation error
0x1218Fragment not found with specified content
Created on , last edited on