Onedot API (1.0)

Download OpenAPI specification:Download

Onedot provides a simple, lightweight and open Web API based on the Open API 2.0 standard (https://www.openapis.org).

Authentication

Using_X-API-Key_request_header

Security scheme type: API Key
Header parameter name: X-API-Key

Using_apiKey_query_parameter

Security scheme type: API Key
Query parameter name: apiKey

Data Files

Retrieve Data Files

Retrieves all data files.

Responses

200

Data Files

401

Invalid or unauthorized API key

403

Operation not permitted

get /data/files
https://api.onedot.com/gateway/public/endpoints/1.0/data/files

Download Data File

Returns a URL where to download a data file from.

Calling this API generates a secure, unique and time-restricted URL where the file can be downloaded from. The download URL is available in the

Location
HTTP header of the response. The expiration of the download URL is available in the
Cache-Control
HTTP header of the response. Clients must perform a
HTTP GET
request on the download URL to securely download the file.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique data file identifier

Responses

200

Download URL generated, unique identifier of data file returned in response

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Data file cannot be found

get /data/files/{id}/download
https://api.onedot.com/gateway/public/endpoints/1.0/data/files/{id}/download

Retrieve Data File

Retrieves the specified data file.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique data file identifier

Responses

200

Data File

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Data File cannot be found

get /data/files/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/data/files/{id}

Update Data File

Updates the specified data file.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique data file identifier

Request Body schema: application/json

Data File

id
string <uuid>

Unique identifier

name
required
string

Name

size
number >= 1

Size (in bytes)

mimeType
string
Enum: "application/octet-stream" "text/csv" "text/plain" "application/x-ldjson" "application/pdf" "application/xml" "text/xml" "application/vnd.ms-excel" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"

MIME type

encoding
string

Encoding

created
string

Creation date (in ISO 8601 format)

modified
string

Last modification date (in ISO 8601 format)

folderId
string <uuid>

Unique identifier of the folder containing the file

creatorId
string <uuid>

Unique identifier of the user that created the file

Responses

200

Data File updated

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Data File cannot be found

put /data/files/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/data/files/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "1df110bf-8f71-44c8-b6b9-a5e1d49b4a6b",
  • "name": "file.csv",
  • "size": 1048576,
  • "mimeType": "text/csv",
  • "encoding": "UTF-8",
  • "created": "2017-05-09T23:37:50Z",
  • "modified": "2017-05-09T23:37:50Z",
  • "folderId": "55e94cc2-89e5-4dad-8786-7d1b2daf9ac8",
  • "creatorId": "a33f3d36-df1b-41b2-ab5d-54dd57c40414"
}

Delete Data File

Deletes the specified Data File.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique data file identifier

Responses

200

Data File deleted

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Data File cannot be found

delete /data/files/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/data/files/{id}

Upload Data File

Returns a URL where to upload the data file to.

Calling this API generates a secure, unique and time-restricted URL where the file can be uploaded to. The upload URL is available in the

Location
HTTP header of the response. The expiration of the upload URL is available in the
Cache-Control
HTTP header of the response. Clients must perform a
HTTP PUT
request on the upload URL to upload the file using a form where a file
data.csv
is passed as property
name=data.csv
of the form. For security reasons, clients must pass all HTTP headers as returned by the
X-Upload-Headers
in the response, together with their values.

query Parameters
name
required
string

Name of the file to create. The name must correspond to the exact file name of the file being uploaded.

fileId
string

Unique identifier of an existing data file to create a new version from

folderId
string

Unique identifier of a folder to upload the file to

mimeType
required
string

MIME type

encoding
string

Encoding

Responses

200

Upload URL generated, unique identifier of new data file returned in response

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

put /data/files/upload
https://api.onedot.com/gateway/public/endpoints/1.0/data/files/upload

Dictionary Files

Retrieve Dictionary Files

Retrieves all dictionary files.

Responses

200

Dictionary Files

401

Invalid or unauthorized API key

403

Operation not permitted

get /dictionaries/files
https://api.onedot.com/gateway/public/endpoints/1.0/dictionaries/files

Download Dictionary File

Returns a URL where to download a dictionary file from.

Calling this API generates a secure, unique and time-restricted URL where the file can be downloaded from. The download URL is available in the

Location
HTTP header of the response. The expiration of the download URL is available in the
Cache-Control
HTTP header of the response. Clients must perform a
HTTP GET
request on the download URL to securely download the file.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique dictionary file identifier

Responses

200

Download URL generated, unique identifier of dictionary file returned in response

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Dictionary file cannot be found

get /dictionaries/files/{id}/download
https://api.onedot.com/gateway/public/endpoints/1.0/dictionaries/files/{id}/download

Retrieve Dictionary File

Retrieves the specified Dictionary File.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique dictionary file identifier

Responses

200

Dictionary File

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Dictionary File cannot be found

get /dictionaries/files/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/dictionaries/files/{id}

Update Dictionary File

Updates the specified Dictionary File.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique dictionary file identifier

Request Body schema: application/json

Dictionary File

id
string <uuid>

Unique identifier

name
required
string

Name

size
number >= 1

Size (in bytes)

mimeType
string
Enum: "text/csv" "application/x-ldjson" "application/vnd.ms-excel" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"

MIME type

encoding
string

Encoding

created
integer <int64>

Creation date (in ISO 8601 format)

modified
integer <int64>

Last modification date (in ISO 8601 format)

folderId
string <uuid>

Unique identifier of the folder containing the file

creatorId
string <uuid>

Unique identifier of the user that created the file

Responses

200

Dictionary File updated

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Dictionary File cannot be found

put /dictionaries/files/{id}/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/dictionaries/files/{id}/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "1df110bf-8f71-44c8-b6b9-a5e1d49b4a6b",
  • "name": "file.csv",
  • "size": 1048576,
  • "mimeType": "text/csv",
  • "encoding": "UTF-8",
  • "created": "2017-05-09T23:37:50Z",
  • "modified": "2017-05-09T23:37:50Z",
  • "folderId": "55e94cc2-89e5-4dad-8786-7d1b2daf9ac8",
  • "creatorId": "a33f3d36-df1b-41b2-ab5d-54dd57c40414"
}

Delete Dictionary File

Deletes the specified Dictionary File.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique dictionary file identifier

Responses

200

Dictionary File deleted

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Dictionary File cannot be found

delete /dictionaries/files/{id}/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/dictionaries/files/{id}/{id}

Upload Dictionary File

Returns a URL where to upload the dictionary file to.

Calling this API generates a secure, unique and time-restricted URL where the file can be uploaded to. The upload URL is available in the

Location
HTTP header of the response. The expiration of the upload URL is available in the
Cache-Control
HTTP header of the response. Clients must perform a
HTTP PUT
request on the upload URL to upload the file using a form where a file
dictionary.csv
is passed as property
name=dictionary.csv
of the form. For security reasons, clients must pass all HTTP headers as returned by the
X-Upload-Headers
in the response, together with their values.

query Parameters
name
required
string

Name of the file to create. The name must correspond to the exact file name of the file being uploaded.

fileId
string

Unique identifier of an existing dictionary file to create a new version from

folderId
string

Unique identifier of a folder to upload the file to

mimeType
required
string

MIME type

encoding
string

Encoding

Responses

200

Upload URL generated, unique identifier of new dictionary file returned in response

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

put /dictionaries/files/upload
https://api.onedot.com/gateway/public/endpoints/1.0/dictionaries/files/upload

Folders

Retrieve Folders

Retrieves all folders.

Responses

200

Folders

401

Invalid or unauthorized API key

403

Operation not permitted

get /folders
https://api.onedot.com/gateway/public/endpoints/1.0/folders

Create Data Files Folder

Creates the specified Folder.

Request Body schema: application/json

Folder

id
string <uuid>

Unique identifier

name
required
string

Name

size
number >= 1

Size (in bytes)

created
integer <int64>

Creation date (in ISO 8601 format)

modified
string

Last modification date (in ISO 8601 format)

creatorId
string

Unique identifier of the user that created the folder

parentId
string <uuid>

Unique identifier of the parent folder

Responses

200

Folder created

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

post /folders/files
https://api.onedot.com/gateway/public/endpoints/1.0/folders/files

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "55ccb8ea-e15a-48f3-a2ba-c700f0d67a04",
  • "name": "My Folder",
  • "size": 1048576,
  • "created": "2017-05-09T23:37:50Z",
  • "modified": "2017-05-09T23:37:50Z",
  • "creatorId": "899afd84-4051-471c-8438-48cb47816af1",
  • "parentId": "899afd84-4051-471c-8438-48cb47816af1"
}

Create Dictionary Files Folder

Creates the specified Folder.

Request Body schema: application/json

Folder

id
string <uuid>

Unique identifier

name
required
string

Name

size
number >= 1

Size (in bytes)

created
integer <int64>

Creation date (in ISO 8601 format)

modified
string

Last modification date (in ISO 8601 format)

creatorId
string

Unique identifier of the user that created the folder

parentId
string <uuid>

Unique identifier of the parent folder

Responses

200

Folder created

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

post /folders/dictionaries
https://api.onedot.com/gateway/public/endpoints/1.0/folders/dictionaries

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "55ccb8ea-e15a-48f3-a2ba-c700f0d67a04",
  • "name": "My Folder",
  • "size": 1048576,
  • "created": "2017-05-09T23:37:50Z",
  • "modified": "2017-05-09T23:37:50Z",
  • "creatorId": "899afd84-4051-471c-8438-48cb47816af1",
  • "parentId": "899afd84-4051-471c-8438-48cb47816af1"
}

Retrieve Folder

Retrieves the specified folder.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique folder identifier

Responses

200

Folder

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Folder cannot be found

get /folders/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/folders/{id}

Update Folder

Updates the specified Folder.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique folder identifier

Request Body schema: application/json

Folder

id
string <uuid>

Unique identifier

name
required
string

Name

size
number >= 1

Size (in bytes)

created
integer <int64>

Creation date (in ISO 8601 format)

modified
string

Last modification date (in ISO 8601 format)

creatorId
string

Unique identifier of the user that created the folder

parentId
string <uuid>

Unique identifier of the parent folder

Responses

200

Folder updated

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Folder cannot be found

409

Folder with same name already exists

put /folders/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/folders/{id}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": "55ccb8ea-e15a-48f3-a2ba-c700f0d67a04",
  • "name": "My Folder",
  • "size": 1048576,
  • "created": "2017-05-09T23:37:50Z",
  • "modified": "2017-05-09T23:37:50Z",
  • "creatorId": "899afd84-4051-471c-8438-48cb47816af1",
  • "parentId": "899afd84-4051-471c-8438-48cb47816af1"
}

Delete Folder

Deletes the specified Folder.

path Parameters
id
required
string <uuid>
Example: c6eeed3d-837f-4110-8b96-641949fee547

Unique folder identifier

Responses

200

Folder deleted

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

404

Folder cannot be found

delete /folders/{id}
https://api.onedot.com/gateway/public/endpoints/1.0/folders/{id}

Jobs

Retrieve Jobs

Retrieves all jobs.

Responses

200

Jobs

401

Invalid or unauthorized API key

403

Operation not permitted

get /jobs
https://api.onedot.com/gateway/public/endpoints/1.0/jobs

Create Job

Creates the specified Job.

Jobs reference one or more sources, e.g. uploaded Data Files or Dictionary Files, as well as one or more Folders (which again can contain sources). The Recipe describes what to do with the referenced sources and where to publish the processing result to.

Request Body schema: application/json

Job

id
string <uuid>

Unique identifier

name
required
string

Name

created
string

Creation date (in ISO 8601 format)

modified
string

Last modification date (in ISO 8601 format)

sourceIds
Array of strings <uuid>

Unique identifiers of individual sources (data files and dictionary files) referenced by the job

folderIds
Array of strings <uuid>

Unique identifiers of folders referenced by the job

recipeId
required
string <uuid>

Unique identifier of the recipe to use when executing the job

creatorId
string <uuid>

Unique identifier of the user that created the job

Responses

200

Job created

400

Invalid or missing mandatory arguments

401

Invalid or unauthorized API key

403

Operation not permitted

post /jobs
https://api.onedot.com/gateway/public/endpoints/1.0/jobs

Request samples

Content type