Dokumentacja MGBI API
  1. Zlecanie odświeżenia danych
Dokumentacja MGBI API
  • MGBI API
    • Wprowadzenie
    • Autoryzacja
    • Pojęcia
    • Modele danych
      • pl-krs-wp-record
      • pl-krs-rdf-record
      • pl-krz-wp-record
      • pl-wpv-record
      • pl-crbr-wp-record
      • pl-msig-record
    • Endpointy dla modeli danych
      • pl-krs-wp-record
        • Get Record By Id
        • Get Records
        • Stream Records
        • Download File By Id
        • Get Limits
        • Get Projections
      • pl-krs-rdf-record
        • Get Record By Id
        • Get Records
        • Stream Records
        • Download File By Id
        • Get Limits
        • Get Projections
      • pl-krz-wp-record
        • Get Record By Id
        • Get Records
        • Stream Records
        • Get Limits
        • Get Projections
      • pl-wpv-record
        • Get Record By Id
        • Get Records
        • Stream Records
        • Get Limits
        • Get Projections
      • pl-crbr-wp-record
        • Get Record By Id
        • Get Records
        • Stream Records
        • Get Limits
        • Get Projections
      • pl-msig-record
        • Get Record By Id
        • Get Records
        • Stream Records
        • Download File By Id
        • Get Limits
        • Get Projections
    • Zlecanie odświeżenia danych
      • Ogólne informacje
      • Create Refresh
        POST
      • Get Refresh
        GET
  1. Zlecanie odświeżenia danych

Create Refresh

POST
/v1/refresh
Tworzy nowe zlecenie odświeżenia danych.
W przypadku sukcesu w odpowiedzi zwraca parametry nowo utworzonego zlecenia.
W przypadku braku możliwości utworzenia zlecenia, zwraca błąd.
Poprawne wywołanie endpointu zwiększa liczniki:
refresh o liczbę przekazanych identyfikatorów w zleceniu
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.mgbi.pl/v1/refresh' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": {
        "model": "string"
    }
}'
Response Response Example
201 - Example 1
{
    "id": "string",
    "query": {
        "model": "string"
    },
    "creation_datetime": "2019-08-24T14:15:22Z",
    "start_datetime": "2019-08-24T14:15:22Z",
    "finish_datetime": "2019-08-24T14:15:22Z",
    "status": "pending"
}

Request

Header Params
Authorization
string 
optional
Klucz autoryzacji
Example:
aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
Body Params application/json
query
object (SimplifiedQuery) 
required
Zapytanie
model
string 
required
Identyfikator modelu
Additional properties
integer  | number  | string  | boolean 
optional
Additional properties
integer  | number  | string  | boolean 
optional
Examples

Responses

🟢201Created
application/json
Pojedynczy rekord
Body
id
string 
required
Identyfikator zlecenia
query
object (SimplifiedQuery) 
required
Zapytanie
model
string 
required
Identyfikator modelu
Additional properties
integer  | number  | string  | boolean 
optional
creation_datetime
string <date-time>
required
Data i czas utworzenia
start_datetime
string <date-time>
required
Data i czas rozpoczęcia wykonywania
finish_datetime
string <date-time>
required
Data i czas zakończenia wykonywania
status
enum<string> 
required
Aktualny status
Allowed values:
pendingsuccesserror
🟠400Bad request
🟠401Unauthorized
🟠404Not Found
🟠422Parameter Error
Modified at 2025-07-28 14:30:06
Previous
Ogólne informacje
Next
Get Refresh
Built with