@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
40 lines • 2.55 kB
TypeScript
import { IamClientCore } from "../core.js";
import { RequestOptions } from "../lib/sdks.js";
import * as components from "../models/components/index.js";
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
import { IamClientError } from "../models/errors/iamclienterror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import * as operations from "../models/operations/index.js";
import { APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";
/**
* Retrieve All Workflow Instances
*
* @remarks
* This operation retrieves a list of all available Maestro workflow instances. It returns basic information
* about each workflow instance, including its unique identifier (`id`), name, status, timestamps, and
* additional metadata.
*
* The response provides key details that help users understand what workflow instances are in progress
* or completed, and the relevant data for each. Each workflow instance entry also includes metadata, such
* as who started it, when it was last modified, and how many steps have been completed.
*
* ### Use Cases:
* - Listing all available workflow instances for manual or automated review
* - Monitoring which workflow instances are currently running or have finished
* - Gathering basic metadata about workflow instances for auditing, logging, or reporting purposes
*
* ### Key Features:
* - **Comprehensive Instance Overview**: Provides a full list of workflow instances, giving visibility
*
* into all ongoing and completed workflows within the Maestro platform
* - **Metadata for Tracking**: Includes helpful metadata like creation time, last modification date,
*
* and user details to support audit trails
* - **Scalable and Future-Proof**: Designed to handle growing numbers of workflow instances as the
*
* platform scales
*/
export declare function maestroWorkflowInstanceManagementGetWorkflowInstancesList(client: IamClientCore, request: operations.GetWorkflowInstancesListRequest, options?: RequestOptions): APIPromise<Result<components.WorkflowInstanceCollection, IamClientError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=maestroWorkflowInstanceManagementGetWorkflowInstancesList.d.ts.map