// removed jquery ui css and js

Connect to ServiceNow

Details

API Details
Name

Connect to ServiceNow

Description

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

MethodPOST
URI

v1/extensions/connectServiceNowExtension

CloudCenter Release
  • Introduced in CloudCenter 4.8.2
Notes

General Notes:

  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.

API Notes:

  • 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.
ESB Header

action: create.extensions.serviceNow.extensionId.connectServiceNowExtension

Example

curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB" https://<HOST>:<PORT>/v1/extensions/connectServiceNowExtension"

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.


© 2017-2018 Cisco Systems, Inc. All rights reserved