servicenowsdkgo

README

ServiceNow SDK for Go

A Service-Now API client enabling Go programs to interact with Service-Now in a simple and uniform way

Supported Service-Now APIs

API	Status	Issues
Account	✖️
ActivitySubscriptions	✖️
Agent Client Collector	✖️
Aggregate	✖️
AI Search External User Mapping	✖️
Alarm Management Open	✖️
Application Service	✖️
Appointment	✖️
Attachment	♻️
Advanced Work Assignment (AWA) Agent	✖️
AWA Assignment	✖️
AWA Routing	✖️
Batch	✖️
Case	✖️
Custom Chat Chatbot Interoperability Framework (CCCIF) Media Resource	✖️
CdmApplicationsApi	✖️
CdmChangesetsApi	✖️
CdmEditorApi	✖️
CdmPoliciesApi	✖️
Tables	✔️

---

Emoji	Meaning
✔️	Supported
🆕	Preview
♻️	In progress
✖️	Not supported

1. Installation

Install latest

go get github.com/michaeldcanady/servicenow-sdk-go

or

Install specific version

go get github.com/michaeldcanady/servicenow-sdk-go@version

2. Getting Started

2.1 Create an AuthenticationProvider object

Create a credential object.

import (
    "github.com/michaeldcanady/servicenow-sdk-go/credentials"
)

cred := credentials.NewUsernamePasswordCredential("username", "password")

2.2 Get a ServiceNow Client and Adapter object

Create a client object.

import (
    servicenowsdkgo "github.com/michaeldcanady/servicenow-sdk-go"
)

client := servicenowsdkgo.NewServiceNowClient(cred, "instance")

2.3 Get query parameters

Build query parameter object.

import (
    "github.com/michaeldcanady/servicenow-sdk-go/table-api"
)

params := &tableapi.TableRequestBuilderGetQueryParameters{
        Limit: int32(1),
    }

2.4 Build request for table

Formulate request and provide parameters.

records, err := client.Now().Table("table name").Get(params)
if err != nil {
    panic(err)
}

Documentation

Index

• Variables
• type NowRequestBuilder
  • func NewNowRequestBuilder(ctx context.Context, url string, client *ServiceNowClient) *NowRequestBuilder
  • func (rB *NowRequestBuilder) Attachment() *attachmentapi.AttachmentRequestBuilder
  • func (rB *NowRequestBuilder) Table(tableName string) *tableapi.TableRequestBuilder
• type ServiceNowClient
  • func NewServiceNowClient(credential core.Credential, instance string) *ServiceNowClient
  • func (c *ServiceNowClient) Now(ctx context.Context) *NowRequestBuilder
  • func (c *ServiceNowClient) Send(ctx context.Context, requestInfo core.IRequestInformation, ...) (*http.Response, error)
  • func (c *ServiceNowClient) SendWithContext(ctx context.Context, requestInfo core.IRequestInformation, ...) (*http.Response, error)

Variables

var (
	ErrNilRequestInfo = errors.New("requestInfo cannot be nil")
	ErrNilContext     = errors.New("ctx cannot be nil")
)

Types

type NowRequestBuilder

type NowRequestBuilder struct {
	context.Context
	core.RequestBuilder
}

func NewNowRequestBuilder

func NewNowRequestBuilder(ctx context.Context, url string, client *ServiceNowClient) *NowRequestBuilder

NewNowRequestBuilder creates a new instance of the NowRequestBuilder associated with the given URL and Client. It accepts the URL and Client as parameters and returns a pointer to the created NowRequestBuiabstraction

func (*NowRequestBuilder) Attachment

func (rB *NowRequestBuilder) Attachment() *attachmentapi.AttachmentRequestBuilder

Attachment returns an AttachmentRequestBuilder associated with the NowRequestBuilder. It allows you to work with attachments and manage attachments in ServiceNow.

func (*NowRequestBuilder) Table

func (rB *NowRequestBuilder) Table(tableName string) *tableapi.TableRequestBuilder

Table returns a TableRequestBuilder associated with the NowRequestBuilder. It accepts a table name as a parameter and constructs the URL for table-related requests. The returned TableRequestBuilder can be used to build and execute table-related requests.

type ServiceNowClient

type ServiceNowClient struct {
	Credential core.Credential
	BaseUrl    string //nolint:stylecheck
	Session    http.Client
}

func NewServiceNowClient

func NewServiceNowClient(credential core.Credential, instance string) *ServiceNowClient

NewServiceNowClient creates a new instance of the ServiceNow client. It accepts a UsernamePasswordCredential and an instance URL. If the instance URL does not end with ".service-now.com/api", it appends the suffix. It returns a pointer to the Client.

func (*ServiceNowClient) Now

func (c *ServiceNowClient) Now(ctx context.Context) *NowRequestBuilder

Now returns a NowRequestBuilder associated with the Client. It prepares the NowRequestBuilder with the base URL for the ServiceNow instance.

func (*ServiceNowClient) Send

func (c *ServiceNowClient) Send(ctx context.Context, requestInfo core.IRequestInformation,
	errorMapping core.ErrorMapping) (*http.Response, error)

func (*ServiceNowClient) SendWithContext

func (c *ServiceNowClient) SendWithContext(ctx context.Context, requestInfo core.IRequestInformation, errorMapping core.ErrorMapping) (*http.Response, error)