Versions Compared

Old Version 5

changes.mady.by.user Chandresh Patel

Saved on

compared with

New Version Current

changes.mady.by.user Hayden Mumm

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Include Page
REST V1 Authentication
REST V1 Authentication

Table of Contents
maxLevel1

GET

Info
title

...

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.

...

ticketFieldsList<CMSField>All the related CMS Field's which are tickets.
incidentFieldsList<CMSField>All the related CMS Field's which are incidents.
requireRequestForDeploymentBooleanWhether a request is required for deployment.
autoCreateRequestForApprovalBooleanWhether to create a request for approval.
createIncidentOnDeploymentFailBooleanWhether to create an incident when a deployment fails.

Properties definition has following attributes.

NameTypeDescription
propertyName
nameStringName of property
displayNameString
A
Display 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

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.

...

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

CMSField definition.

NameTypeDescription
codeStringCode for the field
displayNameStringDisplay name
descriptionStringDescription
dataTypeStringDatatype of the field
isRequiredBooleanIf the field is requried
isActiveBooleanIf the field 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

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,
	  "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"
            }
        ]
   }
]