Web service API

How to use PageSeeder's Web service API

create psml

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

com.pageseeder.psml.CreateDocument

This service is obsolete since version 5.7900

Description

Create a PSML document.

This item is obsolete!

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 will be the parent (if the URI is a document, its parent will be used).

Parameters

NameDescriptionRequiredTypeDefault value
description Description of new document no string
documentid Document ID no string
filename no string
groups Comma-separated list of group names to notify (optional, default to current group name) no string
guri no string
labels Comma separated list of document labels no string
notification Content of notification no string
notification-labels Comma separated list of labels for the note (if exists creates a note) no string
notification-subject Subject of notification (default to document title or "Document Created") no string
notify Notification behavior no notification silent
title Display title of new document no string
type Type of new document (optional, default is "default") no string
uri no string

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
0x1201 Illegal character in filename
0x1216 Invalid destination
0x120A Invalid Document ID
0x1209 Existing Document ID
0x1211 Existing URI
0x201B Unable to create XRefs
0x1217 Two contradictory parameters have been specified (url and name or url and parenturl or url and parentfolder or parenturl and parentfolder)
0x6202 Invalid PSML document config.

Created on , last edited on