Examples

GET /api/v2/annotations/16
200
{
  "data": {
    "id": "16",
    "type": "annotations",
    "links": {
      "self": "http://test.host/api/v2/annotations/16"
    },
    "attributes": {
      "message": "MyString",
      "annotable-attribute": "executive_summary",
      "section-id": 11,
      "is-starred": false,
      "is-secret": false,
      "created-at": "2017-08-29T10:49:29.421+08:00"
    },
    "relationships": {
      "annotator": {
        "links": {
          "self": "http://test.host/api/v2/annotations/16/relationships/annotator",
          "related": "http://test.host/api/v2/annotations/16/annotator"
        }
      },
      "annotable": {
        "links": {
          "self": "http://test.host/api/v2/annotations/16/relationships/annotable",
          "related": "http://test.host/api/v2/annotations/16/annotable"
        }
      }
    }
  }
}

Params

Param name Description
id
required

Annotation ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.