Versions Compared

Old Version 2

changes.mady.by.user Tyler Georgia

Saved on

compared with

New Version 3

changes.mady.by.user Tyler Georgia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated documentation to more closely follow stylistic consistencies

Change Management System Definition

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.

Property Definition

NameTypeDescription
propertyNameStringA name corresponding to the property type.
propertyValueStringThe value associated with the corresponding property type.

GET

Info
titleBase URL for Change Management System REST API

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

The information 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 Managemente Management Systems.

Example Output

...

Code Block
themeEclipse
titleCMS: 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
}

...