Web service API

How to use PageSeeder's Web service API

Services

From ver 5.0, developers can access PageSeeder data and functionality through services.

Services provide a lighter, more consistent and more modern programming interface than the servlet API. Because the services have been optimized as a web API, they allow PageSeeder to be integrated with applications written in languages other than Java.

Services always start with the same URL prefix. If the default site prefix has not been changed, all services will match the following:

/ps/service/*

To invoke a service simply expand the URL pattern and append it to the service URL prefix. For example, the following components are needed to get the details of a member with username "jsmith" or ID "17" using the Get Member service:

prefix = /ps/service
pattern = /members/{member}/details
member = ~jsmith or 17

The resulting URLs for the service are:

/ps/service/members/~jsmith/details
/ps/service/members/17/details

Note

Wherever a non-numeric string occurs in a URL variable it should be prefixed by ~ to prevent clashes with other URLs (e.g. ~jsmith)

The following URL variables will accept a number or string:

VariableNumberStringExample String
{group}Group IDGroup name~acme-specs
{member}Member IDUsername~jsmith
{uri}URI IDDoc ID~spec123

Note

Each service is mapped to a specific HTTP method. While an incorrect method will generally return an HTTP 404 error, it could invoke a different service.

 

Created on , last edited on

Overview

ServiceSupport / Version
/about [GET]

This service returns information about the system including the database table version and libraries in use, as well whether the publisher has been registered.

EXPERIMENTAL
5.6010
/bandwidth [GET]

Return total bandwidth used on server.

OBSOLETE
5.1102
/caches [GET]

Display a summary of the information about all the caches in the PageSeeder.

EXPERIMENTAL
5.5000
/caches/clear [POST]

Clear all caches.

EXPERIMENTAL
5.9300
/caches/{name} [GET]

Return information about a specific cache

EXPERIMENTAL
5.9300
/caches/{name}/clear [POST]

Clears the cache content of a specific cache.

EXPERIMENTAL
5.9300
/caches/{name}/elements [GET]

Return the list of elements in a specific cache.

EXPERIMENTAL
5.9300
/caches/{name}/elements/{key}/remove [POST]

Removes an entry from the cache content.

EXPERIMENTAL
5.9300
/caches/{name}/info [GET]

Return information about a specific cache.

DEPRECATED
5.9300
/comments/filter [GET]

Load public comments by filter.

DEPRECATED
5.7912
/comments/find [GET]

This service returns a list of public comments using parameters to filter the results, the list of groups specified must be public groups.

SUPPORTED
5.7912
/comments/forurl [POST]

Create a new comment on a URL.

SUPPORTED
5.8911
/comments/{commentid} [GET]

Returns a single comment from accessible groups.

SUPPORTED
5.6900
/comments/{xlinkid}/reply [POST]

Create a reply to an existing comment with author as a parameter.

SUPPORTED
5.8911
/discussions/forurl [GET]

Returns the list of public discussions attached to the specified URL.

SUPPORTED
5.9300
/discussions/{discussion} [GET]

This service returns a public discussion.

SUPPORTED
5.9300
/error/report [POST]

Report an error to the adequate person.

EXPERIMENTAL
5.7900
/groups/{group} [GET]

Get a group or project.

SUPPORTED
5.8909
/groups/{group}/autocomplete [GET]

Autocomplete the specified term in the group.

EXPERIMENTAL
5.2102
/groups/{group}/autocomplete/{field} [GET]

Autocomplete for a specific field

EXPERIMENTAL
5.2102
/groups/{group}/autosuggest [GET]

This service returns the list of result suggestions from a prefix match on a set of preconfigured fields.

EXPERIMENTAL
5.0500
/groups/{group}/autosuggest/fields [GET]

Return result suggestions from a query for a specific field

EXPERIMENTAL
5.0500
/groups/{group}/bandwidth [GET]

Returns the bandwidth used by scanning the Tomcat log files for the specified project.

OBSOLETE
5.1102
/groups/{group}/comments [POST]

Create a new comment with author as a parameter

SUPPORTED
5.8911
/groups/{group}/comments/{xlinkid}/reply [POST]

Create a new group reply

SUPPORTED
5.8911
/groups/{group}/discussions [GET]

Load a list of non-archived discussions from the group specified in the request in reverse chronological order, based on the last comment sent for each discussion.

SUPPORTED
5.9300
/groups/{group}/discussions/{discussion} [GET]

Return a single discussion from the group specified in the URL.

SUPPORTED
5.9300
/groups/{group}/documenttypes/converttopsml [POST]

Convert document types to PSML.

EXPERIMENTAL
5.5914
/groups/{group}/error/report [POST]

Reports an error to the adequate person when they occur within the context of a group.

EXPERIMENTAL
5.7900
/groups/{group}/externaluris/forurl/externaluris [GET]

Load all the External URIs with a particular relationship to a specified URL.

SUPPORTED
5.9300
/groups/{group}/externaluris/hosts [GET]

Load the hosts for the current group.

SUPPORTED
5.4000
/groups/{group}/externaluris/{uri}/externaluris [GET]

Load all the External URIs with a particular relationship to a specified URI.

SUPPORTED
5.9300
/groups/{group}/facet [GET]

Returns the facets for a specific field in the index.

EXPERIMENTAL
4.9505
/groups/{group}/folders/create [POST]

Create a new group folder (also known as GroupURI) with the URL specified in the request.

DEPRECATED
5.8900
/groups/{group}/folders/forurl [GET]

Load the group folder (GroupURI) specified by the URL in the request.

DEPRECATED
5.8900
/groups/{group}/groupfolders [GET]

List the group folders, also known as "GroupURIs", that belong to the current group.

SUPPORTED
5.8900
/groups/{group}/groupfolders [POST]

Create a new group folder, also known as "Group URI",  with the URL specified in the request.

SUPPORTED
5.8900
/groups/{group}/groupfolders/create [POST]

Create a new group folder, also known as "Group URI", with the URL specified in the request.

DEPRECATED
5.8900
/groups/{group}/groupfolders/forurl [GET]

Load the group folder, also known  as "Group URI", with by the URL specified in the request.

SUPPORTED
5.8900
/groups/{group}/groupfolders/{id} [PATCH]

Edit the group folder, also known as "Group URI", specified by the id parameter.

SUPPORTED
5.8900
/groups/{group}/hosts/{host}/externaluris [GET]

Load all the external URIs for a specified host in the group specified in the request.

SUPPORTED
5.9300
/groups/{group}/images/find [GET]

Find images in the current group matching the criteria specified in the request.

EXPERIMENTAL
5.0000
/groups/{group}/images/find [POST]

Find images in the specified group matching the criteria specified in the request.

EXPERIMENTAL
5.0000
/groups/{group}/index/clear [POST]

Clear the index for the group specified in the URL.

EXPERIMENTAL
5.1500
/groups/{group}/index/status [GET]

This service indicates the status of the index of a group.

EXPERIMENTAL
5.1500
/groups/{group}/labels [GET]

Returns the list of labels in a group

EXPERIMENTAL
5.8900
/groups/{group}/members [GET]

Collection of members in the group

SUPPORTED
5.6007
/groups/{group}/members [POST]

Create a member and add the member to a group

SUPPORTED
5.5917
/groups/{group}/members/alldetails [GET]

Lists the members of a group and all details of their membership. See <member> for documentation on available information.

EXPERIMENTAL
5.6007
/groups/{group}/members/create [POST]

Creates a new member in PageSeeder and invite the member to a group.

DEPRECATED
5.5917
/groups/{group}/members/find [GET]

This service searches for members in the group that match the specified criteria and returns the group details for a list of group members based on the search parameters.

SUPPORTED
5.6007
/groups/{group}/members/forceresetpassword [POST]

Reset password as admin within a group.

SUPPORTED
5.8900
/groups/{group}/members/invite [POST]

Invite a member to a group

SUPPORTED
5.9200
/groups/{group}/members/inviteself [POST]

Invite self to a group

SUPPORTED
5.2301
/groups/{group}/members/resetpassword [POST]

Reset password for a member.

SUPPORTED
5.8900
/groups/{group}/members/{member} [DELETE]

Permanently delete the membership of a member to a group

SUPPORTED
5.4101
/groups/{group}/members/{member} [GET]

Returns the group details for a member.

SUPPORTED
4.5811
/groups/{group}/members/{member} [PATCH]

Edit the details of a member and its membership for a specific group.

SUPPORTED
5.8911
/groups/{group}/members/{member}/delete [POST]

Permanently delete the membership of a member to a group.

DEPRECATED
5.4101
/groups/{group}/members/{member}/deregister [POST]

Deregister a member from a group.

EXPERIMENTAL
5.8911
/groups/{group}/members/{member}/details [GET]

Get a membership

DEPRECATED
4.5811
/groups/{group}/members/{member}/edit [POST]

Edit a membership.

DEPRECATED
5.8911
/groups/{group}/members/{member}/inviteself [POST]

Invite self to a group.

DEPRECATED
5.2301
/groups/{group}/members/{member}/manage [POST]

Edit the membership details for a member.

EXPERIMENTAL
5.2301
/groups/{group}/members/{member}/registration [POST]

Edit the subscription details for a member.

DEPRECATED
5.2301
/groups/{group}/omnibox [GET]

Service supporting the Omnibox in the PageSeeder user interface.

EXPERIMENTAL
5.0500
/groups/{group}/properties [GET]

Get a group or project properties.

SUPPORTED
5.7900
/groups/{group}/resources [DELETE]

Deletes a project resource.

EXPERIMENTAL
4.9508
/groups/{group}/resources [GET]

Retrieves a project resource.

EXPERIMENTAL
5.1503
/groups/{group}/resources [POST]

Creates a new empty project resource.

EXPERIMENTAL
4.9508
/groups/{group}/resources [PUT]

Creates or updates a project resource.

EXPERIMENTAL
5.1503
/groups/{group}/resources/create [POST]

Create a resource.

DEPRECATED
4.9508
/groups/{group}/resources/delete [POST]

Delete a resource on the specified project.

DEPRECATED
4.9508
/groups/{group}/resources/export [GET]

Export all the files in the project

EXPERIMENTAL
5.1503
/groups/{group}/resources/get [GET]

Get a project resource.

DEPRECATED
5.1503
/groups/{group}/resources/history [GET]

Update a resource

EXPERIMENTAL
5.1503
/groups/{group}/resources/import [POST]

Import all the files in the project

EXPERIMENTAL
4.9017
/groups/{group}/resources/move [POST]

Move a resource within a project.

EXPERIMENTAL
5.1503
/groups/{group}/resources/put [POST]

Update a resource

DEPRECATED
5.1503
/groups/{group}/size [GET]

This service computes the total size of all the documents in a specific group.

OBSOLETE
5.1000
/groups/{group}/subgroups [GET]

Returns the list of subgroups in the specified Group.

EXPERIMENTAL
5.4903
/groups/{group}/subgroups/add [POST]

Adds a new subgroup in an existing group.

EXPERIMENTAL
5.4903
/groups/{group}/subgroups/{subgroup} [PATCH]

Edit an existing subgroup.

EXPERIMENTAL
5.4903
/groups/{group}/subgroups/{subgroup}/edit [POST]

Edit a subgroup in a group.

DEPRECATED
5.4903
/groups/{group}/subgroups/{subgroup}/remove [POST]

Removes an existing subgroup from a group.

EXPERIMENTAL
5.4903
/groups/{group}/threads [GET]

This service will list each active Asynchronous process in the specified group.

EXPERIMENTAL
5.0100
/groups/{group}/threads/{threadid}/cancel [POST]

Cancel an Asynchronous process in the specified group.

EXPERIMENTAL
5.0100
/groups/{group}/threads/{threadid}/logs [GET]

View the logs for a specific ticket for the PageSeeder Threads.

EXPERIMENTAL
5.4000
/groups/{group}/threads/{threadid}/progress [GET]

Thread Progress

EXPERIMENTAL
5.0100
/groups/{group}/unsubscribe [GET]

Returns a list of group and subgroup memberships for a member for the group specified so they can decide whether to change notification settings or remove themselves from one or more groups.

EXPERIMENTAL
5.9300
/groups/{group}/unsubscribe [POST]

Unsubscribe a member from a group without logging in.

EXPERIMENTAL
5.9300
/groups/{group}/uris/forurl [GET]

Load a single URI object from the URL specified in the request.

SUPPORTED
5.7900
/groups/{group}/uris/forurl/uris [GET]

List all the URIs with a particular relationship to a specified URI.

EXPERIMENTAL
5.6900
/groups/{group}/uris/{uri} [GET]

Load a single URI object based on it ID.

SUPPORTED
5.8900
/groups/{group}/uris/{uri}/drafts [GET]

Get the draft edits for a URI.

SUPPORTED
5.8900
/groups/{group}/uris/{uri}/fragments/{fragment}/drafts [GET]

Get draft edits for a URI fragment.

SUPPORTED
5.8900
/groups/{group}/uris/{uri}/fragments/{fragment}/edits [GET]

List the edits for a fragment.

SUPPORTED
5.6900
/groups/{group}/uris/{uri}/history [GET]

Load the history of events for a specified URI (most recent first).

SUPPORTED
5.7900
/groups/{group}/uris/{uri}/index [GET]

Returns the index entry for a URI

EXPERIMENTAL
5.0000
/groups/{group}/uris/{uri}/metadata/edits [GET]

List the edits for the document metadata.

SUPPORTED
5.6900
/groups/{group}/uris/{uri}/properties [GET]

Get/Sets the URI Properties

OBSOLETE
5.1503
/groups/{group}/uris/{uri}/schemas [GET]

Returns the schemas available for a URI

EXPERIMENTAL
5.8900
/groups/{group}/uris/{uri}/structure/edits [GET]

List the edits to the structure of the document.

EXPERIMENTAL
5.8900
/groups/{group}/uris/{uri}/uris [GET]

List all the URIs with a particular relationship to a specified URI.

EXPERIMENTAL
5.6900
/groups/{group}/uris/{uri}/versions [GET]

Load all the versions for a specified URI.

SUPPORTED
5.6900
/groups/{group}/uris/{uri}/workflow [GET]

Lists the workflow steps for a specified URI.

SUPPORTED
5.6913
/groups/{group}/uris/{uri}/xrefs [GET]

Load a URI's XRefs.

EXPERIMENTAL
5.6900
/groups/{group}/uris/{uri}/xreftree [GET]

Loads the XRef tree for a URI

EXPERIMENTAL
5.8911
/hostaliases/{aliasname} [DELETE]

Deletes a host alias.

SUPPORTED
5.8900
/hostaliases/{aliasname} [PATCH]

Edits a host alias - will only change specified parameters.

SUPPORTED
5.8900
/hosts [GET]

This service returns the list of hosts and host aliases currently defined on the server.

SUPPORTED
5.8900
/hosts [POST]

Creates a host.

SUPPORTED
5.9300
/hosts/{hostname} [DELETE]

Deletes a host.

SUPPORTED
5.8900
/hosts/{hostname} [PATCH]

Edits a host - will only change specified parameters.

SUPPORTED
5.8900
/hosts/{hostname}/hostaliases [POST]

Create an alias to an existing host.

SUPPORTED
5.9300
/members [POST]

Create a member

SUPPORTED
5.3900
/members/create [POST]

Create a member.

DEPRECATED
5.3900
/members/forceresetpassword [POST]

Reset password as an administrator.

SUPPORTED
5.8900
/members/register [POST]

Self-register a member

SUPPORTED
5.8900
/members/resetpassword [POST]

Reset password as normal user

SUPPORTED
5.8900
/members/sendactivation [GET]

Send activation email

SUPPORTED
5.8900
/members/{member} [DELETE]

Deletes member with specified id plus all associated objects and replaces any member references in XLinks with string values.

SUPPORTED
5.9300
/members/{member} [GET]

Get the member's personal details.

SUPPORTED
5.8900
/members/{member} [PATCH]

Edit the account details of a member.

SUPPORTED
5.8900
/members/{member}/activate [GET]

Activate the specified member.

SUPPORTED
4.9508
/members/{member}/activate [POST]

Activate a member.

SUPPORTED
4.9508
/members/{member}/comments/draft [GET]

Load a list of draft comments for the current user.

SUPPORTED
5.7900
/members/{member}/comments/filter [GET]

Load a list of comments using filter parameters.

DEPRECATED
5.7912
/members/{member}/comments/find [GET]

Load a list of comments using filter parameters.

SUPPORTED
5.7912
/members/{member}/comments/forurl [POST]

Create a new comment for URL from member

SUPPORTED
5.8911
/members/{member}/comments/{commentid} [DELETE]

Delete a single comment

SUPPORTED
5.8900
/members/{member}/comments/{commentid} [GET]

Load a single comment from accessible groups.

SUPPORTED
5.6900
/members/{member}/comments/{commentid} [PATCH]

Edits an existing comment.

SUPPORTED
5.8911
/members/{member}/comments/{commentid}/archive [POST]

Archive an existing comment.

SUPPORTED
5.8900
/members/{member}/comments/{commentid}/edit [POST]

Edit comment.

DEPRECATED
5.8911
/members/{member}/comments/{commentid}/unarchive [POST]

Unarchive comment

SUPPORTED
5.8900
/members/{member}/comments/{xlinkid}/reply [POST]

Create a new reply from member

SUPPORTED
5.8911
/members/{member}/creategroup [POST]

Creates the personal group for the specified member.

EXPERIMENTAL
4.9507
/members/{member}/declineinvitation [POST]

Decline an invitation to a group.

EXPERIMENTAL
4.9508
/members/{member}/details [GET]

Get a member.

DEPRECATED
5.8900
/members/{member}/discussions [GET]

Load a list of discussions from the current user's groups.

SUPPORTED
5.9300
/members/{member}/discussions/forurl [GET]

Load a list of discussions for a URL.

SUPPORTED
5.9300
/members/{member}/discussions/{discussion} [GET]

Loads a discussion. If a reply comment ID is specified for the discussion it will return the containing discussion.

SUPPORTED
5.9300
/members/{member}/edit [POST]

Edit a member.

DEPRECATED
5.8900
/members/{member}/email [POST]

Edit member email with token

SUPPORTED
5.8900
/members/{member}/export [GET]

Export document(s) using path or uris parameters.

EXPERIMENTAL
5.1102
/members/{member}/groups [POST]

Creates a group in PageSeeder.

SUPPORTED
5.8909
/members/{member}/groups/create [POST]

Creates a group.

DEPRECATED
5.8909
/members/{member}/groups/{group} [GET]

Get a group (for backward compatibility)

DEPRECATED
5.8909
/members/{member}/groups/{group} [PATCH]

Edits a group

SUPPORTED
5.8909
/members/{member}/groups/{group}/applyshare [POST]

Apply sharing for a group.

EXPERIMENTAL
5.8900
/members/{member}/groups/{group}/archive [POST]

Archive the group

EXPERIMENTAL
5.5900
/members/{member}/groups/{group}/comments [POST]

Create a new group comment from member

SUPPORTED
5.8911
/members/{member}/groups/{group}/comments/{xlinkid}/reply [POST]

Create a new group reply from member

SUPPORTED
5.8911
/members/{member}/groups/{group}/converttopsml [POST]

Convert documents to PSML for a group

EXPERIMENTAL
5.6918
/members/{member}/groups/{group}/documents [POST]

Create a PSML document

SUPPORTED
5.8900
/members/{member}/groups/{group}/documents/forurl [POST]

Create a new PSML document.

SUPPORTED
5.8900
/members/{member}/groups/{group}/edit [POST]

Edits an existing PageSeeder project/group.

DEPRECATED
5.8909
/members/{member}/groups/{group}/export [GET]

Start export for multiple uris or uri using path.

EXPERIMENTAL
5.1102
/members/{member}/groups/{group}/externaluris [POST]

Create an external URI

SUPPORTED
5.4000
/members/{member}/groups/{group}/externaluris/{uri} [DELETE]

Deletes external URI and all associated objects.

SUPPORTED
5.8911
/members/{member}/groups/{group}/externaluris/{uri} [PATCH]

Edit an existing external URI.

SUPPORTED
5.4000
/members/{member}/groups/{group}/externaluris/{uri} [POST]

Edit an external URI

DEPRECATED
5.4000
/members/{member}/groups/{group}/externaluris/{uri}/archive [POST]

Archive an existing external URI.

SUPPORTED
5.4000
/members/{member}/groups/{group}/externaluris/{uri}/unarchive [POST]

Unarchive an existing external URI.

SUPPORTED
5.4000
/members/{member}/groups/{group}/folders [POST]

Creates a new folder under the specified destination.

SUPPORTED
4.9008
/members/{member}/groups/{group}/folders/forurl [POST]

Creates a new folder under the specified destination.

SUPPORTED
4.9008
/members/{member}/groups/{group}/groupfolders/{groupfolderid} [GET]

Get a group folder with ID and sharing details (that's why the member on the URL)

SUPPORTED
5.8900
/members/{member}/groups/{group}/groupfolders/{guri}/resolverefs [POST]

Resolve references for a group folder.

EXPERIMENTAL
5.7900
/members/{member}/groups/{group}/index/start [POST]

Start group indexing.

EXPERIMENTAL
5.3900
/members/{member}/groups/{group}/loadingzone/clear [POST]

Clearing the content in a member loading zone.

EXPERIMENTAL
5.2103
/members/{member}/groups/{group}/loadingzone/delete [POST]

Deleting the content of a member loading zone

EXPERIMENTAL
5.2102
/members/{member}/groups/{group}/loadingzone/unzip [POST]

Unzip content in a member loading zone.

EXPERIMENTAL
5.2102
/members/{member}/groups/{group}/loadingzone/uris [GET]

Uploaded URIs

EXPERIMENTAL
5.1101
/members/{member}/groups/{group}/mail/preview [POST]

Preview an Email output

EXPERIMENTAL
5.5914
/members/{member}/groups/{group}/mail/send [POST]

Send an email message.

EXPERIMENTAL
5.9300
/members/{member}/groups/{group}/memberdetails [GET]

Get a group's member details.

EXPERIMENTAL
5.9300
/members/{member}/groups/{group}/publish/start [GET]

Start a group publish job.

EXPERIMENTAL
5.5914
/members/{member}/groups/{group}/publishconfig [GET]

Gets the publish config for a group.

EXPERIMENTAL
5.9200
/members/{member}/groups/{group}/rename [POST]

Launch a rename thread for the group

EXPERIMENTAL
5.5004
/members/{member}/groups/{group}/resolverefs [POST]

Resolve XRefs for a group

EXPERIMENTAL
5.7900
/members/{member}/groups/{group}/unarchive [POST]

Unarchive a group.

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

Create a PSML document.

OBSOLETE
5.5912
/members/{member}/groups/{group}/uris/forurl [GET]

Load a URI object with sharing information.

SUPPORTED
5.7900
/members/{member}/groups/{group}/uris/publishconfig [GET]

Gets the publish config for all URIs in a group.

EXPERIMENTAL
5.9200
/members/{member}/groups/{group}/uris/{uri} [GET]

Load a URI object with sharing information​​​​​​.

EXPERIMENTAL
5.8900
/members/{member}/groups/{group}/uris/{uri} [PATCH]

Sets the URI Properties

EXPERIMENTAL
5.1503
/members/{member}/groups/{group}/uris/{uri}/archive [POST]

Archive a document or a folder.

SUPPORTED
5.3900
/members/{member}/groups/{group}/uris/{uri}/config [GET]

Get config files for a URI

EXPERIMENTAL
5.8900
/members/{member}/groups/{group}/uris/{uri}/delete [POST]

Delete a uri

SUPPORTED
5.7900
/members/{member}/groups/{group}/uris/{uri}/documents [POST]

Create a new PSML document.

SUPPORTED
5.8900
/members/{member}/groups/{group}/uris/{uri}/drafts/{editid}/delete [POST]

Delete a specific draft

SUPPORTED
5.3907
/members/{member}/groups/{group}/uris/{uri}/duplicate [POST]

Duplicate a PSML document.

EXPERIMENTAL
5.5912
/members/{member}/groups/{group}/uris/{uri}/editinlinelabel [POST]

Edit an inline label found in a fragment of the URI provided.

EXPERIMENTAL
5.5914
/members/{member}/groups/{group}/uris/{uri}/editlabel [GET]

This service is now obsolete and has been removed from PageSeeder 5.6+.

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

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

EXPERIMENTAL
5.5914
/members/{member}/groups/{group}/uris/{uri}/edits/sharelatest [POST]

Share latest edits

EXPERIMENTAL
5.8900
/members/{member}/groups/{group}/uris/{uri}/edits/{editid}/notes [POST]

Create an edit note

SUPPORTED
5.7909
/members/{member}/groups/{group}/uris/{uri}/edits/{editid}/share [POST]

Share an edit

EXPERIMENTAL
5.3900
/members/{member}/groups/{group}/uris/{uri}/export [GET]

Start export

EXPERIMENTAL
5.1102
/members/{member}/groups/{group}/uris/{uri}/folders [POST]

Creates a new folder under the specified destination.

SUPPORTED
4.9008
/members/{member}/groups/{group}/uris/{uri}/foldervalidate [POST]

Triggers the validation of documents contained in a folder.

EXPERIMENTAL
5.0100
/members/{member}/groups/{group}/uris/{uri}/fragments [POST]

Create new edit on specified fragment.

SUPPORTED
5.9000
/members/{member}/groups/{group}/uris/{uri}/fragments/{fragment} [DELETE]

Deletes the content of the fragment provided.

SUPPORTED
5.3900
/members/{member}/groups/{group}/uris/{uri}/fragments/{fragment} [GET]

Fragment's Content

SUPPORTED
5.8900
/members/{member}/groups/{group}/uris/{uri}/fragments/{fragment} [POST]

Fragment's Content

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

Fragment's Content

SUPPORTED
5.3900
/members/{member}/groups/{group}/uris/{uri}/fragments/{fragment}/delete [POST]

Delete a fragment.

DEPRECATED
5.3900
/members/{member}/groups/{group}/uris/{uri}/fragments/{fragment}/move [POST]

Move a Fragment

EXPERIMENTAL
5.8900
/members/{member}/groups/{group}/uris/{uri}/fragments/{fragment}/revert [POST]

Revert Fragment's Content

EXPERIMENTAL
5.6004
/members/{member}/groups/{group}/uris/{uri}/index/start [POST]

Start folder indexing.

EXPERIMENTAL
5.3900
/members/{member}/groups/{group}/uris/{uri}/metadata [GET]

SUPPORTED
5.8900
/members/{member}/groups/{group}/uris/{uri}/metadata [PUT]

 

SUPPORTED
5.3900
/members/{member}/groups/{group}/uris/{uri}/metadata/revert [POST]

Revert URI Metadata.

EXPERIMENTAL
5.6004
/members/{member}/groups/{group}/uris/{uri}/move [POST]

Move a URI.

EXPERIMENTAL
5.0100
/members/{member}/groups/{group}/uris/{uri}/properties [POST]

Edits a URI

DEPRECATED
5.1503
/members/{member}/groups/{group}/uris/{uri}/publish/start [GET]

Start a document or folder publish job.

EXPERIMENTAL
5.5914
/members/{member}/groups/{group}/uris/{uri}/publishconfig [GET]

Gets the publish config for a URI.

EXPERIMENTAL
5.9200
/members/{member}/groups/{group}/uris/{uri}/resolverefs [POST]

Resolve XRefs for a folder

EXPERIMENTAL
5.7900
/members/{member}/groups/{group}/uris/{uri}/validate [GET]

Validate the URI with Schematron.

EXPERIMENTAL
5.8900
/members/{member}/groups/{group}/uris/{uri}/versions [POST]

Create a new version

SUPPORTED
5.8102
/members/{member}/groups/{group}/uris/{uri}/versions/{versionid}/archive [POST]

Archive an existing version on a URI.

SUPPORTED
5.4000
/members/{member}/groups/{group}/uris/{uri}/workflow [POST]

Create a new workflow

SUPPORTED
5.9300
/members/{member}/groups/{group}/uris/{uri}/xrefs [POST]

Create a new XRef.

SUPPORTED
5.4000
/members/{member}/groups/{group}/uris/{uri}/xrefs/{xrefid}/archive [POST]

Archive a URI's XRef.

SUPPORTED
5.4000
/members/{member}/hosts/{host}/update [POST]

Update host's group URIs and URIs with new scheme/port.

SUPPORTED
5.1100
/members/{member}/index/start [POST]

Start server indexing

EXPERIMENTAL
5.9000
/members/{member}/index/status [GET]

Status of server indexing

EXPERIMENTAL
5.1500
/members/{member}/invitations [GET]

Get the invitations for the member

SUPPORTED
4.9508
/members/{member}/memberships [GET]

Get the memberships for the member

SUPPORTED
5.6900
/members/{member}/projectfind [GET]

Finds projects and groups for a member.

DEPRECATED
5.6012
/members/{member}/projectlist [GET]

List the top level projects for the specified member.

EXPERIMENTAL
5.6012
/members/{member}/projects [GET]

List the projects and groups for the given member.

DEPRECATED
5.6012
/members/{member}/projects [POST]

Creates a new project in PageSeeder.

SUPPORTED
5.8909
/members/{member}/projects/create [POST]

Creates a project

DEPRECATED
5.8909
/members/{member}/projects/find [GET]

Finds projects and groups for a member.

EXPERIMENTAL
5.6012
/members/{member}/projects/{group} [GET]

Get a project.

DEPRECATED
5.8909
/members/{member}/projects/{group} [PATCH]

Edits a project

SUPPORTED
5.8909
/members/{member}/projects/{group}/archive [POST]

Launch an archive thread for the project

EXPERIMENTAL
5.5900
/members/{member}/projects/{group}/edit [POST]

Edits a project.

DEPRECATED
5.8909
/members/{member}/projects/{group}/rename [POST]

Launch a rename thread for the project

EXPERIMENTAL
5.5004
/members/{member}/projects/{group}/subprojectlist [GET]

List the sub-projects the member is registered to

EXPERIMENTAL
5.6012
/members/{member}/projects/{group}/subprojects [GET]

List the sub-projects the member is registered to

DEPRECATED
5.6012
/members/{member}/projects/{group}/subprojecttree [GET]

List the sub-projects the member is registered to (as a tree)

EXPERIMENTAL
5.6012
/members/{member}/projects/{group}/unarchive [POST]

Launch an unarchive thread for the project

EXPERIMENTAL
5.1101
/members/{member}/projecttree [GET]

List the projects and groups that the specified member is registered to as a tree.

EXPERIMENTAL
5.6012
/members/{member}/publish/cancel [POST]

This service can be used to cancel a publish job.

EXPERIMENTAL
4.9508
/members/{member}/publish/check [GET]

Status about a publish job

EXPERIMENTAL
4.8107
/members/{member}/resolvestandard [POST]

Resolve PS standard documents starting a "Resolve Standard Thread".

EXPERIMENTAL
5.8109
/members/{member}/tasks/filter [GET]

Load a list of tasks using filter parameters. The last comment in the task must match all filter parameters.

DEPRECATED
5.9300
/members/{member}/tasks/find [GET]

Load a list of non-archived tasks using filter parameters. The last comment in the task must match all filter parameters.

SUPPORTED
5.9300
/members/{member}/tasks/{taskid} [GET]

Load a single task from accessible groups.

SUPPORTED
5.9300
/members/{member}/unlock [POST]

Unlock a member's account.

SUPPORTED
5.9300
/members/{member}/uris/{uri}/comments [POST]

Create a new comment for URI from member

SUPPORTED
5.8911
/members/{member}/uris/{uri}/discussions [GET]

Load a list of discussions for a URI including all discussions attached to fragments in that URI.

SUPPORTED
5.9300
/members/{member}/uris/{uri}/export [GET]

Export a document (URI) and any of its referenced documents.

EXPERIMENTAL
5.1102
/members/{member}/uris/{uri}/fragments/{fragment}/comments [POST]

Create a new comment for URI fragment from member

SUPPORTED
5.8911
/members/{member}/uris/{uri}/fragments/{fragment}/discussions [GET]

Load a list of discussions for a URI fragment.

SUPPORTED
5.9300
/members/{member}/visiblegroups [GET]

Returns the list of groups visible to the specified member.

EXPERIMENTAL
5.2301
/oauth/members/{member}/clients [GET]

=========================================================================================

EXPERIMENTAL
5.8909
/oauth/members/{member}/clients [POST]

Create an OAuth client.

EXPERIMENTAL
5.8909
/oauth/members/{member}/clients/{client} [DELETE]

EXPERIMENTAL
5.8909
/oauth/members/{member}/clients/{client} [GET]

EXPERIMENTAL
5.8909
/oauth/members/{member}/clients/{client} [PATCH]

EXPERIMENTAL
5.8909
/password/meter [POST]

Check the strength of the password

EXPERIMENTAL
5.1000
/projects/{group} [GET]

Get a project

SUPPORTED
5.8909
/projects/{group}/memberdetails [GET]

Returns the list of member details types available to this group or project.

EXPERIMENTAL
5.8102
/publish/about [GET]

Information about the system

EXPERIMENTAL
5.6009
/publish/checkall [GET]

Status of a publish job.

EXPERIMENTAL
4.9508
/publish/schedule [POST]

"Pause/continue" a scheduled publish job

EXPERIMENTAL
5.8200
/resetsession [POST]

Resets the current active session.

EXPERIMENTAL
5.6900
/restartmail [GET]

Restart the mail server.

UNSUPPORTED
5.0002
/self [GET]

Returns the member details for the member that is currently authenticated.

SUPPORTED
5.9200
/self/memberships [GET]

Get the memberships for the member that is currently authenticated.

SUPPORTED
5.9200
/tasks/filter [GET]

Load a list of tasks using filter parameters. The last comment in the task must match all filter parameters.​​​​​​

DEPRECATED
5.9300
/tasks/find [GET]

Load public tasks by filter

SUPPORTED
5.9300
/tasks/{taskid} [GET]

Load a public task

SUPPORTED
5.9300
/threads [GET]

List All Threads

EXPERIMENTAL
5.0100
/threads/{threadid}/cancel [POST]

Cancel an Asynchronous process

EXPERIMENTAL
5.0100
/threads/{threadid}/progress [GET]

Thread Progress

EXPERIMENTAL
5.0100
/uris/{uri}/comments [POST]

Create a new comment for URI

SUPPORTED
5.8911
/uris/{uri}/discussions [GET]

Load public discussions for a URI.

SUPPORTED
5.9300
/uris/{uri}/fragments/{fragment}/comments [POST]

Create a new comment for URI fragment

SUPPORTED
5.8911
/uris/{uri}/fragments/{fragment}/discussions [GET]

Load the discussions on a URI fragment.

SUPPORTED
5.9300
/uris/{uri}/xrefs [GET]

Load all XRefs for a URI

OBSOLETE
5.0100
/version [GET]

Returns the PageSeeder version.

SUPPORTED
5.6010