Skip to content

README.md

Latest commit

 

History

History
245 lines (173 loc) · 12.1 KB

README.md

File metadata and controls

245 lines (173 loc) · 12.1 KB

Workflow

(workflow)

Available Operations

approvePendingApprovalJobById

Approves a pending approval job in a workflow.

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.workflow.approvePendingApprovalJobById({
    approvalRequestId: "afd4e8a2-73f4-4706-8fed-d209a62dd146",
    id: "5034460f-c7c4-4c43-9457-de07e2029e7b",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.ApprovePendingApprovalJobByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.ApprovePendingApprovalJobByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

cancelWorkflow

Cancels a running workflow.

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.workflow.cancelWorkflow({
    id: "5034460f-c7c4-4c43-9457-de07e2029e7b",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.CancelWorkflowRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.CancelWorkflowResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

getWorkflowById

Returns summary fields of a workflow by ID.

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.workflow.getWorkflowById({
    id: "5034460f-c7c4-4c43-9457-de07e2029e7b",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.GetWorkflowByIdRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetWorkflowByIdResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

listWorkflowJobs

Returns a sequence of jobs for a workflow.

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.workflow.listWorkflowJobs({
    id: "5034460f-c7c4-4c43-9457-de07e2029e7b",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.ListWorkflowJobsRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.ListWorkflowJobsResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /

rerunWorkflow

Reruns a workflow.

Example Usage

import { Circleci } from "circleci-v2-sdk";

async function run() {
  const sdk = new Circleci({
    security: {
      apiKeyHeader: "<YOUR_API_KEY_HERE>",
    },
  });

  const res = await sdk.workflow.rerunWorkflow({
    requestBody: {
      enableSsh: false,
      fromFailed: false,
      jobs: [
        "c65b68ef-e73b-4bf2-be9a-7a322a9df150",
        "5e957edd-5e8c-4985-9178-5d0d69561822",
      ],
      sparseTree: false,
    },
    id: "5034460f-c7c4-4c43-9457-de07e2029e7b",
  });

  if (res.statusCode == 200) {
    // handle response
  }
}

run();

Parameters

Parameter Type Required Description
request operations.RerunWorkflowRequest ✔️ The request object to use for the request.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.RerunWorkflowResponse>

Errors

Error Object Status Code Content Type
errors.SDKError 4xx-5xx /