This API call returns a more detailed result for the note.
- API URL
- https://youraccount.beetil.com/external_api/v1/:parent/:parent_id/:type/:id.format
- HTTP Method
- GET
URL parameters
| Parameter | Format | Default | Mandatory |
|---|---|---|---|
| parentThe name of the parent the note belongs to (see points of interest). | string | Yes | |
| parent_idThe id of the parent the note belongs to (see points of interest). | integer | Yes | |
| typeThe note type (see points of interest). | string | Yes | |
| id | integer | Yes |
Points of Interest
- Notes never exist stand-alone; they always belongs to a parent.
- Incidents can have notes of type: symptom, resolution or comment.
Example uri: /external_api/v1/incidents/123/symptoms/321
Example uri: /external_api/v1/incidents/123/resolutions/321
Example uri: /external_api/v1/incidents/123/comments/321 - Config Items can have notes of type: comment.
Example uri: /external_api/v1/config_items/123/comments/321 - Problems can have notes of type: symptom, comment, root_cause and workaround.
Example uri: /external_api/v1/problems/123/symptoms/321
Example uri: /external_api/v1/problems/123/comments/321
Example uri: /external_api/v1/problems/123/root_causes/321
Example uri: /external_api/v1/problems/123/workarounds/321 - Changes can have notes of type: description, reason, comment, change_need, implementation_change_instructions, implementation_progress_notes.
Example uri: /external_api/v1/changes/123/descriptions/321
Example uri: /external_api/v1/changes/123/reasons/321
Example uri: /external_api/v1/changes/123/comments/321
Example uri: /external_api/v1/changes/123/change_needs/321
Example uri: /external_api/v1/changes/123/implementation_change_instructions/321
Example uri: /external_api/v1/changes/123/implementation_progress_notes/321 - Change Issues can have notes of type: comment and issue_comment
Example uri: /external_api/v1/changes/123/issues/23/comments/87
Example uri: /external_api/v1/changes/123/isuses/23/issue_comments/87 - Releases can have notes of type: component, comment, instruction, backout and review_instructions
Example uri: /external_api/v1/releases/123/components/321
Example uri: /external_api/v1/releases/123/comments/321
Example uri: /external_api/v1/releases/123/instructions/321
Example uri: /external_api/v1/releases/123/backouts/321
Example uri: /external_api/v1/releases/123/review_instructions/321 - Special case: Change Tester Issues can have notes of type: comment and issue_comment
Example uri: /external_api/v1/changes/123/testers/34/issues/23/comments/87
Example uri: /external_api/v1/changes/123/testers/34/isuses/23/issue_comments/87 - Special case: Release Issues can have notes of type: comment and issue_comment
Example uri: /external_api/v1/releases/123/issues/23/comments/87
Example uri: /external_api/v1/releases/123/isuses/23/issue_comments/87 - Special case: Release Records can have notes of type: comment and record_note
Example uri: /external_api/v1/releases/123/release_records/67/comments/41
Example uri: /external_api/v1/releases/123/release_records/67/record_notes/168
Example JSON Response
{
"result": {
"symptom": {
"created_at": "2008-05-15T21:52:24Z",
"updated_at": "2008-05-15T21:52:24Z",
"id": 970,
"note": "The funky tab thing on record incident does not quite work. Maybe it is me being stupid but no matter how hard I try it just does not do it
",
"user": {
"user_link": "/external_api/v1/users/18",
"avatar": {
"public_filename": "/avatars/get/67/ca/67ca168dcb91d0e315bdaf440b6137dc76103ca1/image_png/Picture_1.png"
},
"id": 18,
"full_name": "Dan Lee",
"last_name": "Lee",
"first_name": "Dan"
},
"external_email": ""
}
},
"version": "1.0",
"status": "Success"
}Last updated 31 January 2011