logo
API docs by Redocly

Bulk Data Management (2.11)

Download OpenAPI specification:Download

Bulk Data Management Concepts

The Bulk Data Management API is a RESTful endpoint.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the Bulk Data Management API is up and running.

Authorizations:
SWT

Responses

Common Data

Resources related to data common among all of the components of the system.

Data Type

List of all the available types of data that can be used in a file format.

Available fields

The following is a list of properties of a Data Type and how they can be used to search.

  • Filterable : dataTypeID, name, validation, validationRegex, validationRegexStrict
  • Sortable : dataTypeID, name, validation, validationRegex, validationRegexStrict
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
integer
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "DataTypeID": 475746,
  • "Description": "Data Type Description",
  • "Name": "Data Type Name",
  • "Validation": "Validation Regex Description",
  • "ValidationRegex": "(?i)(<title.*?>)(.+?)()",
  • "ValidationRegexStrict": "(?i)(<title.*?>)(.+?)()"
}

File

Resources related to files.

File Search

Provides the ability to search for files.

Available fields

The following is a list of properties of a File and how they can be used to search.

  • Filterable : completeDate, createDate, createuser, fileID, fileFormat, fileFormatID, fileSize, fileStatusID, name, startDate, totalRecords
  • Sortable : completeDate, createDate, createuser, fileID, fileFormat, fileFormatID, fileSize, fileStatusID, name, startDate, totalRecords
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
integer
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/bulkDataManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Upload a File

Provides the ability to upload a file. [Rev 1.02]

Authorizations:
SWT
Request Body schema: multipart/form-data
fileName
required
string

Name of the file being uploaded.

fileFormatID
required
integer

Unique identifier of the file format to use.

file
required
binary

The file to upload.

Responses

Response samples

Content type
application/json
{
  • "completeDate": "2019-03-01T09:57:28+00:00",
  • "createDate": "2019-03-01T09:57:28+00:00",
  • "createUser": "Bulk Data User",
  • "errorRecords": 1,
  • "fileID": 2,
  • "fileFormat": "File Format 1",
  • "fileFormatID": 0,
  • "fileSize": 12345,
  • "fileStatus": "Pending",
  • "fileStatusID": 0,
  • "name": "File",
  • "recordsPerSecond": 24,
  • "skippedRecords": 3,
  • "startDate": "2019-03-01T09:57:28+00:00",
  • "statusMessage": "File 1 is not in a recognized file format.",
  • "successRecords": 20,
  • "totalProcessingSeconds": 19,
  • "totalRecords": 124
}

Get File

Authorizations:
SWT
path Parameters
fileID
required
integer
Example: 1

Unique identifier of the file.

Responses

Response samples

Content type
application/json
{
  • "completeDate": "2019-03-01T09:57:28+00:00",
  • "createDate": "2019-03-01T09:57:28+00:00",
  • "createUser": "Bulk Data User",
  • "errorRecords": 1,
  • "fileID": 2,
  • "fileFormat": "File Format 1",
  • "fileFormatID": 0,
  • "fileSize": 12345,
  • "fileStatus": "Pending",
  • "fileStatusID": 0,
  • "name": "File",
  • "recordsPerSecond": 24,
  • "skippedRecords": 3,
  • "startDate": "2019-03-01T09:57:28+00:00",
  • "statusMessage": "File 1 is not in a recognized file format.",
  • "successRecords": 20,
  • "totalProcessingSeconds": 19,
  • "totalRecords": 124
}

Get File Content

This API provides the ability to download the file associated with a specific fileID.

Authorizations:
SWT
path Parameters
fileID
required
integer
Example: 1

Unique identifier of the file.

query Parameters
format
string
Example:

Indicates that the file contents are being requested

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Download Error File

Provides the ability to download an error file associated to a file.

Authorizations:
SWT
path Parameters
fileID
required
integer
Example: 1

Unique identifier of the file.

Responses

File Format

Resources related to file formats.

File Format Search

Provides the ability to search for file formats.

Available fields

The following is a list of properties of a File Format and how they can be used to search.

  • Filterable : name, fileFormatID
  • Sortable : name, fileFormatID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
integer
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/bulkDataManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Get File Format

Authorizations:
SWT
path Parameters
fileFormatID
required
integer
Example: 1

Unique identifier of the file format to retrieve.

Responses

Response samples

Content type
application/json
{
  • "description": "File Format Description",
  • "fileFormatID": 2,
  • "name": "FileFormat"
}

File Format Field

Resources related to file format fields.

File Format Field Search

Provides the ability to search for file format fields.

Available fields

The following is a list of properties of a File Format Field and how they can be used to search.

  • Filterable : dataType, fileFormatFieldID, isPrimaryKey, name
  • Sortable : , fileFormatFieldID, isPrimaryKey, name
Authorizations:
SWT
path Parameters
fileFormatID
required
integer
Example: 1

Unique identifier of the file format associated to the file format field.

query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
integer
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/billingOrderManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Get File Format Field

Authorizations:
SWT
path Parameters
fileFormatID
required
integer
Example: 1

Unique identifier of the file format associated to the file format field.

fileFormatFieldID
required
integer
Example: 1

Unique identifier of the file format field to retrieve.

Responses

Response samples

Content type
application/json
{
  • "dataType": "Integer",
  • "description": "File Format Field Description",
  • "fileFormatFieldID": 2,
  • "name": "FileFormatField",
  • "isPrimaryKey": true
}

File Status

Resources related to file statuses.

File Status Search

Provides the ability to search for file statuses.

Available fields

The following is a list of properties of a file status and how they can be used to search.

  • Filterable : name, fileStatusID
  • Sortable : name, fileStatusID
Authorizations:
SWT
query Parameters
$count
boolean
Example: $count=true

Specifies whether to fetch the total count of results. This is the count of all entities that match the search and $filter parameters, ignoring $top and $skip. Setting this value to true may have a performance impact. Note that the count returned is an approximation.

$filter
string
Example: $filter=field1 eq 1234

A structured search expression in standard OData syntax.

$orderby
string
Example: $orderby=field1

A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.

$select
string
Example: $select=field1, field2

A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

$skip
integer
Example: $skip=10

Number of search results to skip.

$skiptoken
integer
Example: $skiptoken=2

Indicator to the next set of results. This value is usually supplied on the response from a previous search.

$top
integer
Example: $top=1

Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

Content type
application/json
{
  • "@count": 145,
  • "@nextLink": "https://api.idibilling.com/bulkDataManagement/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
  • "value": [
    ]
}

Release Notes

Release Notes 2.11

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.10

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.08

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.07

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.06

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.04

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.01

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 2.00

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.03

  • Internal changes were applied to this release. There were no external API changes.

Release Notes 1.02

Release Notes 1.01

  • Internal changes were applied to this release. There were no external API changes.