This API call updates an existing change and returns it.
HTTP-, API- or Beetil-specific errors will be returned otherwise.
- API URL
- https://youraccount.beetil.com/external_api/v1/changes/:id.format
- HTTP Method
- PUT
URL parameters
| Parameter | Format | Default | Mandatory |
|---|---|---|---|
| idThe change's reference number. | integer | Yes |
PUT parameters
| Parameter | Format | Default | Mandatory |
|---|---|---|---|
| title | string | No | |
| service_id | integer | No | |
| 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_at | date | No | |
| implementation_completed_by_user_id | integer | No | |
| test_due_date | date | No | |
| test_completed_at | date | 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 | |
| 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 |
These parameters are encapsulated into a 'change' parameter. See the examples below.
Example PUT
{
"change": {
"title": "foo bar baz",
"implementation_completed_at": "15 Feb 2011, 14:12",
"service_id": 2,
"due_date": "10 Feb 2011, 15:38",
"implementation_completed_by_user_id": 12
}
}Example PUT 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