Skip to main content

 Web service API

How to use PageSeeder's Web service API

create psml

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

com.pageseeder.psml.CreateDocument

Description

Create a PSML document.

This service is obsolete, use Service: /members/{member}/groups/{group}/documents [POST] instead.

Create a new PSML document.

Processes request for creating a new PSML document.

Note: There are various ways of specifying the target destination:

  • If the document config for the type specified has a folder context defined and this context is not dynamic and absolute, then the path is computed using the path specified in the default GroupURI for the current group and using the scheme, host and port from the URI or GroupURI specified if any, otherwise from the parameters scheme, host and port .
  • If there is no context (or it is relative or dynamic) for the document type specified, the uri and guri parameters are used: the URI or GroupURI defined by the ID is the parent (if the URI is a document, its parent is used).

Parameters

NameDescriptionRequiredTypeDefault value
descriptionDescription of new documentnostring
documentidDocument IDnostring
filenamenostring
groupsComma-separated list of group names to notify (optional, default to current group name)nostring
gurinostring
labelsComma-separated list of document labelsnostring
notificationContent of notificationnostring
notification-labelsComma-separated list of labels for the note (if exists creates a note)nostring
notification-subjectSubject of notification (default to document title or “Document Created”)nostring
notifyNotification behaviornonotificationsilent
titleDisplay title of new documentnostring
typeType of new document (optional)nostringdefault
urinostring

Permission

Undocumented permissions requirements.

Response

The XML output follows this format:

<document-creation renamed="true" original-name="New_document.psml">
  <uri id="138614"
       scheme="https"
       host="localhost"
       port="443"
       path="/ps/jb/group1/documents/new_document.psml"
       decodedpath="/ps/jb/group1/documents/new_document.psml"
       external="false"
       mediatype="application/vnd.pageseeder.psml+xml"
       created="2013-12-19T15:14:54+11:00">
    <displaytitle>New document</displaytitle>
  </uri>
</document-creation>

Error handling

CodeCause / Description
0x1201Illegal character in filename
0x1216Invalid destination
0x120AInvalid Document ID
0x1209Existing Document ID
0x1211Existing URI
0x201BUnable to create XRefs
0x1217Two contradictory parameters have been specified (url and name or url and parenturl or url and parentfolder or parenturl and parentfolder)
0x6202Invalid PSML document config
Created on , last edited on