Web service API

How to use PageSeeder's Web service API

list labels

/groups/{group}/labels [GET]

com.pageseeder.label.GetLabelConfig

Description

Returns the list of labels in a group

Parameters

NameDescriptionRequiredTypeDefault value
types comma-separated list of label types to return no string

The label type can be any combination of:

  • comment
  • fragment
  • edit-note
  • version
  • creation
  • upload
  • document
  • xref
  • content-inline
  • ​content-block

Permission

Undocumented permissions requirements.

Response

The output has the following format:

<label-config scope="[server|project|document]"
              template="[project]"
              updated="[updated date time]"> 
   <labels type="[comment|fragment|edit-note|version|creation|upload|document|xref|content-inline|content-block]"> 
      <label name="[label name]" description="[label description]"/>
      <label name="[label name]" description="[label description]"/>
     ...
   </labels> 
   ... 
</label-config>

Error handling

No specific errors expected for this service.

Created on , last edited on