Get bulkTask by ID

GET

/v1/organizations/:organizationId/bulk-tasks/:bulkTaskId

Get bulkTask by ID

Required Permission: base.bulk.management.get

Get bulkTask by ID

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

bulkTaskId string

required

Match pattern: ^[a-fA-F0-9]{24}$

Responses

200 Response application/json

status boolean optional

data object optional

id string optional

Match pattern: ^[a-fA-F0-9]{24}$

status string optional

pending inProgress completed failed

config object optional

override boolean optional

file object optional

originalName string optional

≤ 256 characters

mimetype string optional

≤ 128 characters

size integer optional

≥ 0

bucket string optional

≤ 256 characters

key string optional

≤ 256 characters

location string optional

≤ 256 characters

region string optional

≤ 128 characters

storageProviderId string optional

Match pattern: ^[a-fA-F0-9]{24}$

checksum string optional

≤ 256 characters

action string optional

≤ 1000 characters

report object optional

numItems number optional

Format: float

numInserts number optional

Format: float

numUpdates number optional

Format: float

numSkips number optional

Format: float

numErrors number optional

Format: float

skippedLines array [object] optional

line number optional

Format: float

erroredLines array [object] optional

line number optional

Format: float

reason string optional

error string optional

createdBy object optional

id string optional

Unique identifier for the user account within the platform, used to reference this specific user across all authentication, authorization, and audit logging throughout the system.

Match pattern: ^[a-fA-F0-9]{24}$

email string optional

Primary email address associated with the user account, used for authentication, notifications, password recovery, and all official communication from the platform to the user.

≤ 256 characters · Format: email

firstName string optional

User's given name or first name as provided during registration or profile updates, displayed in dashboards, and used for personalization throughout the user interface and email communications.

≤ 128 characters

lastName string optional

User's family name or surname as provided during registration or profile updates, used for display purposes in team lists and collaboration interfaces.

≤ 128 characters

fullName string optional

Computed concatenation of first and last names for convenient display in user interfaces, notifications, and reports without requiring separate name field handling in frontend applications.

≤ 128 characters

picture string optional

URL or path to the user's profile picture or avatar image, displayed in navigation menus, team listings, and collaboration interfaces to provide visual identification across the platform.

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

{
    "status": true,
    "data": {
        "id": "string",
        "status": "pending",
        "config": {
            "override": true
        },
        "file": {
            "originalName": "string",
            "mimetype": "string",
            "size": 0,
            "bucket": "string",
            "key": "string",
            "location": "string",
            "region": "string",
            "storageProviderId": "string",
            "checksum": "string"
        },
        "action": "string",
        "report": {
            "numItems": 0,
            "numInserts": 0,
            "numUpdates": 0,
            "numSkips": 0,
            "numErrors": 0,
            "skippedLines": [
                {
                    "line": 0
                }
            ],
            "erroredLines": [
                {
                    "line": 0,
                    "reason": "string"
                }
            ]
        },
        "error": "string",
        "createdBy": {
            "id": "507f1f77bcf86cd799439023",
            "email": "[email protected]",
            "firstName": "John",
            "lastName": "Doe",
            "fullName": "John Doe",
            "picture": "https://example.com/images/profile-picture.jpg"
        },
        "updatedAt": "2024-01-01T00: 00:00Z",
        "createdAt": "2024-01-01T00: 00:00Z"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}