Connect to ServiceNow

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameConnect to ServiceNow
Description

If you create or edit an existing ServiceNow extension on the CloudCenter platform, you must explicitly Connect to establish or re-establish the connection to the ServiceNow instance

Allowed Role(s)WM_USER
MethodPOST
URI

v1/extensions/connectServiceNowExtension

cloudcenter-ccm-backend/api/v1/extensions/connectServiceNowExtension

Sample Request
curl -k -X POST -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB" https://<HOST>:<PORT>/v1/extensions/connectServiceNowExtension"
curl -k -X POST -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB" https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/extensions/connectServiceNowExtension"
Release

Introduced in CloudCenter 4.8.2

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • The ServiceNow URL and credentials to connect to the ServiceNow instance must already be up and running before a CloudCenter tenant admin can successfully configure the ServiceNow extension.
  • If you edit the ServiceNow extension, you must also explicitly Connect to re-establish the connection to the ServiceNow instance.
  • The password parameter is displayed in clear text for users with write or admin access. For all other users, the CloudCenter platform displays ===redacted=== in the password attribute.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: create.extensions.serviceNow.extensionId.connectServiceNowExtension

See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Request

{
    "serviceNowUrl":"ven01317.service-now.com",
    "username":"c3.integration",
    "password":"===redacted===",
}

Response – Success

The Server responds with HTTP response code 200 Success if the ServiceNow Extension connection is successful.

Response – Failure

{
    "errors": [
        {
            "code": "FAILED_TO_CONNECT_TO_SERVICE_NOW_EXTENSION",
            "message": "Failed to connect to the ServiceNow instance."
        }
    ]
}

Request Attributes

serviceNowUrl
  • Description: The URL associated with the ServiceNow instance.

    This is not the URL to access the CloudCenter platform

  • Type: String

username
  • Description: The username of the admin user for the ServiceNow instance.
  • Type: String

password
  • Description: The password of the admin user for the ServiceNow instance.
  • Type: String

Response Attributes

None for success scenarios.

The displayed error for failure scenarios.


Terms & Conditions Privacy Statement Cookies Trademarks