Custom API Action
Make a custom, authenticated HTTP call to the ServiceNow REST API. See ServiceNow API reference for more information on available operations.
Options
Field | Definition | Type | Required |
---|---|---|---|
Request Type |
These are supported HTTP request methods, or HTTP verbs, in a custom API call (see HTTP request methods).
|
Dropdown | TRUE |
The maximum number of records to return for a GET request is set by sysparm_limit
. See Table API GET for an example of sysparm_limit
. Warning: Unusually large sysparm_limit
values can impact system performance.
Input
Field | Definition | Type | Required |
---|---|---|---|
Relative URL |
URL address on the web server to which you are attempting to interact. Specify the relative URL as /{insert_remaining_URL}. You can specify query parameters in the relative URL using "?", or specify the query parameters as an object key pair in the Query input. For example, for the ServiceNow API endpoint, https://myservicenow11456.service-now.com/api/now/table/task, the relative URL is /api/now/table/task. |
String | TRUE |
Query |
The JSON object that determines the action taken at the URL.
Example: {"name":"something-urgent"} |
Object or String | FALSE |
Headers |
JSON that determines the content type of the request. This will usually be similar to the following:
Example: {"Content-type":"application/json"} |
Object | FALSE |
Output
Field | Definition | Type |
---|---|---|
Response | ||
Status Code | Result of the operation. The connector returns an HTTP status code that indicates whether the action taken by the card succeeded or failed. For example:
For a full list of possible status codes, see HTTP status codes. |
Number |
Headers | Detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will be usually similar to {"Content-type":"application/json"}. | Object |
Body |
Data returned from your selected HTTP request. For example, the data from a GET request. |
Object |