| Anchor | ||||
|---|---|---|---|---|
|
...
GET (Using Query Parameters)
This GET service will return a list of Change Management Systems in the form of JSON objects based on the query parameters code, name, and Change Management System type. Change Management Systems are only returned if they match ALL of the specified query parameters. If no query parameters are given this request will return the entire list of Change Management Systems.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/topology/integrations/changemanagement? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:instanceCode={code} instanceName={name} cmssystemnamecmsSystemName={cmssystemname} Examples:To specify the code parameter only:http://host:port/flexdeploy/rest/topology/integrations/changemanagement?instanceCode={code} To specify the code and name parameters:http://host:port/flexdeploy/rest/topology/integrations/changemanagement?instanceCode={code}&instanceName={name} To specify the issue tracking system name only:http://host:port/flexdeploy/rest/topology/integrations/changemanagement?cmssystemNamecmsSystemName={cmssystemName} |
| Tip |
|---|
The query parameters are not case sensitive. Searching by instanceName=NAME is the same as searching by instanceName=name. |
Parameters
Parameter | Type | Required | Description |
|---|---|---|---|
| instanceCode | URL | No | This is a URL query parameter for the instance code which is used to search the change management systems. |
| instanceName | URL | No | This is a URL query parameter for the instance name which is used to search the change management systems. |
| cmssystemNamecmsSystemName | URL | No | This is a URL query parameter for the change management system name which is used to search the change management systems. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Change Management System Instances were found and returned |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Unexpected internal server error |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": null,
"instanceCode": "CMS Code",
"instanceName": "CMS Name",
"cmssystemId": 1,
"description": "CMS Post",
"isActive": true,
"properties":
[
{
"propertyName": "SN_PASSWORD",
"propertyValue": "ThePassword"
},
{
"propertyName": "SN_PORT",
"propertyValue": "1234"
},
{
"propertyName": "SN_REJECTED_SCRIPT",
"propertyValue": "rejectedScript.bat"
},
{
"propertyName": "SN_APPROVED_SCRIPT",
"propertyValue": "approvedScript.bat"
},
{
"propertyName": "SN_DONT_POLL",
"propertyValue": "true"
},
{
"propertyName": "SN_URL",
"propertyValue": "http://myServiceNow.atlassian.net"
},
{
"propertyName": "SN_USER_NAME",
"propertyValue": "username"
}
]
} |
the following Change Management System will be created in the database and returned. Notice the updated Instance Id field and hidden password.
...
This PUT service will update all attributes of an Change Management System with the given Id based on the attributes of the supplied JSON object.
...
Parameters
Attributes | Type | Required | Description |
|---|---|---|---|
| Instance Id | Integer | No | Primary ID of the Change Management System, created when first making a Change Management System. |
| Instance Code | String | Yes | The code of the Change Management System. Must be Unique |
| Instance Name | String | Yes | The name of the Change Management System. Must be Unique. |
| Change Management System ID | Integer | Yes | The ID of the type of Change Management System. |
| Description | String | No | The description of the Change Management System. |
| isActive | Boolean | No | Whether or not this Change Management System is active. Defaults to true. |
| Properties | List<Property> | Dependent | The properties associated with the type of Change Management System: requirements depend on the Change Management System selected. |
Response Code
HTTP Code | Description |
|---|---|
| 200 | Change Management System Updated |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Change Management System not found |
| 500 | Unexpected internal server error |
Example
If we had a Change Management System in our database with an Id of 11223 and had the following attributes
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": 11223,
"instanceCode": "CMS Code",
"instanceName": "CMS Name",
"cmssystemId": 1,
"description": "JSON of data before a PUT has occurred",
"isActive": true,
"properties":
[
{
"propertyName": "SN_PASSWORD",
"propertyValue": "*****"
},
{
"propertyName": "SN_PORT",
"propertyValue": "1234"
},
{
"propertyName": "SN_REJECTED_SCRIPT",
"propertyValue": "rejectedScript.bat"
},
{
"propertyName": "SN_APPROVED_SCRIPT",
"propertyValue": "approvedScript.bat"
},
{
"propertyName": "SN_DONT_POLL",
"propertyValue": "true"
},
{
"propertyName": "SN_URL",
"propertyValue": "http://myServiceNow.atlassian.net"
},
{
"propertyName": "SN_USER_NAME",
"propertyValue": "username"
}
]
} |
When we run a PUT request at the following URL
http://host:port/flexdeploy/rest/topology/integrations/changemanagement/11223
And the PUT request receives the following JSON Change Management System object,
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": null,
"instanceCode": "New CMS Code",
"instanceName": "New CMS Name",
"cmssystemId": 1,
"description": "New CMS Description",
"isActive": true,
"properties":
[
{
"propertyName": "SN_PASSWORD",
"propertyValue": "newPassword"
},
{
"propertyName": "SN_PORT",
"propertyValue": "1234"
},
{
"propertyName": "SN_REJECTED_SCRIPT",
"propertyValue": "rejectedScript.bat"
},
{
"propertyName": "SN_APPROVED_SCRIPT",
"propertyValue": "approvedScript.bat"
},
{
"propertyName": "SN_DONT_POLL",
"propertyValue": "true"
},
{
"propertyName": "SN_URL",
"propertyValue": "http://myServiceNow.atlassian.net"
},
{
"propertyName": "SN_USER_NAME",
"propertyValue": "newUser"
}
]
} |
The PUT request would then update the Change Management System with Id 11223 and return the following JSON Change Management System object.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": 11223,
"instanceCode": "New CMS Code",
"instanceName": "New CMS Name",
"cmssystemId": 1,
"description": "New CMS Description",
"isActive": true,
"properties":
[
{
"propertyName": "SN_PASSWORD",
"propertyValue": "****"
},
{
"propertyName": "SN_PORT",
"propertyValue": "1234"
},
{
"propertyName": "SN_REJECTED_SCRIPT",
"propertyValue": "rejectedScript.bat"
},
{
"propertyName": "SN_APPROVED_SCRIPT",
"propertyValue": "approvedScript.bat"
},
{
"propertyName": "SN_DONT_POLL",
"propertyValue": "true"
},
{
"propertyName": "SN_URL",
"propertyValue": "http://myServiceNow.atlassian.net"
},
{
"propertyName": "SN_USER_NAME",
"propertyValue": "newUser"
}
]
} |
...
This PATCH service will update the information of the Change Management System of the specified Id with the non-null parameters of the JSON. The parameters that are null will not be changed in the Change Management System.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/topology/integrations/changemanagement/{Id} |
...
HTTP Code | Description |
|---|---|
| 200 | Change Management System Updated |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Change Management System not found |
| 500 | Unexpected internal server error |
Example
If we had an Change Management System in our database with an Id of 11223 and had the following attributes
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": 11223,
"instanceCode": "NewCMSCode",
"instanceName": "NewCMSName",
"cmssystemId": 1,
"description": "JSON of data before a PATCH has occurred",
"isActive": true,
"properties":
[
{
"propertyName": "SN_PASSWORD",
"propertyValue": "ThePassword"
},
{
"propertyName": "SN_PORT",
"propertyValue": "1234"
},
{
"propertyName": "SN_REJECTED_SCRIPT",
"propertyValue": "rejectedScript.bat"
},
{
"propertyName": "SN_APPROVED_SCRIPT",
"propertyValue": "approvedScript.bat"
},
{
"propertyName": "SN_DONT_POLL",
"propertyValue": "true"
},
{
"propertyName": "SN_URL",
"propertyValue": "http://myServiceNow.atlassian.net"
},
{
"propertyName": "SN_USER_NAME",
"propertyValue": "username"
}
]
} |
When we run a PATCH request at the following URL
http://host:port/flexdeploy/rest/topology/integrations/changemanagement/11223
And the PATCH request receives the following JSON Change Management System object,
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": null,
"instanceCode": null,
"instanceName": "NewNameFromPatch",
"cmssystemId": null,
"description": null,
"isActive": null,
"properties":
[
{
"propertyName": "SN_PASSWORD",
"propertyValue": "newpassword"
}
]
} |
The PATCH request would then update the Change Management System with Id 11223 and return the following JSON Change Management System object.
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"instanceId": 11223,
"instanceCode": "CMS Code",
"instanceName": "NewNameFromPatch",
"cmssystemId": 1,
"description": "JSON of data before a PATCH has occurred",
"isActive": true,
"properties":
[
{
"propertyName": "SN_PASSWORD",
"propertyValue": "*****"
},
{
"propertyName": "SN_PORT",
"propertyValue": "1234"
},
{
"propertyName": "SN_REJECTED_SCRIPT",
"propertyValue": "rejectedScript.bat"
},
{
"propertyName": "SN_APPROVED_SCRIPT",
"propertyValue": "approvedScript.bat"
},
{
"propertyName": "SN_DONT_POLL",
"propertyValue": "true"
},
{
"propertyName": "SN_URL",
"propertyValue": "http://myServiceNow.atlassian.net"
},
{
"propertyName": "SN_USER_NAME",
"propertyValue": "username"
}
]
} |
...