...
| Name | Type | Description |
|---|---|---|
| id | Long | The id of the change management system. |
| name | String | The name of the change management system. |
| properties | List<Properties> | A list of properties associated with the corresponding Change Management System. |
| ticketFields | List<CMSField> | All the related CMS Field's which are tickets. |
| incidentFields | List<CMSField> | All the related CMS Field's which are incidents. |
| requireRequestForDeployment | Boolean | Whether a request is required for deployment. |
| autoCreateRequestForApproval | Boolean | Whether to create a request for approval. |
| createIncidentOnDeploymentFail | Boolean | Whether to create an incident when a deployment fails. |
Properties definition has following attributes.
| Name | Type | Description |
|---|---|---|
| name | String | Name of property. |
| displayName | String | Display name of property |
| dataType | String | Data type for property |
| description | String | Description for property |
| isRequired | Boolean | True if property is required |
| isEncrypted | Boolean | True if property value will be encrypted |
| isActive | Boolean | True if property is active |
CMSField definition.
| Name | Type | Description |
|---|---|---|
| code | String | Code for the field |
| displayName | String | Display name |
| description | String | Description |
| dataType | String | Datatype of the field |
| isRequired | Boolean | If the field is requried |
| isActive | Boolean | If the field is active |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Search successful and results returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"name": "ServiceNow",
"properties": [
{
"name": "SN_URL",
"displayName": "ServiceNow URL",
"description": "ServiceNow URL",
"dataType": "String",
"isActive": true,
"isRequired": true,
"isEncrypted": false
},
{
"name": "SN_PORT",
"displayName": "ServiceNow Port",
"description": "ServiceNow Port",
"dataType": "String",
"isActive": true,
"isRequired": true,
"isEncrypted": false
},
{
"name": "SN_USER_NAME",
"displayName": "ServiceNow User Name",
"description": "ServiceNow User Name",
"dataType": "String",
"isActive": true,
"isRequired": true,
"isEncrypted": false
},
{
"name": "SN_PASSWORD",
"displayName": "ServiceNow Password",
"description": "ServiceNow Password",
"dataType": "String",
"isActive": true,
"isRequired": true,
"isEncrypted": true
},
{
"name": "SN_APPROVED_SCRIPT",
"displayName": "Approved Check Script",
"description": "ServiceNow approved check Groovy script",
"dataType": "String",
"isActive": true,
"isRequired": false,
"isEncrypted": false
},
{
"name": "SN_REJECTED_SCRIPT",
"displayName": "Rejected Check Script",
"description": "ServiceNow rejected check Groovy script",
"dataType": "String",
"isActive": true,
"isRequired": false,
"isEncrypted": false
},
{
"name": "SN_DONT_POLL",
"displayName": "Don't poll",
"description": "Disable automatic polling (every minute) of ServiceNow tickets for status changes. Check if using REST API to communicate status changes to FlexDeploy.",
"dataType": "Boolean",
"isActive": true,
"isRequired": false,
"isEncrypted": false
}
],
"id": 1,
"requireRequestForDeployment": false,
"autoCreateRequestForApproval": false,
"createIncidentOnDeploymentFail": false,
"incidentFields": [
{
"displayName": "Test",
"description": "",
"isRequired": false,
"isActive": true,
"dataType": "String",
"code": "TEST"
}
],
"ticketFields": [
{
"displayName": "Test2",
"description": "Description",
"isRequired": false,
"isActive": true,
"dataType": "Integer",
"code": "CODE"
}
]
}
] |