API docs by Redocly

Ignite Procurement Data API (1.0.0)

Download OpenAPI specification:

NOTE: API users are expected to have access to the web app to be able to create repositories etc.

List all available repositories

Authorizations:
bearerAuth
header Parameters
Authorization
required
string

Ignite API Token

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Pushing files

The maximum request body size is 200 MB. Because the request body includes multipart form data overhead in addition to the file itself, the file should be kept under 190 MB. For larger files, use gzip compression and set the compressed field to true.

Authorizations:
bearerAuth
header Parameters
Authorization
required
string
Example: Bearer ABCDE1234567890

Ignite API Token

Request Body schema: multipart/form-data
dataRepositoryId
required
string <uuid>

The UUID of the data repository to push data to.

file
required
string <binary>

A file with data. Valid types: [.xlsx, .csv, .json, .ndjson]. Can be compressed with gzip-compression, but zip must only contain single file. Use .ndjson extension for newline delimited JSON files. Maximum file size is 190 MB (or up to 200 MB including other form fields). For larger files, compress with gzip and set the compressed field to true.

fileConfig
string

A JSON string with configuration for the file. Only required for .csv files. Accepted values for configuration variables: delimiter: [",", ";", "\t"], quoteCharacter: ["DOUBLE_QUOTE", "SINGLE_QUOTE", "disabled"], escapeCharacter: ["BACKSLASH", "DOUBLE_QUOTE", "VERTICAL_BAR"], encoding: ["UTF-8", "ISO-8859-1"]. Example: '{"delimiter":",","quoteCharacter":"DOUBLE_QUOTE","escapeCharacter":"BACKSLASH","encoding":"UTF-8"}'.

compressed
string

A boolean value indicating whether the file is compressed with gzip-compression. Default value is false.

deleteQueryId
string

The UUID of the Ignite created Delete Query.

Responses

Pushing data

Authorizations:
bearerAuth
header Parameters
Authorization
required
string
Example: Bearer ABCDE1234567890

Ignite API Token

Request Body schema: application/json
required
dataRepositoryId
required
string <uuid>

The UUID of the data repository to push data to.

importName
string <uuid>

Optional name for the import. If not provided, a timestamp is used.

data
required
Array of objects

A valid JSON list where every row is an object. Each element of list should be a flattened object (e.g. no nested objects).

deleteQueryId
string

The UUID of the Ignite created Delete Query.

Responses

Request samples

Content type
application/json
{
  • "dataRepositoryId": "e5463eb3-120f-4425-9107-d7a18ae84125",
  • "importName": "6ebf3e08-f518-405f-a06a-56302396597b",
  • "data": [
    ],
  • "deleteQueryId": "string"
}