Web service API

How to use PageSeeder's Web service API

get externaluri source metadata forurl

/externaluris/forurl/source/metadata [GET]

com.pageseeder.uri.FetchURLMetadata

Description

Extract the metadata from the specified external URI (doesn't need to have been created in PageSeeder).

Parameters

NameDescriptionRequiredTypeDefault value
urlthe URL for the external URIyesurl

Permission

Any logged in user can invoke this service.

Response

The output has the following format:

 <url-source-metadata url="https://en.wikipedia.org/wiki/Wikipedia:Example"
                      status="ok"
                      retrieved="2019-10-08T15:06:08+11:00"
                      title="Wikipedia:Example - Wikipedia"
                      description=""
                      image=""
                      icon="https://en.wikipedia.org/static/apple-
                            touch/wikipedia.png"
                      siteName="en.wikipedia.org">
   <meta name="..." value="..."/>
   ...
 </url-source-metadata>

Error Handling

No specific errors expected for this generator.

Created on , last edited on