This API call creates a change and returns it.
HTTP-, API- or Beetil-specific errors will be returned otherwise.
- API URL
- https://youraccount.beetil.com/external_api/v1/changes.format
- HTTP Method
- POST
POST parameters
| Parameter | Format | Default | Mandatory |
|---|---|---|---|
| title | string | Yes | |
| service_id | integer | Yes | |
| type_id | integer | provided by the service, incident or problem | No |
| assigned_user_id | integer | the authenticated user | No |
| priority_id | integer | provided by the service | No |
| closed_by_user_id | integer | No | |
| closure_code | integer | No | |
| closure_comment | string | No | |
| closed_at | date | No | |
| customer_viewable | boolean | No | |
| implementation_due_date | date | No | |
| implementation_completed | boolean | No | |
| implementation_completed_by_user_id | integer | No | |
| test_due_date | date | No | |
| test_completed | boolean | No | |
| test_completed_by_user_id | integer | No | |
| complexity | string | No | |
| risk | string | No | |
| est_hrsEstimated hours for this change. | string | No | |
| estimated_hoursAlias for est_hrs | string | No | |
| build_due_atDue date for the change's implementation | dagte | No | |
| test_due_atDue date for the change's test | dagte | No | |
| submitted_for_approval_at | date | No | |
| submitted_for_approval_by_user_id | integer | No | |
| approved_at | date | No | |
| declined_at | date | No | |
| released_live_at | date | No | |
| ready_for_release_by_user_id | integer | No | |
| ready_for_release_at | date | No | |
| due_date | date | No | |
| due_live_at | date | No | |
| use_symptomsSet to true will copy all symptoms from the base incident or problem | boolean | No | |
| use_commentsSet to true will copy all comments from the base incident or problem | boolean | No | |
| use_resolutionsSet to true will copy all symptoms from the base incident | date | No | |
| use_root_causesSet to true will copy all symptoms from the base problem | date | No | |
| use_workaroundsSet to true will copy all symptoms from the base problem | date | No |
These parameters are encapsulated into a 'change' parameter. See the examples below.
Points of Interest
- To Close a Change ensure closed_at, closure_code and closure_comment are all present.
- To Re-open a Change ensure closed_at and closure_code are null.
- To Complete a Change's implementation set implementation_closed to true and implementation_completed_by_user_id to the proper user id.
- To Complete a Change's test set test_closed to true and test_completed_by_user_id to the proper user id.
- Status Codes: 1 = New, 2 = Submitted, 3 = Approved, 4 = Declined, 5 = Permanently Declined, 6 = Implementing, 7 = Released, 8 = Closed
- Closure Codes: 0 = Finished - Released Live, 1 = Unfinished - No longer relevant, 2 = Other Reason
- Complexity: 1 = Low, 2 = Medium, 3 = High
- Risk: 1 = Low, 2 = Medium, 3 = High
- Referencing other object ids (priority, type) are all included in full in the Show Service request.
Example POST
{
"change": {
"use_comments": true,
"title": "foo bar baz",
"service_id": 34,
"problem_id": 9,
"test_due_date": "16 Feb 2011, 11:35",
"implementation_due_date": "11 Feb 2011, 11:35"
}
}Example POST Response
{
"result": {
"company": "JSON string similar to GET changes/:id"
},
"version": "1.0",
"status": "Success"
}Example Error
{
"errors": [
{
"error": "[E400] title can't be blank"
}
],
"version": "1.0",
"status": "Failed"
}Last updated 31 January 2011