Comment
self
LINK RELATION
Actions
| method | description |
|---|---|
| GET | View comment |
| OPTIONS | Retrieve supported HTTP methods |
Request parameters
No request parameters.
Profile
A Comment represents part of an ongoing discussion.
Properties
| name | type |
|---|---|
| id | string |
| body | text |
| created_at | ISO 8601 |
| tags1 | array(string) |
1
Only allowed characters: Alphanumeric, underscore, hyphen, colon, plus, dot.
Regular expression: [a-zA-Z0-9_\-:+.]+
Only Field comment tags are currently supported.
Link relations
| rel | conditional |
|---|---|
| self | false |
| ch:application1 | true |
| ch:bank_account1 | true |
| ch:company1 | true |
| ch:contact1 | true |
| ch:dispute1 | true |
| ch:file1 | true |
| ch:person1 | true |
| ch:website1 | true |
1
Presence depends on comment context.
Embedded
Additional semantics
No additional semantics.
Example representation
{
"id": "fc986fa5-fb03-4ea2-b9cd-693c4cf1ae65",
"body": "test comment",
"tags": [
"ch-field:additional_information"
],
"created_at": "2016-09-10T20:16:36.757Z",
"_links": {
"self": {
"href": "https://merchant.test.clearhaus.com/comments/fc986fa5-fb03-4ea2-b9cd-693c4cf1ae65"
},
"ch:application": {
"href": "https://merchant.test.clearhaus.com/applications/c6d9153b-32cb-472a-9dc9-553e9c79ea22"
},
"curies": [
{
"href": "https://developer.clearhaus.com/rels/{rel}",
"templated": true,
"name": "ch"
}
]
},
"_embedded": {
"author": {
"name": "Mia M. Lassen",
"email": "MiaMLassen@example.com"
}
}
}