Bulks

---

Get bulk job details

Retrieve the details of the given bulk job as a list of bulk request results (plus some summary information).

Request

Endpoint

GET /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/bulks/{bulk_id}

Authorization

Required role

tenants.instance.subscriptions.instance.bulk.jobs.details

Path Parameters

Parameter	Type	Description
draas_instance	string	See common parameters
uuid	string	A system generated unique ID (UUID) identifying the tenant managing the subscription
subscription_id	integer	Index of a subscription to retrieve the bulk job details for
bulk_id	integer	Index of the bulk job to retrieve details for

Response

Status codes

Parameter	Description
200	The details of the bulk job have been successfully retrieved
400	Error while processing the request
403	The API consumer doesn't have sufficient rights to perform this action
404	No bulk history found or the path tenant / subscription doesn't exist
500	Uncaught error on server side

Success

Body

Parameter	Type	Description	Conditional?
id	integer	Database ID	no
job_id	string	bulk job unique ID	no
title	string	Bulk job title	no
kind	string	Bulk job type (one among addresses, address_numbers, number_ranges)	no
status	string	Global bulk job status (success, error)	no
total_count	integer	Total number of bulk job items	no
success_count	integer	Total number of pages	no
job_items	array	The list of bulk job details related to the given bulk_id	no
created_on	string	Creation date and time	no
updated_on	string	Last modification date date and time	no

Example

{
  "created_on": "2025-09-05T09:42:52.475829",
  "id": 49,
  "job_id": "1757065372",
  "job_items": [
    {
      "created_on": "2025-09-05T09:42:54.954642",
      "data": {
        "full_address": "Rue de la Mer, 5, Bruxelles, Belgium",
        "number": "+3226260128"
      },
      "id": 18,
      "key": "+3226260128",
      "status": "success",
      "updated_on": "2025-09-05T09:42:54.954642"
    },
    {
      "created_on": "2025-09-05T09:42:54.955885",
      "data": {
        "full_address": "Rue de la Mer, 5, Bruxelles, Belgium",
        "number": "+3226260130"
      },
      "id": 19,
      "key": "+3226260130",
      "status": "error",
      "updated_on": "2025-09-05T09:42:54.955885"
    }
  ],
  "kind": "address_numbers",
  "status": "partial",
  "success_count": 1,
  "title": "Assign address to numbers",
  "total_count": 2,
  "updated_on": "2025-09-05T09:42:54.093276"
}

Bulk jobs

Parameter	Type	Description	Conditional?
id	integer	The database ID	no
job_id	string	Bulk job unique ID	no
kind	string	Bulk job type (one among addresses, address_numbers, number_ranges)	no
title	string	Bulk job title	no
created_on	string	Creation date and time	no
updated_on	string	Last modification date date and time	no

Bulk job details

Parameter	Type	Description	Conditional?
id	integer	The database ID	no
key	string	The bulk job key	no
status	string	The request status (success, error)	no
data	array	The data from the original request	no
created_on	string	Creation date and time	no
updated_on	string	Last modification date date and time	no

Download Bulk Template

Download Bulk Template as CSV format.

Request

Endpoint

POST /api/v01/draas/{draas_instance}/tenants/{uuid}/subscriptions/{subscription_id}/downloads/bulk_template

Authorization

Required role

tenants.instance.subscriptions.instance.downloads.bulk_template

Path Parameters

Parameter	Type	Description
draas_instance	string	See common parameters
uuid	string	A system generated unique ID (UUID) identifying the tenant managing the subscription
subscription_id	integer	Index of a subscription to retrieve the bulk job details for

URL/Query parameters

N/A

Body

Parameter	Type	Description	Required
format	string	The file format (csv).	yes
filename	string	The file name. If not provided a default file name will be autogenerated.	no
kind	string	The kind of bulk template to be downloaded (one among addresses, address_numbers, number_ranges, msusers).	yes

Response

The API returns a different response based on CSV format.

Status codes

Parameter	Description
200	The bulk template has been correctly returned
400	Error while processing the request
403	The API consumer doesn't have sufficient rights to perform this action
404	The group doesn't exist
500	Uncatched error on server side

Success

Body format=csv kind=addresses

The API directly returns the CSV file as a downloadable attachment. See csv header for details.

CSV Header

city, country, isoCode, number, postalCode, state, street.

Example

Headers

Content-Type: text/csv; charset=utf-8
Content-Disposition: attachment; filename="addresses_bulk_template.csv"

Body (binary content)

city,country,isoCode,number,postalCode,state,street