create externaluri
/members/{member}/externaluris [POST]
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9900 | 5.9900 | xml, json |
Description
Create an external URI (aka URL). The URI and it's properties are available to all members on the server.
Parameters
Name | Description | Required | Type | Default |
---|---|---|---|---|
url | The URL | yes | url | |
description | The description | no | string | |
labels | A comma-separated list of label values | no | string | |
mediatype | The mediatype | no | string | |
size | The size in bytes | no | long | |
title | The title | no | string | |
type | The URL type | no | string |
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
Code | Cause / Description |
---|---|
0x1211 | Existing URI |
0x1212 | Invalid URL |
0x1226 | Domain is not allowed for this URL type |
0x1227 | Media type is not allowed for this URL type |
0x6202 | Failed to load URL config file for this URL type |