Prepare new bulkTask (for edge runners)

GET

/v1/organizations/:organizationId/bulk-tasks/edge/prepare

Prepare new bulkTask (for edge runners)

Required Permission: base.bulk.management.get

Prepare new bulkTask (for edge runners)

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,}))$

Responses

200 Response application/json

status boolean optional

data object optional

storageProvider object optional

id string optional

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

provider string optional

s3 gcs

name string optional

≤ 256 characters

configuration object optional

security object optional

accessKey string optional

≤ 256 characters

secret string optional

≤ 256 characters

region string optional

≤ 256 characters

bucket string optional

≤ 256 characters

buildTempFolder string optional

≤ 256 characters

supportedExtensions array [string] optional

{
    "status": true,
    "data": {
        "storageProvider": {
            "id": "string",
            "provider": "s3",
            "name": "string",
            "configuration": {
                "security": {
                    "accessKey": "string",
                    "secret": "string",
                    "region": "string"
                },
                "bucket": "string",
                "buildTempFolder": "string"
            }
        },
        "supportedExtensions": [
            "string"
        ]
    }
}

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"
    }
}