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 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.

Note

This service cannot be used to edit properties with @count larger than 1, e.g. count="n"

Parameters

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

Permission

The member must have the permission to edit the document from that group.

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
0x1206 Invalid media type
0x120B Error processing XRefs
0x120C Error creating fragment
0x120D Content validation error
0x1218 Fragment not found with specified content

Created on , last edited on