Change Management Systems API

Owned by Tyler Georgia (Unlicensed)
Last updated: Apr 29, 2020 by Jay-Ar Brouillard
4 min read

Authentication - Use Basic Authentication for this API.

GET

API URL

http://host:port/flexdeploy/rest/v1/administration/changemanagementsystem

Information about available Change Management Systems can be accessed through this method. It returns the name, id, and information about the properties of all available Change Management Systems.

Request

No request parameters.

Response

NameTypeDescription
idLongThe id of the change management system.
nameStringThe name of the change management system.
propertiesList<Properties>A list of properties associated with the corresponding Change Management System.

Properties definition has following attributes.

NameTypeDescription
nameStringName of property.
displayNameStringDisplay name of property
dataTypeStringData type for property
descriptionStringDescription for property
isRequiredBooleanTrue if property is required
isEncryptedBooleanTrue if property value will be encrypted
isActiveBooleanTrue if property is active

Response Codes

HTTP Code
Description
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

CMS: ServiceNow
[
   {
   "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
   }
]
The following macros are not currently supported in the footer:
  • style