Change Types API
List Change Types
List all change types for an account:
GET /change_types
Response
Status: 200 OK
[
{
"id": 2,
"sourceID": null,
"reference": "application_change",
"name": "Application Change",
"description": "",
"position": 1,
"created_at": "2016-12-23T05:09:03-06:00",
"updated_at": "2016-12-23T05:09:03-06:00"
},
{
"id": 3,
"sourceID": null,
"reference": "infrastructure_change",
"name": "Infrastructure Change",
"description": "",
"position": 2,
"created_at": "2016-12-23T05:09:03-06:00",
"updated_at": "2016-12-23T05:09:03-06:00"
}
]
The response contains these fields by default. Filtering and pagination are available to reduce/limit the collection of change types.
Collection Fields
By default the following fields will appear in collections of change types:
id
sourceID
reference
name
description
position
created_at
updated_at
Obtain a different set of fields using the ?fields=parameter.
Sorting
By default a collection of change types is sorted ascending by id
.
The following fields are accepted by the ?sort=parameter:
id
sourceID
reference
name
position
created_at
updated_at
Get a single change type
GET /change_types/:id
Response
Status: 200 OK
{
"attachments": [
],
"created_at": "2016-12-23T05:09:03-06:00",
"description": "",
"disabled": false,
"id": 2,
"information": "Default change type for application changes",
"name": "Application Change",
"position": 1,
"reference": "application_change",
"source": null,
"sourceID": null,
"updated_at": "2016-12-23T05:09:03-06:00"
}
The response contains these fields.
Create a change type
POST /change_types
When creating a new change type these fields are available.
Response
Status: 201 Created
{
"id": "...",
"...": "..."
}
The response contains all fields of the created change type and is similar to the response in Get a single change type
Update a change type
PATCH /change_types/:id
When updating a change type these fields are available.
Response
Status: 200 OK
{
"id": "...",
"...": "..."
}
The response contains all fields of the updated change type and is similar to the response in Get a single change type
Fields
- attachments
- Readonly aggregated Attachments
- created_at
- Readonly datetime — The date and time at which the change type was created.
- description
- Optional string (max 255) — The Description field is used to enter a very short description of the change type, for example “More than 200 workdays or $200K”.
- disabled
- Optional boolean, default:
false
— The Disabled box is checked when the change type may not be related to any more changes. - id
- Readonly integer — The unique ID of the change type.
- information
- Optional text (max 64KB) — The Information field is used to add any additional information about the change type that might prove useful, especially for change managers when they need to decide which change type to select for a change.
- name
- Required string (max 128) — The Name field is used to enter the name of the change type. Ideally the name of a change type consists of a single word, such as “Large”.
- position
- Optional integer — The Position field dictates the position that the change type takes when it is displayed in a sorted list.
- reference
- Readonly string (max 128) — The Reference field is automatically set to the Name field value, written in lower case characters and with all spaces replaced by the underscore character. This reference can be used to link the change type to a change using the 4me REST API or the 4me Import functionality.
- source
- Optional string (max 30) - See source
- sourceID
- Optional string (max 128) - See source
- updated_at
- Readonly datetime — The date and time of the last update of the change type. If the change type has no updates it contains the
created_at
value.