Rotations

Overview

Available Operations

• Create - Create Rotation

• GetByID - Get Schedule Rotation by ID

• Update - Update Rotation

• GetParticipants - Get Rotation Participants

• UpdateParticipants - Update Rotation Participants

Create

Create Rotation

Example Usage

package main

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

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

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

    res, err := s.Rotations.Create(ctx, "<id>", components.V4CreateRotationRequest{
        Name: "<value>",
        StartDate: "<value>",
        Period: "<value>",
        ChangeParticipantsFrequency: 62013,
        ChangeParticipantsUnit: "<value>",
        ParticipantGroups: []components.V4ParticipantGroup{},
    })
    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.
scheduleID	string	✔️	N/A
v4CreateRotationRequest	components.V4CreateRotationRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.RotationsCreateRotationResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

GetByID

Get Schedule Rotation by ID

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_BEARER_AUTH")),
    )

    res, err := s.Rotations.GetByID(ctx, "<id>", "<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.
scheduleID	string	✔️	N/A
rotationID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.RotationsGetScheduleRotationByIDResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

Update

Update Rotation

Example Usage

package main

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

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

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

    res, err := s.Rotations.Update(ctx, "<id>", "<id>", components.V4UpdateRotationRequest{
        Name: "<value>",
        StartDate: "<value>",
        Period: "<value>",
        ChangeParticipantsFrequency: 183098,
        ChangeParticipantsUnit: "<value>",
    })
    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.
scheduleID	string	✔️	N/A
rotationID	string	✔️	N/A
v4UpdateRotationRequest	components.V4UpdateRotationRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.RotationsUpdateRotationResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

GetParticipants

Get Rotation Participants

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_BEARER_AUTH")),
    )

    res, err := s.Rotations.GetParticipants(ctx, "<id>", "<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.
scheduleID	string	✔️	N/A
rotationID	string	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.RotationsGetRotationParticipantsResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*

UpdateParticipants

Update Rotation Participants

Example Usage

package main

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

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

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

    res, err := s.Rotations.UpdateParticipants(ctx, "<id>", "<id>", components.V4UpdateRotationParticipantsRequest{
        ParticipantGroups: []components.V4ParticipantGroup{},
    })
    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.
scheduleID	string	✔️	N/A
rotationID	string	✔️	N/A
v4UpdateRotationParticipantsRequest	components.V4UpdateRotationParticipantsRequest	✔️	N/A
opts	[]operations.Option	➖	The options for this request.

Response

*operations.RotationsUpdateRotationParticipantsResponse, error

Errors

Error Type	Status Code	Content Type
apierrors.CommonV4Error	400, 401, 402, 403, 404, 409, 422	application/json
apierrors.CommonV4Error	500, 502, 503, 504	application/json
apierrors.APIError	4XX, 5XX	*/*