Create Report

POST

/v1/reports

Tworzy raport z rekordami pochodzącymi ze wskazanego modelu danych i spełniającymi podane kryteria.

W przypadku sukcesu w odpowiedzi zwraca parametry nowo utworzonego raportu.

W przypadku braku możliwości utworzenia raportu, zwraca błąd.

Poprawne wywołanie endpointu zwiększa liczniki:

reports o 1

records_reports o liczbę rekordów uwzględnionych w raporcie

files_reports o liczbę plików uwzględnionych w raporcie

Request

Header Params

Body Params application/json

Example

{
    "content": [],
    "file_encoding": "utf-8",
    "file_format": "xml",
    "file_password": "mgbi2021",
    "name": "example raport",
    "query": {
        "identifiers.pl_nip": "123456789",
        "model": "pl-krz-wp-record"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mgbi.pl/v1/reports' \
--header 'Content-Type: application/json' \
--data-raw '{
    "content": [],
    "file_encoding": "utf-8",
    "file_format": "xml",
    "file_password": "mgbi2021",
    "name": "example raport",
    "query": {
        "identifiers.pl_nip": "123456789",
        "model": "pl-krz-wp-record"
    }
}'

Responses

🟢201Create new report

application/json

Pojedynczy rekord

Body

Example

{
    "content": [],
    "creation_datetime": "2025-09-11T12:47:28.887705+02:00",
    "downloads": [
        {
            "download_datetime": "2025-09-11T12:47:28.887654+02:00"
        }
    ],
    "file_encoding": "utf-8",
    "file_format": "xml",
    "file_password": "mgbi2021",
    "id": "68c2a8c05d9b51e8c479b1d2",
    "name": "example raport",
    "progress": 0,
    "projection": "default",
    "query": {
        "identifiers.pl_nip": "123456789",
        "model": "pl-krz-wp-record"
    },
    "records_count": 3,
    "status": "preparing"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

Modified at 2025-09-11 12:02:24

Ogólne informacje

Get Report By Id