Connectors Reference

ServiceNow

ServiceNow improves service levels, energizes employees, and enables your enterprise to work at lightspeed. Create, read and update records stored within ServiceNow including Incidents, Questions, Users and more.

 

Status: Preview

Tier: Premium

Version: 1.0.0

 

Actions:

Name

Summary

GetRecords (string type, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link, [advanced][Optional]string sysparm_query, [advanced][Optional]integer sysparm_limit, [advanced][Optional]integer sysparm_offset)

List Records

CreateRecord (string type, RecordBody body, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link)

Create Record

GetRecord (string type, string sysid, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link)

Get Record

UpdateRecord (string type, string sysid, RecordBody body, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link)

Update Record

DeleteRecord (string type, string sysid)

Delete Record

GetRecordTypes ()

Get Record Types

GetRecordSchema (string type)

Get Record Schema

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

GetRecordSchemaResponse

 

GetRecordsResponse

 

GetTypesResponse

 

RecordBody

 

SingleRecordResponse

 

 

Actions:

GetRecords

Summary: List Records

Description: Gets records of a certain ServiceNow object type like 'Incidents'

 

Syntax:

ServiceNow.GetRecords (string type, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link, [advanced][Optional]string sysparm_query, [advanced][Optional]integer sysparm_limit, [advanced][Optional]integer sysparm_offset)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Record Type)

Type of record to list

True

GetRecordTypes

sysparm_display_value

boolean

(Display System References)

 

False

sysparm_exclude_reference_link

boolean

(Exclude Reference Links)

 

False

sysparm_query

string

(Query)

Encoded query used to filter the result set. Example: active=true^ORDERBYnumber^ORDERBYDESCcategory

False

sysparm_limit

integer(int32)

(Limit)

Limit to be applied on pagination. The default is 10000.

False

sysparm_offset

integer(int32)

(Offset)

Number of records to exclude from the query.

False

 

Returns:

          Type:GetRecordsResponse

 

CreateRecord

Summary: Create Record

Description: Create a record in a ServiceNow table.

 

Syntax:

ServiceNow.CreateRecord (string type, RecordBody body, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Record Type)

Type of record to list

True

GetRecordTypes

body

RecordBody

 

 

True

sysparm_display_value

boolean

(Display System References)

 

False

sysparm_exclude_reference_link

boolean

(Exclude Reference Links)

 

False

 

Returns:

          Type:SingleRecordResponse

 

GetRecord

Summary: Get Record

Description: Gets a record for a ServiceNow object type like 'Incidents'

 

Syntax:

ServiceNow.GetRecord (string type, string sysid, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Record Type)

Type of record to list

True

GetRecordTypes

sysid

string

(System ID)

System ID for the record.

True

sysparm_display_value

boolean

(Display System References)

 

False

sysparm_exclude_reference_link

boolean

(Exclude Reference Links)

 

False

 

Returns:

          Type:SingleRecordResponse

 

UpdateRecord

Summary: Update Record

Description: Updates a record for a ServiceNow object type like 'Incidents'

 

Syntax:

ServiceNow.UpdateRecord (string type, string sysid, RecordBody body, [advanced][Optional]boolean sysparm_display_value, [advanced][Optional]boolean sysparm_exclude_reference_link)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Record Type)

Type of record to list

True

GetRecordTypes

sysid

string

(System ID)

System ID for the record.

True

body

RecordBody

 

 

True

sysparm_display_value

boolean

(Display System References)

 

False

sysparm_exclude_reference_link

boolean

(Exclude Reference Links)

 

False

 

Returns:

          Type:SingleRecordResponse

 

DeleteRecord

Summary: Delete Record

Description: Deletes a record for a ServiceNow object type like 'Incidents

 

Syntax:

ServiceNow.DeleteRecord (string type, string sysid)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Record Type)

Type of record to list

True

GetRecordTypes

sysid

string

(System ID)

System ID for the record.

True

 

Returns:

 

GetRecordTypes

Summary: Get Record Types

Description: Lists the available record types

 

Syntax:

ServiceNow.GetRecordTypes ()

 

Returns:

          Type:GetTypesResponse

 

GetRecordSchema

Summary: Get Record Schema

Description: Gets the schema of a record type

 

Syntax:

ServiceNow.GetRecordSchema (string type)

 

Parameters:

Name

Type

Summary

Required

Related Action

type

string

(Record Type)

Type of record to list

True

GetRecordTypes

 

Returns:

          Type:GetRecordSchemaResponse

 


 

GetRecordSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Schema

 

 

 

Schema

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetRecordsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

array of (ResultItem)

 

 

 

ResultItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetTypesResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

array of (ResultItem)

 

Result set of all record types for current instance.

 

ResultItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

label

string

Display name

Display name of the record type.

value

string

Value

Value of the record type.

 


 

RecordBody

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

SingleRecordResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

Result

 

 

 

Result

Summary:

Description:

 

          Properties:

Name

Type

Summary