Outgoing Data Products

Server

Discover, inspect and download generated data products

Create download job for report

POST

https://api.entur.io/cleos-reporting

/api/v2/partner-data/dataset/{datasetId}/report

Creates an asynchronous download job that will format the dataset and make it available as a report via a signed bucket URL. Note that targetFormat CSV and CSV2 will both produce the same CSV2 format.

Create download job for report › path Parameters

datasetId

integer · int64 · required · style: simple

Create download job for report › query Parameters

targetFormat

string · enum · style: form · explode: true

Optional conversion format for Parquet datasets (PARQUET, XLSX, CSV2)

Enum values:

UNKNOWN

PDF

CSV

CSV2

XLSX

SAFT_GL

PROFF1

PROFF2

Create download job for report › Headers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Create download job for report › Responses

Created

DTO for an asynchronous dataset download job. The formatted report itself can be downloaded by the client using the provided signed bucket URL. A formatted report is considered transient, and is identified by the download job that formats it. Note that a signed bucket URL will expire after a fixed period of time, typically 24 hours.

PartnerDatasetDownloadJobDto

id

string · uuid

UUID of this download job. The job will automatically expire after a fixed period of time after completion.

status

integer · int32

Current status of the job: 0=Ordered, 1=COMPLETED, 2=Failed, 3=Expired, 5=Processing.

description

string

Best effort explanation for the status.

reportName

string

Suggested report filename for the formatted dataset.

contentType

string

MIME Type of the formatted dataset.

datasetIDs

integer[]

List of Dataset IDs that will be included in the download job. The API will always return a single ID since it does not support merging datasets.

jobCreatedAt

string · date-time

Timestamp when the download job was created.

rows

integer · int64

The number of rows in the formatted dataset when COMPLETED.

signedBucketUrl

string

The signed URL to download the formatted dataset when COMPLETED.

crc32c

string

Checksum of a formatted dataset when COMPLETED, this can be used by the client to verify the download. Not available for legacy reports.

POST/api/v2/partner-data/dataset/{datasetId}/report

curl https://api.entur.io/cleos-reporting/api/v2/partner-data/dataset/:datasetId/report \
  --request POST \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "1170fca5-b0d6-4661-a002-112a21bde824",
  "status": 0,
  "description": "0",
  "reportName": "SD-GL-1_ATB_AS_-_2024100772511_v1.1.1.csv",
  "contentType": "text/csv",
  "datasetIDs": [
    7315613
  ],
  "jobCreatedAt": "2024-12-06T09:09:47.713993",
  "rows": 1340,
  "signedBucketUrl": "https://storage.googleapis.com/cleos-rep-test-bucket/060852c8-5fc8-4c55-a5ce-ee3ef3849ec3?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cleos-rep-bucket-sa%40ent-clerep-dev.iam.gserviceaccount.com%2F20241204%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20241204T144627Z&X-Goog-Expires=86400&X-Goog-SignedHeaders=host&X-Goog-Signature=68a825a7dd51cde....",
  "crc32c": "+1nWcg=="
}

text

*/*

Fetch formatted report metadata

GET

https://api.entur.io/cleos-reporting

/api/v2/partner-data/report/{jobId}

Wait for asynchronous job and and return formatted report metadata. The report itself can be downloaded by the client using the provided signed bucket URL.

Fetch formatted report metadata › path Parameters

jobId

string · uuid · required · style: simple

Fetch formatted report metadata › query Parameters

waitFor

integer · int32 · style: form · explode: true

Wait in seconds, max 40

Default: 0

Fetch formatted report metadata › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Fetch formatted report metadata › Responses

OK. The report is available for download.

PartnerDatasetDownloadJobDto

id

string · uuid

UUID of this download job. The job will automatically expire after a fixed period of time after completion.

status

integer · int32

Current status of the job: 0=Ordered, 1=COMPLETED, 2=Failed, 3=Expired, 5=Processing.

description

string

Best effort explanation for the status.

reportName

string

Suggested report filename for the formatted dataset.

contentType

string

MIME Type of the formatted dataset.

datasetIDs

integer[]

List of Dataset IDs that will be included in the download job. The API will always return a single ID since it does not support merging datasets.

jobCreatedAt

string · date-time

Timestamp when the download job was created.

rows

integer · int64

The number of rows in the formatted dataset when COMPLETED.

signedBucketUrl

string

The signed URL to download the formatted dataset when COMPLETED.

crc32c

string

Checksum of a formatted dataset when COMPLETED, this can be used by the client to verify the download. Not available for legacy reports.

GET/api/v2/partner-data/report/{jobId}

curl https://api.entur.io/cleos-reporting/api/v2/partner-data/report/:jobId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": "1170fca5-b0d6-4661-a002-112a21bde824",
  "status": 0,
  "description": "0",
  "reportName": "SD-GL-1_ATB_AS_-_2024100772511_v1.1.1.csv",
  "contentType": "text/csv",
  "datasetIDs": [
    7315613
  ],
  "jobCreatedAt": "2024-12-06T09:09:47.713993",
  "rows": 1340,
  "signedBucketUrl": "https://storage.googleapis.com/cleos-rep-test-bucket/060852c8-5fc8-4c55-a5ce-ee3ef3849ec3?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=cleos-rep-bucket-sa%40ent-clerep-dev.iam.gserviceaccount.com%2F20241204%2Fauto%2Fstorage%2Fgoog4_request&X-Goog-Date=20241204T144627Z&X-Goog-Expires=86400&X-Goog-SignedHeaders=host&X-Goog-Signature=68a825a7dd51cde....",
  "crc32c": "+1nWcg=="
}

text

*/*

Get dataset metadata

GET

https://api.entur.io/cleos-reporting

/api/v2/partner-data/dataset/{datasetId}

Get dataset metadata. This does not include a download URL, create a download job for that.

Get dataset metadata › path Parameters

datasetId

integer · int64 · required · style: simple

Get dataset metadata › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get dataset metadata › Responses

Metadata for a Dataset. A Dataset is a batch of data that contributes to a Data Product. The Dataset may be downloaded as a formatted Report via this API, or via BigQuery depending on Dataset Type.

PartnerDatasetRpt

id

integer · int64

ID of this dataset.

dataProductVersion

integer · int64

Id of the specific version of the data product template used.

dataProductCode

string

The data product code, this may be contributed to by several template versions over time.

orderDate

string · date

The System Date for the dataset creation.

orderBy

string

Created by user or system.

datasetType

string

Classification of the dataset. PARQUET sets can be formatted and downloaded on demand. BIGQUERY can not be downloaded, only accessed via BigQuery. LEGACY reports (CSV, XLSX) are preformatted.

datasetName

string

Userfriendly name of the dataset, typically used as the filename when downloaded.

status

integer · int32

Current status of the dataset: 0=Ordered, 1=COMPLETED, 2=Failed, 4=On Demand (DEPRECATED), 3=Cancelled, 9=Processing.

rows

integer · int32

Number of rows in the dataset when COMPLETED. Not available for legacy reports.

bqProject

string

Destination BigQuery project when dataset is of type BIGQUERY.

chartOfAccountsRef

string

The Chart of Accounts this dataset is derived from, if defined.

ownerOrgRef

string

Organisation owning the dataset with self-service access.

copyOrgRefs

string[]

Recipients of the dataset with self-service and M2M access.

acctMonthId

integer · int64

Clearing system Accounting Month ID used by this dataset.

glBatchId

integer · int64

GL Batch ID potentially used by this dataset.

apBatchId

integer · int64

AP Batch ID potentially used by this dataset.

arBatchId

integer · int64

AR Batch ID potentially used by this dataset.

inBatchId

integer · int64

IN Batch ID potentially used by this dataset.

agreementId

integer · int64

Clearing system Agreement ID potentially used by this dataset.

GET/api/v2/partner-data/dataset/{datasetId}

curl https://api.entur.io/cleos-reporting/api/v2/partner-data/dataset/:datasetId \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "id": 7232958,
  "dataProductVersion": 1108,
  "dataProductCode": "SD-GL-1",
  "orderDate": "2024-12-03",
  "orderBy": "CLEOS",
  "datasetType": "PARQUET",
  "datasetName": "SD-GL-1_ATB_AS_-_2024100772511_v1.1.1.parquet",
  "status": 0,
  "rows": 1340,
  "bqProject": "ent-data-vyg-ext-tst",
  "chartOfAccountsRef": "EOS:ChartOfAccounts:210",
  "ownerOrgRef": "4",
  "copyOrgRefs": [
    5,
    6
  ],
  "acctMonthId": 3201,
  "glBatchId": 2024120172588,
  "apBatchId": 161004032,
  "arBatchId": 840007997,
  "inBatchId": 790,
  "agreementId": 3752
}

text

*/*

Find next dataset id

GET

https://api.entur.io/cleos-reporting

/api/v2/partner-data/dataproduct/{dataProductVersion}/next

Find next dataset in the dataproduct identified by the dataProductVersion. The dataset must have the clients authenticated Organisation on the copy list. A dataset is defined as newer by having a greater ID than the provided (typically the previous successfully downloaded ID). The ID sequence may have holes but is always increasing. When synchronizing a new dataproduct with a backlog of datasets, the initial idAfter can be identified via the self service portal. Alternatively use idAfter=0 in combination with a fromDate to limit backlogged downloads.

Find next dataset id › path Parameters

dataProductVersion

integer · int64 · required · style: simple

Find next dataset id › query Parameters

idAfter

integer · int64 · required · style: form · explode: true

Return the first dataset ID from DataProduct with ID larger than this

fromDate

string · date · style: form · explode: true

Limit to datasets ordered on or after this date

Find next dataset id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Find next dataset id › Responses

integer · int64

Did you find what you were looking for?

Outgoing Data Products

Create download job for report

Create download job for report › path Parameters

Create download job for report › query Parameters

Create download job for report › Headers

Create download job for report › Responses

Fetch formatted report metadata

Fetch formatted report metadata › path Parameters

Fetch formatted report metadata › query Parameters

Fetch formatted report metadata › Headers

Fetch formatted report metadata › Responses

Get dataset metadata

Get dataset metadata › path Parameters

Get dataset metadata › Headers

Get dataset metadata › Responses

Find next dataset id

Find next dataset id › path Parameters

Find next dataset id › query Parameters

Find next dataset id › Headers

Find next dataset id › Responses

Build with Entur

Contribute

Terms & Policies