Skip to content
EUDR Compliance API/
/
ViewSet for data exchange...

Coolset EUDR Compliance API (1.0)

EUDR compliance tools including due diligence statements, risk assessments, traceability, and evidence management.

Download OpenAPI description
eudr-api.json
eudr-api.yaml
Overview
URL
https://coolset.com
E-mail
support@coolset.com
Languages
Servers
Mock server
https://api.coolset.com/_mock/eudr-api/
Production server
https://developers-pulse.coolset.com/api/

Order Tracing

Operations

compliance

Operations

documents

Operations

eudr

Operations

imports

Operations

ViewSet for data exchange runs providing list, create, and retrieve operations.

Request

  • list: Get all data exchange runs for the authenticated user's company
  • create: Create a new data exchange run
  • retrieve: Get a single data exchange run by ID
Security
Bearer
Query
orderingstring

Which field to use when ordering the results.

searchstring

A search term.

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

curl -i -X GET \
  'https://api.coolset.com/_mock/eudr-api/imports?ordering=string&search=string&limit=0&offset=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
nextstring or null(uri)
previousstring or null(uri)
resultsArray of objects(DataExchangeRun)required
results[].​idinteger(ID)read-only
results[].​run_idstring(uuid)(Run id)read-only

Unique identifier for this data exchange run

results[].​company_idinteger(Company id)read-only

ID of the company this data exchange run belongs to

results[].​resultsobject(Results)

The output of the data exchange run

results[].​documentinteger or null(Document)
results[].​model_identifierstring(Model identifier)non-emptyread-only
results[].​created_atstring(date-time)(Created at)read-only
results[].​updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "count": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "results": [
    { … }
  ]
}

ViewSet for data exchange runs providing list, create, and retrieve operations.

Request

  • list: Get all data exchange runs for the authenticated user's company
  • create: Create a new data exchange run
  • retrieve: Get a single data exchange run by ID
Security
Bearer
Bodyapplication/jsonrequired
resultsobject(Results)required

Results of the data exchange run

document_idinteger(Document id)required

Associated document ID

model_identifierstring(Model identifier)non-emptyrequired

Associated model identifier

dry_runboolean(Dry run)

Whether to run the data exchange run in dry run mode

Default true
curl -i -X POST \
  https://api.coolset.com/_mock/eudr-api/imports \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "results": {},
    "document_id": 0,
    "model_identifier": "string",
    "dry_run": true
  }'

Responses

Bodyapplication/json
resultsobject(Results)required

Results of the data exchange run

document_idinteger(Document id)required

Associated document ID

model_identifierstring(Model identifier)non-emptyrequired

Associated model identifier

dry_runboolean(Dry run)

Whether to run the data exchange run in dry run mode

Default true
idinteger(Id)read-only
run_idstring(uuid)(Run id)read-only
company_idinteger(Company id)read-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "results": {},
  "document_id": 0,
  "model_identifier": "string",
  "dry_run": true,
  "id": 0,
  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  "company_id": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

ViewSet for data exchange runs providing list, create, and retrieve operations.

Request

  • list: Get all data exchange runs for the authenticated user's company
  • create: Create a new data exchange run
  • retrieve: Get a single data exchange run by ID
Security
Bearer
Path
idstringrequired
curl -i -X GET \
  'https://api.coolset.com/_mock/eudr-api/imports/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idinteger(ID)read-only
run_idstring(uuid)(Run id)read-only

Unique identifier for this data exchange run

company_idinteger(Company id)read-only

ID of the company this data exchange run belongs to

resultsobject(Results)

The output of the data exchange run

documentinteger or null(Document)
model_identifierstring(Model identifier)non-emptyread-only
created_atstring(date-time)(Created at)read-only
updated_atstring(date-time)(Updated at)read-only
Response
application/json
{
  "id": 0,
  "run_id": "dded282c-8ebd-44cf-8ba5-9a234973d1ec",
  "company_id": 0,
  "results": {},
  "document": 0,
  "model_identifier": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

traces

Operations