Skip to main content

 Web service API

How to use PageSeeder's Web service API

edit psml property

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

com.pageseeder.psml.EditProperty

Description

Edit a property found in a fragment of the URI provided.

The fragment can be specified using the parameter fragment. If it is not present, the parameter oldvalue must be specified as it is used to retrieve the fragment from the content.

If the parameters fragment and oldvalue are both specified, only the properties in that fragment and matching the old value specified are edited.

Only the first fragment containing the property found (if not specified) is modified but all the occurrences of the properties matching the parameters provided are edited in that fragment.

This service cannot be used for properties with datatype="[markup|xref|link]" or multiple="true".

Parameters

NameDescriptionRequiredTypeDefault value
nameThe name of the property to edityesstring
newvalueThe new value for the property (XML markup is treated as text)yesstring
fragmentThe fragment ID to edit (required if oldvalue is not specified). Using default edits metadata propertiesmaybestring
oldvalueThe old value of the property (required if fragment is not specified)maybestring

Permission

This service requires contributor or higher.

Response

The XML output follows this format:

<property-modification fragment="123" uriid="456">
  <property name="mylabel" value="my new value" />
</property-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