Versions Compared

Key

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

...


Tip

The query parameters are not case sensitive. Searching by instanceName=NAME is the same as searching by instanceName=name.

Request

Parameter
Type
Required
Description
instanceCodeQuery - StringNo

This is a URL query parameter for the instance code which is used to search the change management systems.

Equals ignore case search

instanceNameQuery - StringNo

This is a URL query parameter for the instance name which is used to search the change management systems.

Contains ignore case search

cmsSystemNameQuery - StringNo

This is a URL query parameter for the change management system name which is used to search the change management systems.

Equals ignore case search

Include Page
REST V1 CMS Instance Response
REST V1 CMS Instance Response

Response Codes

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

Example

If we had 2 Change Management System Instancse with Ids of 11101 and 11107 with the following attributes.

...