Skip to main content

 Services

Web services from /about to /webhooks

get uris url config

/members/{member}/groups/{group}/uris/urlconfig [GET]
API SupportAvailable sinceLast updatedOutput
experimental5.99005.9900xml

Description

Gets the following URL configuration files for a specified group and URL or URL type.

  • xref-config.xml
  • url-config.xml (including labels from global template)
  • url-template.xml
  • editor-config.xml

This service tries to locate the files by looking for the corresponding folder based on URL type in the order defined below:

  1. /template/[global template]/url/[type]
  2. /template/default/url/[type]

Parameters

NameDescriptionRequiredTypeDefault value
mediatypethe mediattype for external URIyes unless urltype specifiedstring
urlthe URL for external URIyes unless urltype specifiedstring
urltypethe URL type for the config (overrides url & mediatype)yes unless url & mediatype specifiedstring

Permission

This service requires guest or higher unless the group is public.

Response

<url-type definedby="myproject"
          name="mytype">
 [<xref-configs>
    ...
  </xref-configs>]
 [<url-config>
    ...
  </url-config>]
 [<url-template>
    ...
  </url-template>]
 [<editor-configs>
    ...
  </editor-configs>]
</document-type>

Error Handling

0x1212 Invalid URL
Created on , last edited on