@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
36 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 * as errors from "../models/errors/index.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 a Workflow Instance
*
* @remarks
* This operation retrieves a single Maestro workflow instance by its unique identifier (`id`).
* It returns the primary details of the workflow instance, including its name, status,
* starting information, and other metadata.
*
* The response provides key details that help users understand the current state of the workflow
* instance, when it was started, and who initiated it. Additional metadata is included to support
* auditing and reporting within the system.
*
* ### Use Cases:
* - Getting the details of a specific workflow instance for further processing or review
* - Monitoring the status of a running workflow instance to determine completion or cancellation
* - Accessing metadata for auditing, logging, or reporting on a single workflow instance
*
* ### Key Features:
* - **Single Workflow Instance**: Provides direct access to a specific workflow instance by `id`
* - **Detailed Status Information**: Includes the workflow's start and end times, status, and other lifecycle timestamps
* - **Metadata for Tracking**: Useful metadata like who initiated the workflow (`started_by`) and versioning details
* - **Future-Proof**: Designed to be extensible if additional fields or nested information are required over time
*/
export declare function maestroWorkflowInstanceManagementGetWorkflowInstance(client: IamClientCore, request: operations.GetWorkflowInstanceRequest, options?: RequestOptions): APIPromise<Result<components.WorkflowInstance, errors.ErrorT | IamClientError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
//# sourceMappingURL=maestroWorkflowInstanceManagementGetWorkflowInstance.d.ts.map