Skip to main content

 Services

Web services from /about to /webhooks

create externaluri

/members/{member}/externaluris [POST]

com.pageseeder.uri.CreateExternalURI

Description

Create an external URI (aka URL). The URI and it's properties are available to all members on the server.

All parameters except url are ignored if the user does not have permission to edit all URLs on the server. In this case or if a parameter is empty the value will be extracted from the URL source according to the URL type template.

Parameters

NameDescriptionRequiredTypeDefault
urlThe URLyesurl
descriptionThe descriptionnostring
labelsA comma-separated list of label valuesnostring
mediatypeThe mediatypenostring
sizeThe size in bytesnolong
titleThe titlenostring
type
The URL typenostring

Permission

This service requires contributor or higher.

Response

The output has the following format:

<uri-creation>
  <uri id="[id]" path="[path]" ...>
    <displaytitle>[title]</displaytitle>
    ...
  </uri>
</uri-creation>

Error Handling

No specific errors expected for this service.

Created on , last edited on