@managed-api/service-now-sr-connect

ScriptRunner Connect Managed API for Service Now

Managed API for Service Now is an API Client for Service Now by Adaptavist. You can read more about Managed APIs here.

This is ScriptRunner Connect runtime specific version of the Managed API (with sr-connect suffix). If you want to use Managed API in any other runtime, have a look at the runtime agnostic version.

Supported API calls

• fetch
• Attachment
  • deleteAttachment
  • getAttachments
  • getMetadataForAttachment
  • uploadBinaryFile
  • uploadMultipartFile
• Table
  • addRecord
  • deleteRecord
  • getRecord
  • getRecords
  • updateRecord
  • updateRecordWithNameValuePair

Constructing Managed API

In ScriptRunner Connect a Managed API is constructed for you, but if you need to construct it manually, here's how you can do it:

import { ServiceNowApi } from '@managed-api/service-now-sr-connect';

export default async function() {
    const api = new ServiceNowApi('API_CONNECTION_ID');
}

Contact

Feel free to drop ideas, suggestions or improvements into our Slack community channel.

Changelog

• 2.0.0

  • Breaking change: URL and query string parameters are now URL encoded, meaning if you encoded them explicitly before you have to remove your own encoding, otherwise they will get double encoded.

• 0.3.0

  • Added support for the following Attachment methods:
    • Delete Attachment that can be used as Attachment.deleteAttachment or All.deleteAttachment.
    • Get Attachments that can be used as Attachment.getAttachments or All.getAttachmentst.
    • Get Attachment that can be used as Attachment.getMetadataForAttachment or All.getMetadataForAttachment.
    • Upload Binary File to a Record that can be used as Attachment.uploadBinaryFile or All.uploadBinaryFile.
    • Upload Multipart File Attachment that can be used as Attachment.uploadMultipartFile or All.uploadMultipartFile.
  • Added support for the following Table methods:
    • Delete Record from Table that can be used as Table.deleteRecord or All.deleteRecord.
    • Retrieve multiple Records for the Table that can be used as Table.getRecords or All.getRecords.
    • Retrieve a Record that can be used as Table.getRecord or All.getRecord.
    • Update a Record with the name-value pairs that can be used as Table.updateRecordWithNameValuePair or All.updateRecordWithNameValuePair.
    • Insert a Record in the Table that can be used as Table.addRecord or All.addRecord.
    • Update a Record that can be used as Table.updateRecord or All.updateRecord.

• 0.1.5

  • Fixed README

Copyright Adaptavist 2022 (c) All rights reserved