Bulk Actions

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.

GET

packages

bulkactionsession

{bulkActionSessionId}

Error

A valid request URL is required to generate request examples

{
  "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."
      }
    ]
  }
}

[
  {
    "ErrorCode": "BulkActionSession.NotFound",
    "ErrorMessage": "No bulk action session found with the provided id."
  }
]

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

bulkActionSessionId

string<guid>

required

The unique identifier of the target bulk action session A bulk action session unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Query Parameters

includeDetails

boolean

The result will contain all the info available about the requested bulk action session.

Response

OK.

The bulk package action session information.

SessionId

string<guid>

The bulk action session unique identifier..

Example:

"00000000-0000-0000-0000-000000000000"

Action

enum<string>

The bulk action type.

Available options:

DeletePackage,

DownloadPackage,

NotifyActors,

RevokePackage,

SkipPackagePhase,

ExtendPackage,

RequestAuditTrails,

DeleteAuditProofs,

PackageStatusUpdate,

SoftDeletePackage

Status

enum<string>

The bulk action status.

Available options:

Pending,

Finishing,

Finished

Total

integer

Total items in the bulk action session.

Succeeded

integer

The number of the succeeded actions.

Failed

integer

The number of the failed actions.

FinishedTime

string<dateTime>

The bulk action session end time.

Details

object

The bulk action session information per package.

Show child attributes

Get bulk action session statusReturns the status of a bulk action session that is not scoped to packages - for example the session created when inviting users in bulk. Bulk actions are processed in the background, so they do not report success or failure immediately. Each bulk action returns a session identifier; use this operation to poll it. The response reports whether processing is still `Pending`, `Finishing` or `Finished`, and how many items succeeded or failed. Set `IncludeDetails` to `true` to also return per-item results - the identifier and execution time of each item, plus an error code and message for items that failed. `FinishedTime` is only populated once the session reaches `Finished`.

Error

A valid request URL is required to generate request examples

{
  "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."
      }
    ]
  }
}

[
  {
    "ErrorCode": "BulkActionSession.NotFound",
    "ErrorMessage": "No bulk action session found with the provided id."
  }
]

Product updates

NSEV WebPortal API

Get package bulk action session status

Authorizations

Path Parameters

Query Parameters

Response