Comments
ch:comments
LINK RELATION
,
EMBEDDED RELATION
Actions
| method | description |
|---|---|
| GET | View comments collection |
| POST | Create new comment |
| OPTIONS | Retrieve supported HTTP methods |
Request parameters
| property | type | required | method |
|---|---|---|---|
| body | text | true | POST |
| tags | array(string) | false | POST |
| page1 | integer | false | GET |
| per_page1 | integer | false | GET |
1
See Pagination for details.
Profile
The Comments resource represents a collection of Comment resources.
Properties
| name | type | read-only |
|---|---|---|
| count | integer | true |
| page | integer | true |
| per_page | integer | true |
Link relations
| rel | conditional |
|---|---|
| self | false |
| first | true |
| last | true |
| prev | true |
| next | true |
| 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
This collection is paginated. See Pagination.
Example representation
{
"count": 1,
"page": 1,
"per_page": 20,
"_links": {
"self": {
"href": "https://merchant.test.clearhaus.com/disputes/c6d9153b-32cb-472a-9dc9-553e9c79ea22/comments"
},
"ch:dispute": {
"href": "https://merchant.test.clearhaus.com/disputes/c6d9153b-32cb-472a-9dc9-553e9c79ea22"
},
"curies": [
{
"href": "https://developer.clearhaus.com/rels/{rel}",
"templated": true,
"name": "ch"
}
]
},
"_embedded": {
"ch:comments": [...]
}
}