Web service API

How to use PageSeeder's Web service API

uri fragment

/members/{member}/groups/{group}/uris/{uri}/fragments/{+fragment} [PUT]

com.pageseeder.psml.PutFragment

Description

Fragment's Content

Create new edit on fragment provided.

Note

The new content of the fragment should be in the enclosed entity body of the request.

Parameters

NameDescriptionRequiredTypeDefault value
contentnew fragment content. DEPRECATED use enclosed entity body of the request.maybestring
draftA flag to save edit as a draftnobooleanfalse
htmlA flag to specify if content is HTMLnobooleanfalse
labelsThe labels for the editnolabels
lastmodifiedThe last modified date/time (ISO 8601) of the fragment (prevents edit clashes)nodate
notecontent for edit notes (if exists creates a note)nostring
note-labelsComma separated list of labels for the note (if exists creates a note)nolabelsfalse
note-notifythe note notification behavior [normal|announce|silent]noenumsilent
note-titletitle for edit notenostringEdit Note
notify-asyncWhether to send emails asynchronously (for slow email servers).nobooleanfalse
positionThe position (instance number) of this document in the publication (requires publicationid)nointeger1
publicationidThe ID of the publication context for this document to return numbering (requires transclude=true).nopublicationid
tidyflag to perform Tidy on HTML contentnobooleantrue
transcludeA flag to resolve transclusions when outputting resultnobooleanfalse

 

Permission

Undocumented permissions requirements.

Response

When successful, the new fragment is returned as a <document-fragment> wrapped in a <fragment-creation> element with the following optional attributes:

  • notification-email-delayed="true": if the edit note notification has been queued due to large number of recipients.
  • notification-email-failed="true": if the edit note notification could not be sent.
  • unresolved-xrefs="true": if their are unresolved cross references in the fragment.

Example:


<fragment-creation notification-email-failed="true">
  <document-fragment>
    <locator id="325" fragment="example" editid="6340" modified="2015-03-24T13:21:57">
      <notes>
        <note id="6342" modified="2015-03-24T13:21:57" title="Typography">
          <content>Fixed typographical error.</content>
        </note>
      </notes>
    </locator>
    <fragment id="example">
      <para>This is the fragment content</para>
    </fragment>
  </document-fragment>
</fragment-creation>

Error Handling

CodeCause / Description
0x120B Error processing XRefs
0x120C Error creating fragment
0x120D Content validation error
0x120E lastmodified date is invalid
0x120F Someone has modified the fragment while you were editing

Created on , last edited on