ServiceNow Component
Create records and incidents within ServiceNow
Component key: servicenow
Description
ServiceNow is platform that helps you manage digital workflows. The ServiceNow component gives you the ability to insert table records and incidents on the platform.
Connections
OAuth 2.0 Authorization Code
Input | Notes |
---|---|
Authorize URL string / Required authorizeUrl | The OAuth 2.0 Authorization URL for ServiceNow |
Client ID string / Required clientId | Client Identifier of your app for ServiceNow |
Client Secret password / Required clientSecret | Client Secret of your app for ServiceNow |
Scopes string scopes | Space separated OAuth 2.0 permission scopes for ServiceNow |
Token URL string / Required tokenUrl | The OAuth 2.0 Token URL for ServiceNow |
Basic Username/Password
Input | Notes |
---|---|
Password password / Required password | Password |
Username string / Required username | Username |
Data Sources
Select Table
Select a table from the list of tables in ServiceNow. Returns the sys_id of the selected table. | key: selectTable | type: picklist
Input | Notes | Example |
---|---|---|
Connection connection / Required connection | ||
Instance URL string / Required instanceUrl | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com |
Actions
Create Incident
Creates an Incident with the specified field names and values | key: createIncident
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Values string / Required Key Value List fieldValuesInput | The names of the fields and their values to use when creating a record | ||
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com |
Create Table Record
Creates a record in the specified table with the specified field names and values | key: createTableRecord
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Values string / Required Key Value List fieldValuesInput | The names of the fields and their values to use when creating a record | ||
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Table string / Required tableNameInput | The name of the ServiceNow table in which to create a record | incident |
Create User
Creates a User with the specified field names and values | key: createUser
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Email string email | The Email of the User | ||
Values string Key Value List fieldValuesInputNonRequired | The names of the fields and their values to use when creating a record | ||
First Name string firstName | The User's First Name | ||
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Last Name string lastName | The User's Last Name | ||
User Id string userName | The Username of the User |
Delete Attachment
This method deletes the attachment with a specific sys_id value. | key: deleteAttachment
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | Sys_id value of the attachment to delete. | d71f7935c0a8016700802b64c67c11c6 |
Example Payload for Delete Attachment
{
"data": ""
}
Delete Incident
Delete an Incident | key: deleteIncident
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 |
Delete Table Record
Delete a record for a given ID in the specified Table | key: deleteTableRecord
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 | |
Table string / Required tableNameInput | The name of the ServiceNow table in which to create a record | incident |
Delete User
Deletes a User | key: deleteUser
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 |
Get Attachment
Returns the metadata for the attachment file with a specific sys_id value. | key: getAttachment
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 |
Example Payload for Get Attachment
{
"data": {
"result": {
"table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
"size_bytes": "462",
"download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file",
"sys_updated_on": "2009-05-21 04:12:21",
"sys_id": "615ea769c0a80166001cf5f2367302f5",
"image_height": "",
"sys_created_on": "2009-05-21 04:12:21",
"file_name": "blocks.swf",
"sys_created_by": "glide.maint",
"compressed": "true",
"average_image_color": "",
"sys_updated_by": "glide.maint",
"sys_tags": "",
"table_name": "content_block_programmatic",
"image_width": "",
"sys_mod_count": "0",
"content_type": "application/x-shockwave-flash",
"size_compressed": "485"
}
}
}
Get Attachment File
Returns the binary file attachment with a specific sys_id value. | key: getAttachmentFile
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 |
Example Payload for Get Attachment File
{
"data": {
"type": "Buffer",
"data": [
102,
105,
108,
101,
32,
99,
111,
110,
116,
101,
110,
116,
115
]
}
}
Get Incident
Gets an Incident by ID | key: getIncident
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 |
Get Knowledge Article
Returns specific knowledge article content and its field values. | key: getKnowledgeArticle
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Article ID string / Required articleId | Sys_id or knowledge base (KB) number of a knowledge article in the Knowledge [kb_knowledge] table. | KB0012345 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results. | active,sys_id | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Language string language | List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. | en | |
Search ID string searchId | Optional unless using the 'Search Rank' input. Unique identifier of search that returned this article. You can retrieve this value (articles.id element) using the 'List Knowledge Articles' action. | kb_knowledge:3b0fccee0a0a0b9b00d34b36ea41a43e | |
Search Rank string searchRank | Optional unless using the 'Search ID' input. Article search rank by click-rate (articles.rank) that you can retrieve using the 'List Knowledge Articles' action. | 1 | |
Update View boolean updateView | false | Update view count and record an entry for the article in the Knowledge Use [kb_use] table. |
Get Knowledge Article Attachment
Returns a knowledge article attachment as a file. | key: getKnowledgeArticleAttachment
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Article Sys ID string / Required articleSysId | Sys_id of the knowledge article with the attachment you intend to retrieve. Located in the Knowledge Bases [kb_knowledge] table. | f2765f9fc0a8011b0120ec1b352bf09b | |
Attachment Sys ID string / Required attachmentSysId | Sys_id of record to which the attachment belongs. | f2765f9fc0a8011b0120ec1b352bf09b | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com |
Get Table Record
Get a record for a given ID in the specified Table | key: getTableRecord
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 | |
Table string / Required tableNameInput | The name of the ServiceNow table in which to create a record | incident |
Get User by Id
Gets a User by their Id | key: getUser
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 |
Get User by Username
Get a record for a given ID in the specified Table | key: getUserByUsername
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
User Id string userName | The Username of the User |
List Attachments
Returns the metadata for multiple attachments. | key: listAttachments
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sysparm Limit string sysparmLimit | Limit to be applied on pagination. Default is 1000. Unusually large values can impact system performance. | 100 | |
Sysparm Offset string sysparmOffset | Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records. | 0 | |
Sysparm Query string sysparmQuery | Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. | active=true^ORDERBYnumber^ORDERBYDESCcategory |
Example Payload for List Attachments
{
"data": {
"result": [
{
"table_sys_id": "5054b6f8c0a800060056addcf551ecf8",
"size_bytes": "462",
"download_link": "https://instance.service-now.com/api/now/attachment/615ea769c0a80166001cf5f2367302f5/file",
"sys_updated_on": "2009-05-21 04:12:21",
"sys_id": "615ea769c0a80166001cf5f2367302f5",
"image_height": "",
"sys_created_on": "2009-05-21 04:12:21",
"file_name": "blocks.swf",
"sys_created_by": "glide.maint",
"compressed": "true",
"average_image_color": "",
"sys_updated_by": "glide.maint",
"sys_tags": "",
"table_name": "content_block_programmatic",
"image_width": "",
"sys_mod_count": "0",
"content_type": "application/x-shockwave-flash",
"size_compressed": "485"
}
]
}
}
List Featured Knowledge Articles
Returns a list of the most-viewed knowledge articles and featured knowledge articles. | key: listFeaturedKnowledgeArticles
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results. | active,sys_id | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Knowledge Base Sys ID's string kb | Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to. | a7e8a78bff0221009b20ffffffffff17,a7e8a78bff0221009b20ffffffffff18 | |
Language string language | List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. | en | |
Limit string limit | Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval. | 100 | |
Offset string offset | Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to '0'. | 0 |
List Incidents
Gets a list of all Incidents | key: listIncidents
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sysparm Limit string sysparmLimit | Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset | 100 | |
Sysparm Offset string sysparmOffset | Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records. | 0 | |
Sysparm Query string sysparmQuery | Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. | active=true^ORDERBYnumber^ORDERBYDESCcategory |
List Knowledge Articles
Returns a list of knowledge base (KB) articles which can be searched and filtered using various parameters. | key: listKnowledgeArticles
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results. | active,sys_id | |
Filter string filter | Encoded query to use to filter the result set. | score=-1.0^ORDERBYnumber | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Knowledge Base Sys ID's string kb | Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to. | a7e8a78bff0221009b20ffffffffff17,a7e8a78bff0221009b20ffffffffff18 | |
Language string language | List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. | en | |
Limit string limit | Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval. | 100 | |
Offset string offset | Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to '0'. | 0 | |
Query string query | Text to search for, can be empty. | incident |
List Most Viewed Knowledge Articles
Returns a list of knowledge articles prioritized by most-viewed. | key: listMostViewedKnowledgeArticles
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Fields string fields | Comma-separated list of fields from the Knowledge [kb_knowledge] table to show details in results. | active,sys_id | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Knowledge Base Sys ID's string kb | Comma-separated list of knowledge base sys_ids from the Knowledge Bases [kb_knowledge_base] table to restrict results to. | a7e8a78bff0221009b20ffffffffff17,a7e8a78bff0221009b20ffffffffff18 | |
Language string language | List of comma-separated languages in two-letter ISO 639-1 language code format to restrict results to. Alternatively type 'all' to search in all valid installed languages on an instance. | en | |
Limit string limit | Maximum number of records to return. Unusually large limit values can impact system performance. For requests that exceed this number of records, use the Offset input to paginate record retrieval. | 100 | |
Offset string offset | Starting record index for which to begin retrieving records. Use this value to paginate record retrieval. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time this endpoint is called, offset is set to '0'. | 0 |
List Table Records
Lists records in the specified table | key: listTableRecords
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sysparm Limit string sysparmLimit | Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset | 100 | |
Sysparm Offset string sysparmOffset | Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records. | 0 | |
Sysparm Query string sysparmQuery | Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. | active=true^ORDERBYnumber^ORDERBYDESCcategory | |
Table string / Required tableNameInput | The name of the ServiceNow table in which to create a record | incident |
List Tables
Retrieve a list of all tables | key: listTables
Input | Default | Notes | Example |
---|---|---|---|
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sysparm Fields string sysparmFields | Comma-separated list of fields to return. If not specified, all fields are returned. | sys_id,label | |
Sysparm Limit string sysparmLimit | Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset | 100 | |
Sysparm Offset string sysparmOffset | Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records. | 0 | |
Sysparm Query string sysparmQuery | Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. | active=true^ORDERBYnumber^ORDERBYDESCcategory |
List Users
Gets a list of all Users | key: listUsers
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sysparm Limit string sysparmLimit | Max number of records to return. Large values can impact performance. For pagination with large data sets include the Sysparm Offset | 100 | |
Sysparm Offset string sysparmOffset | Starting record index for which to begin retrieving records. This functionality enables the retrieval of all records, regardless of the number of records, in small manageable chunks. For example, the first time you call this endpoint, sysparm_offset is set to '0'. To simply page through all available records, use sysparm_offset=sysparm_offset+sysparm_limit, until you reach the end of all records. | 0 | |
Sysparm Query string sysparmQuery | Encoded query used to filter the result set. Syntax: sysparm_query=<col_name><operator><value>. | active=true^ORDERBYnumber^ORDERBYDESCcategory |
Multipart Upload Attachment
Uploads a multipart file attachment. | key: multipartUploadAttachment
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
File string / Required file | The file to attach to the record. | ||
File Name string / Required fileName | Name to give the attachment. | issue_screenshot | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | Sys_id of the record on the specified table to which you want to attach the file. | d71f7935c0a8016700802b64c67c11c6 | |
Table string / Required tableNameInput | Name of the table to which you want to attach the file. | incident |
Example Payload for Multipart Upload Attachment
{
"data": {
"result": {
"table_sys_id": "d71f7935c0a8016700802b64c67c11c6",
"size_bytes": "36597",
"download_link": "https://instance.service-now.com/api/now/attachment/994adbc64f511200adf9f8e18110c796/file",
"sys_updated_on": "2016-02-02 14:00:21",
"sys_id": "994adbc64f511200adf9f8e18110c796",
"image_height": "",
"sys_created_on": "2016-02-02 14:00:21",
"file_name": "banner-CS0001345_v1_1.jpeg",
"sys_created_by": "admin",
"compressed": "true",
"average_image_color": "",
"sys_updated_by": "admin",
"sys_tags": "",
"table_name": "incident",
"image_width": "",
"sys_mod_count": "0",
"content_type": "image/jpeg",
"size_compressed": "25130"
}
}
}
Raw Request
Send raw HTTP request to ServiceNow | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Sys ID string sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 | |
Table string / Required tableNameInput | The name of the ServiceNow table in which to create a record | incident | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. |
Update Incident
Updates an Incident with the specified field names and values | key: updateIncident
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Values string / Required Key Value List fieldValuesInput | The names of the fields and their values to use when creating a record | ||
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 |
Update Table Record
Updates a record in the specified table with the specified field names and values | key: updateTableRecord
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Values string / Required Key Value List fieldValuesInput | The names of the fields and their values to use when creating a record | ||
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 | |
Table string / Required tableNameInput | The name of the ServiceNow table in which to create a record | incident |
Update User
Updates a User with the specified field names and values | key: updateUser
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
Email string email | The Email of the User | ||
Values string Key Value List fieldValuesInputNonRequired | The names of the fields and their values to use when creating a record | ||
First Name string firstName | The User's First Name | ||
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Last Name string lastName | The User's Last Name | ||
Sys ID string / Required sysId | The Sys ID of the record being queried | d71f7935c0a8016700802b64c67c11c6 | |
User Id string userName | The Username of the User |
Upload Attachment
Uploads a specified binary file as an attachment to a specified record. | key: uploadAttachment
Input | Default | Notes | Example |
---|---|---|---|
API Version string / Required apiVersionInput | The version of the ServiceNow API to use | v2 | |
Connection connection / Required connection | |||
Debug Request boolean debug | false | Enabling this flag will log out the current request. | |
File string / Required file | The file to attach to the record. | ||
File Name string / Required fileName | Name to give the attachment. | issue_screenshot | |
Instance URL string / Required instanceUrlInput | The URL of the specific ServiceNow instance to use for API requests | https://instance.service-now.com | |
Sys ID string / Required sysId | Sys_id of the record in the table specified in table_name that you want to attach the file to. | d71f7935c0a8016700802b64c67c11c6 | |
Table string / Required tableNameInput | Name of the table to attach the file to. | incident |
Example Payload for Upload Attachment
{
"data": {
"result": {
"average_image_color": "String",
"compressed": "String",
"content_type": "String",
"created_by_name": "String",
"download_link": "String",
"file_name": "String",
"image_height": "String",
"image_width": "String",
"size_bytes": "String",
"size_compressed": "String",
"sys_created_by": "String",
"sys_created_on": "String",
"sys_id": "String",
"sys_mod_count": "String",
"sys_tags": "String",
"sys_updated_by": "String",
"sys_updated_on": "String",
"table_name": "String",
"table_sys_id": "String",
"updated_by_name": "String"
}
}
}