Entur Developer
Clearing Reports
Clearing Reports

Schemas

Download schema

PartnerDatasetDownloadJobDto

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.
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.

PartnerDatasetRpt

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.
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.

Did you find what you were looking for?