Companies

Retrieve all comments for a particular document from Basecone.

GET documents/:id/comments

Document comment collection properties

Property Type Description
Comments Array A list of comments.
_links Array A list of useful preconfigured uri's a client app can use to navigate this resource collection.
_metadata Complex object Optional object with additional information concerning the current returned result.

Document comment properties

Property Type Description
Text string The content of the comment.
CreatedOn Datetime The created date.
CreatedBy complex The user reference to the user who added this comment.
InsertedBy string Who added the comment. Possible values are User, System

CreatedBy Properties

Property Type Description
UserId string The unique id of the user who added the comment.
UserName string The username, i.e. the name the user uses to login to the system. For example "jjansen01".
Name string The actual name of the user, for example "Jan Jansen".
_links Array A list of useful preconfigured uri's a client app can use to navigate this resource collection.

For details on collections see collection details.

Example response:

{
    "comments": [
        {
            "text": "Great upload, i will take a look.",
            "createdOn": "2014-10-13T13:20:54",
            "createdBy": {
                "userId": "3e00a63f-d793-4237-92c0-cd2dde243a12",
                "userName" : "jjansen01",
                "name" : "Jan Jansen",
                "_links": [
                    {
                        "rel": "self",
                        "href": "http://api.basecone.com/users/3e00a63f-d793-4237-92c0-cd2dde243a12"
                    }
                ],
            "insertedBy": "User"
            }
        },
        {
            "text": "Could you adjust the description to be more accurate ?",
            "createdOn": "2014-10-13T13:20:23",
            "createdBy": {
                "userId": "3e00a63f-d793-4237-92c0-cd2dde243a12",
                "userName" : "jjansen01",
                "name" : "Jan Jansen",
                "_links": [
                    {
                        "rel": "self",
                        "href": "http://api.basecone.com/users/3e00a63f-d793-4237-92c0-cd2dde243a12"
                    }
                ],
            "insertedBy": "User"
            }
        }
    ],
    "_links": [
        {
            "rel": "self",
            "href": "http://api.basecone.com/documents/20124957-a908-4552-8f4f-9e849199d1df/comments"
        }
    ],
    "_metadata": {
        "total": 2,
        "count": 2
    }
}