README.md

Notes

Overview

Available Operations

• List - Get All Notes

List

• This endpoint is used to get all the note details of incidentID mentioned params.
• Requires access_token as a Bearer {{token}} in the Authorization header.

Example Usage

package main

import(
	"context"
	"os"
	squadcastsdk "github.com/solarwinds/squadcast-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := squadcastsdk.New(
        squadcastsdk.WithSecurity(os.Getenv("SQUADCASTSDK_REFRESH_TOKEN_AUTH")),
    )

    res, err := s.Notes.List(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
incidentID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.NotesGetAllNotesResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.BadRequestError	400	application/json
apierrors.UnauthorizedError	401	application/json
apierrors.PaymentRequiredError	402	application/json
apierrors.ForbiddenError	403	application/json
apierrors.NotFoundError	404	application/json
apierrors.ConflictError	409	application/json
apierrors.UnprocessableEntityError	422	application/json
apierrors.InternalServerError	500	application/json
apierrors.BadGatewayError	502	application/json
apierrors.ServiceUnavailableError	503	application/json
apierrors.GatewayTimeoutError	504	application/json
apierrors.APIError	4XX, 5XX	*/*