ExternalURL
ExternalURL Service
Web service endpoints for external URLs (i.e. bookmarks).
Create Comment
POST /urls/{id}/commentsCreate a new comment as a reply to the specified external URL. The parent field (if any)
in the incoming entity will be ignored. Instead, it will be set to the URI of the specified external URL.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | true | ID of the external URL this comment replies to |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Fields to include in the returned Comment |
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 400 (Bad Request) | An input field is missing or malformed |
| 409 (Conflict) | You attempt to add a comment to a external URL for which comments have been closed |
| 403 (Forbidden) | You are not allowed to perform this operation |
| 404 (Not Found) | The specified parent content object (or comment) cannot be found |
Since: 3.4
Get Comments
GET /urls/{id}/commentsReturn a paginated list of comments to the specified external URL, optionally limiting the returned results to direct replies only.
This service supports the following filters. Parameters, when used, should be wrapped in parentheses, and multiple values separated by commas. See the examples for clarification.
| Filter | Params | Example |
|---|---|---|
| type | one or more outcome types of desired contained comments separated by commas | ?filter=outcomeType(decision) |
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | true | ID of the external URL for which to return comments |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| filter | Object[] | false | The filter criteria used to select comments |
| excludeReplies | Boolean | false | Flag indicating whether to exclude replies (and therefore return direct comments only) |
| hierarchical | Boolean | false | Flag indicating that comments should be returned in hierarchical order instead of chronological order |
| startIndex | Integer | false | Zero-relative index of the first comment to be returned |
| count | Integer | false | Maximum number of comments to be returned |
| anchor | String | false | optional URI for a comment to anchor at. Specifying a anchor will try to return the page containing the anchor. If the anchor could not be found then the first page of comments will be returned. |
| fields | String | false | Fields to be returned in the selected comments |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input field is malformed |
| 403 (Forbidden) | You are not allowed to access the specified external URL or comments |
| 404 (Not Found) | The specified external URL does not exist |
Since: 3.4
Get Content External URLs
GET /urls/contents/{contentID}Return metadata about the external URLs associated with an Update.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| contentID | String | true | ID of the content object for which to retrieve external URLs (must be an update) |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Names of the fields to be returned |
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input field is missing or malformed |
| 403 (Forbidden) | You are not allowed to access the specified update |
| 404 (Not Found) | The specified update is not found |
Get External URL
GET /urls/{id}Look up and return the specified external URL.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | true | ID of the external URL to be returned |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 200 (OK) | Request was successful |
| 400 (Bad Request) | An input value is missing or malformed |
| 403 (Forbidden) | You are not allowed to access the specified external URL |
| 404 (Not Found) | The specified external URL does not exist |
Mark Read
POST /urls/{id}/readMark the specified external URL as having been read.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | true | ID of the external URL to be marked |
Return Status:
| HTTP Status Code | Description |
|---|---|
| 204 (No Content) | Request was successful |
| 400 (Bad Request) | An input field was malformed |
| 403 (Forbidden) | You are not allowed to access this external URL |
| 404 (Not Found) | The specified external URL does not exist |
Mark Unread
DELETE /urls/{id}/readMark the specified external URL as having not been read.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | true | ID of the external URL to be marked |
Return Status:
| HTTP Status Code | Description |
|---|---|
| 204 (No Content) | Request was successful |
| 400 (Bad Request) | An input field was malformed |
| 403 (Forbidden) | You are not allowed to access this external URL |
| 404 (Not Found) | The specified external URL does not exist |