Workflows.Actions

Overview

Available Operations

• create - Create Action

create

Create an Action for a workflow

Example Usage

import { SquadcastSDK } from "@solarwinds/squadcast-sdk-typescript";

const squadcastSDK = new SquadcastSDK({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await squadcastSDK.workflows.actions.create({
    workflowID: "<id>",
    v3WorkflowsActionRequest: {
      name: "sq_add_status_page_issue",
      data: {
        componentAndImpact: [],
        issueTitle: "<value>",
        pageStatusId: 179034,
        statusAndMessage: [
          {
            messages: [
              "<value 1>",
              "<value 2>",
              "<value 3>",
            ],
            statusId: 692068,
          },
        ],
        statusPageId: 368871,
      },
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SquadcastSDKCore } from "@solarwinds/squadcast-sdk-typescript/core.js";
import { workflowsActionsCreate } from "@solarwinds/squadcast-sdk-typescript/funcs/workflowsActionsCreate.js";

// Use `SquadcastSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const squadcastSDK = new SquadcastSDKCore({
  bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const res = await workflowsActionsCreate(squadcastSDK, {
    workflowID: "<id>",
    v3WorkflowsActionRequest: {
      name: "sq_add_status_page_issue",
      data: {
        componentAndImpact: [],
        issueTitle: "<value>",
        pageStatusId: 179034,
        statusAndMessage: [
          {
            messages: [
              "<value 1>",
              "<value 2>",
              "<value 3>",
            ],
            statusId: 692068,
          },
        ],
        statusPageId: 368871,
      },
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("workflowsActionsCreate failed:", res.error);
  }
}

run();

Parameters

Parameter	Type	Required	Description
request	operations.WorkflowsCreateActionRequest	✔️	The request object to use for the request.
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.WorkflowsCreateActionResponse>

Errors

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