Get all bulk account uploads for user

This method gets the status of all bulk account uploads that the user performed.

 

Bulk account uploads are returned sorted by their creation time in descending order - from the most recent to the oldest.

The bulk account uploads that are returned are ones that a specific user created and has authorization to view.

URL

 
https://{PVWA_SERVER}/passwordvault/api/bulkactions/accounts
 

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

Resource information

HTTP method

Content type

GET

application/json

Header parameter

Parameter

Description

Authorization

The token that identifies the session, encoded in BASE 64.

Type: string

Mandatory: yes

Default value: none

URL parameters

 

Parameter

Description

filter

Filters according to REST standards.

You can use the following filter:

  • status - returns all bulk account uploads that meet the required status

Type: string

Mandatory: no

limit

Limits according to REST Standards.

You can use the following limit:

  • number of accounts to return, starting from the first account

Type: number

Mandatory: no

Result

 
{ 
  "Total": "4",	
  "BulkActions": [
   {
     "id": 4,
     "source": "sample.csv",
     "creationTime": 591093165,
     "status": "failed",
     "result": { "error": "server connection failed" }
   },
   {
     "id": 3,
     "source": "sample3.csv",
     "creationTime": 1591093161,
     "status": "inProgress"
   },
   {
     "id": 2,
     "source": "sample2.csv",
     "creationTime": 1591093074,
     "status": "completedSuccessfully",
     "result": {
        "succeeded": 3,
        "failed": 0
     }
   },
   {
     "id": 1,
     "source": sample.csv,
     "creationTime": 1591092699,
     "status": "completedWithErrors",
     "result": {
        "succeeded": 2,
        "failed": 1
     }
   },
 ]
}

 

Parameter

Description

id

The single identifier for the bulk action.

Type: number

source

Free-text description of the source of the bulk account upload.

Type: string

creationTime

The time the bulk action was created.

Type:  date-time

status

The possible statuses are:

  • inProgress: the bulk upload is still processing
  • completed: the bulk upload completed and all accounts were uploaded successfully
  • completedWithErrors: the bulk upload completed but there were accounts that failed to upload
  • failed: the bulk upload process failed to run

Type: string

result

The result of the bulk action process.

  • If the process completed, or completed with errors - returns a summary of the accounts that were successfully created or failed to be created.
  • If the process failed - returns a failure error message

Type

{ succeeded: <sum>, failed: <sum> }

{ error: <error message> }

Return codes

For a complete list of return codes, see Return Codes.