ExternalURL

ExternalURL Service

Web service endpoints for external URLs (i.e. bookmarks).

Create Comment

POST /urls/{id}/comments

Create 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:
NameTypeRequiredDescription
idStringtrueID of the external URL this comment replies to
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to include in the returned Comment
Takes:
  • Comment describing the comment to be created
  • Retrieves:
  • Comment representing the newly created comment
  • Return Status:
    HTTP Status CodeDescription
    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}/comments

    Return 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:
    NameTypeRequiredDescription
    idStringtrueID of the external URL for which to return comments
    Query Parameters:
    NameTypeRequiredDescription
    filterObject[]falseThe filter criteria used to select comments
    excludeRepliesBooleanfalseFlag indicating whether to exclude replies (and therefore return direct comments only)
    hierarchicalBooleanfalseFlag indicating that comments should be returned in hierarchical order instead of chronological order
    startIndexIntegerfalseZero-relative index of the first comment to be returned
    countIntegerfalseMaximum number of comments to be returned
    anchorStringfalseoptional 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.
    fieldsStringfalseFields to be returned in the selected comments
    Retrieves:
  • Comment[]
  • Return Status:
    HTTP Status CodeDescription
    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 External URL

    GET /urls/{id}

    Look up and return the specified external URL.

    Path Parameters:
    NameTypeRequiredDescription
    idStringtrueID of the external URL to be returned
    Retrieves:
  • ExternalURL containing the specified external URL
  • Return Status:
    HTTP Status CodeDescription
    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}/read

    Mark the specified external URL as having been read.

    Path Parameters:
    NameTypeRequiredDescription
    idStringtrueID of the external URL to be marked
    Return Status:
    HTTP Status CodeDescription
    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}/read

    Mark the specified external URL as having not been read.

    Path Parameters:
    NameTypeRequiredDescription
    idStringtrueID of the external URL to be marked
    Return Status:
    HTTP Status CodeDescription
    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