> ## Documentation Index > Fetch the complete documentation index at: https://developers.gonitro.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get package bulk action session status > Bulk package actions are processed in the background, so they do not report success or failure immediately. Instead, each bulk action returns a bulk action session identifier. Use this operation to poll that session: it reports whether processing is still `Pending`, `Finishing` or `Finished`, and how many packages succeeded or failed. Set `IncludeDetails` to `true` to also return per-package results - the identifier and execution time of each package, plus an error code and message for packages that failed. `FinishedTime` is only populated once the session reaches `Finished`. ## OpenAPI ````yaml /nsev/api-reference/openapi.yaml get /packages/bulkactionsession/{bulkActionSessionId} openapi: 3.0.0 info: title: NSEV WebPortal API version: 4.0.0 contact: name: NSEV Support Team url: https://connectivegroup.my.site.com/s/contactsupport?language=en_US description: > **Nitro Sign Enterprise Verified (NSEV) WebPortal API Version 4** A comprehensive digital signing API that enables secure document signing workflows. This API provides endpoints for managing packages, documents, elements, stakeholders, and signing processes within the NSEV platform. ## Authentication This API supports multiple authentication methods: ### Basic Authentication Traditional HTTP Basic Authentication using username and password. ### OAuth 2.0 **Client Credentials Flow (Machine-to-Machine)** - Full API access including administrative endpoints - Ideal for server-to-server integrations **Authorization Code Flow (User-based)** - Limited API access excluding administrative endpoints - Ideal for user-facing applications - Supports delegated user access scenarios ## API Variants This specification is available in two variants: - **Full API**: Complete API with all endpoints (BasicAuth + OAuth2 M2M) - **User API**: Limited API excluding admin endpoints (OAuth2 user-based only) Administrative endpoints (`/poisonqueue`, `/absenceperiods`, `/auditproofs`) are restricted to machine-to-machine authentication only. ## Versioning This API follows semantic versioning principles. Major version changes may introduce breaking changes, while minor and patch versions maintain backwards compatibility. servers: - url: '{baseUrl}/esig/webportalapi/v4' variables: baseUrl: default: https://your-tenant.sign.gonitro.com description: >- Your tenant-specific base URL, including scheme and host (e.g. https://acme.sign.gonitro.com). Each NSEV customer has a unique URL. Replace this with yours before sending a request. The esig path segment is required - the Web Application Firewall routes requests on it. security: - basicAuth: [] - bearerAuth: [] tags: - name: Configuration description: | Endpoints for retrieving system configuration settings, contact groups, templates and signing methods. - name: Packages description: | Core endpoints for creating, managing, and tracking packages throughout their lifecycle. - name: Documents description: | Endpoints for adding, removing, and managing documents within packages. Handles document upload, processing, and metadata management. - name: Elements description: | Endpoints for managing elements (fields) within documents, including signatures and other form elements. - name: Stakeholders description: | Endpoints for managing stakeholders (recipients) associated with packages and their roles in the package workflow. - name: Actors description: | Endpoints for managing individual actors within stakeholders, including their contact information and role preferences: Approver, FormFiller, Signer or Receiver - name: Process description: | Endpoints for managing the package process workflow, including process steps, parallel actions, and workflow orchestration. - name: AuditTrails description: | Modern endpoints for retrieving comprehensive audit trails as signed PDFs, verifying the integrity of audit trail data and retrieving audit events. - name: BulkActions description: | Endpoints for performing and managing bulk actions on multiple packages. - name: Users description: | Endpoints for managing user accounts, including user invitations. - name: AbsencePeriods description: | Administrative endpoints for managing user absence periods and delegation settings during out-of-office scenarios. **Access Level**: Machine-to-machine only (administrative access required) paths: /packages/bulkactionsession/{bulkActionSessionId}: get: tags: - BulkActions summary: Get package bulk action session status description: >- Bulk package actions are processed in the background, so they do not report success or failure immediately. Instead, each bulk action returns a bulk action session identifier. Use this operation to poll that session: it reports whether processing is still `Pending`, `Finishing` or `Finished`, and how many packages succeeded or failed. Set `IncludeDetails` to `true` to also return per-package results - the identifier and execution time of each package, plus an error code and message for packages that failed. `FinishedTime` is only populated once the session reaches `Finished`. operationId: getPackageBulkActionSession parameters: - $ref: '#/components/parameters/bulkActionSessionIdPathParam' - in: query name: includeDetails description: >- The result will contain all the info available about the requested bulk action session. required: false schema: type: boolean responses: '200': description: OK. content: application/json: schema: $ref: '#/components/schemas/BulkPackageActionInfoResult' examples: session-status: summary: OK value: SessionId: b459d74c-1f90-4d63-9f4a-6de9cead8c5e Action: RequestAuditTrails Status: Finished Total: 2 Succeeded: 1 Failed: 1 FinishedTime: '2025-02-27T09:09:46Z' Details: Succeeded: - PackageId: 1fdbad81-75e5-4cc8-b113-39255fa119d7 ExecutedTime: '2025-02-27T09:09:40Z' Failed: - PackageId: 9b2e6f3a-1c44-4e2b-8a77-2d6f0a1b3c4d ExecutedTime: '2025-02-27T09:09:42Z' ErrorCode: Package.NotInFinalState ErrorMessage: The package is not in a final state. '401': $ref: '#/components/responses/UnAuthorized' '404': description: An exception has occured. content: application/json: schema: type: array items: $ref: '#/components/schemas/NotFoundError' examples: not-found: summary: An exception has occurred value: - ErrorCode: BulkActionSession.NotFound ErrorMessage: No bulk action session found with the provided id. components: parameters: bulkActionSessionIdPathParam: name: bulkActionSessionId in: path required: true description: The unique identifier of the target bulk action session schema: $ref: '#/components/schemas/BulkActionSession.Id' schemas: BulkPackageActionInfoResult: type: object description: The bulk package action session information. properties: SessionId: allOf: - $ref: '#/components/schemas/Guid' - description: The bulk action session unique identifier.. Action: type: string enum: - DeletePackage - DownloadPackage - NotifyActors - RevokePackage - SkipPackagePhase - ExtendPackage - RequestAuditTrails - DeleteAuditProofs - PackageStatusUpdate - SoftDeletePackage description: The bulk action type. Status: type: string enum: - Pending - Finishing - Finished description: The bulk action status. Total: type: integer description: Total items in the bulk action session. Succeeded: type: integer description: The number of the succeeded actions. Failed: type: integer description: The number of the failed actions. FinishedTime: type: string format: dateTime description: The bulk action session end time. Details: $ref: '#/components/schemas/BulkPackageActionDetail' NotFoundError: title: Not found allOf: - $ref: '#/components/schemas/Error' - description: The resource could not be found example: ErrorCode: Document.NotFound:00000000-0000-0000-0000-000000000000 ErrorMessage: >- The document with id '00000000-0000-0000-0000-000000000000' could not be found BulkActionSession.Id: allOf: - $ref: '#/components/schemas/Guid' - description: A bulk action session unique identifier Guid: title: GUID type: string description: A globally unique identifier format: guid example: 00000000-0000-0000-0000-000000000000 BulkPackageActionDetail: type: object description: The bulk action session information per package. properties: Succeeded: type: array items: $ref: '#/components/schemas/BulkPackageActionDetailsBaseResult' Failed: type: array items: $ref: '#/components/schemas/BulkPackageActionFailedResult' Error: title: Error type: object description: Something that went wrong example: ErrorCode: Something.WentWrong ErrorMessage: Something went wrong properties: ErrorCode: type: string description: >- An error code of something that went wrong, in the form of 'Subject.Error:value' ErrorMessage: type: string description: A human-readable explanation of what went wrong BulkPackageActionDetailsBaseResult: type: object description: The information of succeeded package action. properties: PackageId: $ref: '#/components/schemas/Guid' ExecutedTime: type: string format: dateTime BulkPackageActionFailedResult: allOf: - $ref: '#/components/schemas/BulkPackageActionDetailsBaseResult' - properties: ErrorCode: type: string ErrorMessage: type: string responses: UnAuthorized: description: Caller is unauthorized to perform this operation securitySchemes: basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Bearer token authentication using JSON Web Tokens (JWT) or opaque tokens. **Usage**: Send the access token in the Authorization header: ``` Authorization: Bearer ``` ````