PWDP B2B API 0.0.1

Specyfikacja asynchronicznego API na potrzeby zgłaszania danych planistycznych

Servers

  • amqps://${PSE_AMQP}/amqps 1.0.0amqp-cluster

    B2B AMQP broker

Operations

  • SEND pwdp.submission

    Kanał do wysyłania do OSP zgłoszeń danych planistycznych

    Wysłanie zgłoszenia danych planistycznych

    Operation IDsendSubmission

    Available only on servers:

    Accepts one of the following messages:

    • #0Zgłoszenie danych w postaci grafików
      Message IDTimeSeriesSubmission

      Umożliwia zgłoszenie:

      • planów pracy
      • harmonogramów dyspozycyjności
      • poleceń ruchowych OSD
      • salda wymiany
      • pojemności użytkowej
      object

      Zgłoszenie w postaci serii danych

      Examples

    • #1Zgłoszenie postoju
      Message IDOutageSubmission

      Umożliwia zgłoszenie postoju

      object

      Zgłoszenie postoju

      Examples

    • #2Zgłoszenie ubytku
      Message IDDerateSubmission

      Umożliwia zgłoszenie ubytku

      object

      Zgłoszenie ubytku

      Examples

    • #3Zgłoszenie niesprawności układu regulacji
      Message IDControlMalfunctionSubmission

      Umożliwia zgłoszenie niesprawności układu regulacji

      object

      Zgłoszenie niesprawności układu regulacji

      Examples

  • RECEIVE pwdp.submissionresponse.{entityId}

    Kanał z odpowiedziami na zgłoszenia danych planistycznych

    Odebranie informacji o statusie przetworzenia zgłoszenia

    Operation IDreceiveSubmissionResponse

    Available only on servers:

    object
    entityId
    required
    string

    Unikalny identyfikator podmiotu.

    Accepts the following message:

    ProcessingStatusResponse
    Message IDProcessingStatusResponse

    Informacja o statusie przetwarzenia zgłoszenia

    object

    Odpowiedź na zapytanie o status przetwarzania przesłanego dokumentu

    Examples

  • RECEIVE pwdp.datachange.{entityId}

    Kanał z powiadomieniami o zmianach w danych planistycznych

    Odebranie informacji o zmianie danych planistycznych, w zakresie:

    • postojów
    • ubytków
    • niesprawności układów regulacji
    Operation IDreceiveDataChange

    Available only on servers:

    object
    entityId
    required
    string

    Unikalny identyfikator podmiotu.

    Accepts one of the following messages:

    • #0Informacja o zmianie postoju
      Message IDOutageChange

      Umożliwia przekazanie informacji o zmianie postoju

      object

      Informacja o zmianie postoju

      Examples

    • #1Informacja o zmianie ubytku
      Message IDDerateChange

      Umożliwia przekazanie informacji o zmianie ubytku

      object

      Informacja o zmianie ubytku

      Examples

    • #2Informacja o zmianie niesprawności układu regulacji
      Message IDControlMalfunctionChange

      Umożliwia przekazanie informacji o zmianie niesprawności układu regulacji

      object

      Informacja o zmianie niesprawności układu regulacji

      Examples

Messages

  • #1Zgłoszenie danych w postaci grafików
    Message IDTimeSeriesSubmission

    Umożliwia zgłoszenie:

    • planów pracy
    • harmonogramów dyspozycyjności
    • poleceń ruchowych OSD
    • salda wymiany
    • pojemności użytkowej
    object

    Zgłoszenie w postaci serii danych

  • #2Zgłoszenie postoju
    Message IDOutageSubmission

    Umożliwia zgłoszenie postoju

    object

    Zgłoszenie postoju

  • #3Zgłoszenie ubytku
    Message IDDerateSubmission

    Umożliwia zgłoszenie ubytku

    object

    Zgłoszenie ubytku

  • #4Zgłoszenie niesprawności układu regulacji
    Message IDControlMalfunctionSubmission

    Umożliwia zgłoszenie niesprawności układu regulacji

    object

    Zgłoszenie niesprawności układu regulacji

  • #5ProcessingStatusResponse
    Message IDProcessingStatusResponse

    Informacja o statusie przetwarzenia zgłoszenia

    object

    Odpowiedź na zapytanie o status przetwarzania przesłanego dokumentu

  • #6Informacja o zmianie postoju
    Message IDOutageChange

    Umożliwia przekazanie informacji o zmianie postoju

    object

    Informacja o zmianie postoju

  • #7Informacja o zmianie ubytku
    Message IDDerateChange

    Umożliwia przekazanie informacji o zmianie ubytku

    object

    Informacja o zmianie ubytku

  • #8Informacja o zmianie niesprawności układu regulacji
    Message IDControlMalfunctionChange

    Umożliwia przekazanie informacji o zmianie niesprawności układu regulacji

    object

    Informacja o zmianie niesprawności układu regulacji

Schemas

  • ResourceMrid
    string
    <= 60 characters

    Identyfikator mRID obiektu

      Examples values:
    • "_d8736017-d25d-4952-a3cf-0fa83560e16f"
  • object

    Nagłówek zgłoszenia danych planistycznych

  • allOf
  • allOf
  • object

    Zestaw danych dla wybranego parametru obejmujący wektor (serię) wartości wraz z wielkościami dla wskazanego parametru wybranego obiektu

  • object

    Seria danych w podanym okresie (szereg czasowy)

  • object

    Seria danych w podanym okresie (szereg czasowy)

  • object

    Wartość parametru w danym punkcie czasu (np. na daną godzinę)

  • object

    Dane grafikowe

  • object

    Zgłoszenie w postaci serii danych

  • object

    Dane niedostępności

  • object

    Dane wycofywanej niedostępności

  • object

    Zgłoszenie postoju

  • object

    Dane zgłoszenia postoju

  • object

    Dane zgłoszenia wycofania postoju

  • allOf
  • object

    Uruchomienie dodatkowe

  • object

    Zgłoszenie ubytku

  • object

    Dane zgłoszenia ubytku

  • object

    Dane zgłoszenia wycofania ubytku

  • allOf
  • object

    Zestaw danych dla wybranego parametru obejmujący wektor (serię) \ wartości wraz z wielkościami dla wskazanego parametru wybranego obiektu

  • object

    Zgłoszenie niesprawności układu regulacji

  • object

    Dane zgłoszenia niesprawności regulacji

  • object

    Dane zgłoszenia wycofania ubytku

  • allOf
  • object

    Przyczyna niedostępności

  • Resolution
    string

    Rozdzielczość serii danych:

    • PT1M - 1 minuta
    • PT5M - 5 minut
    • PT15M - 15 minut
    • PT1H - godzina
    • PT60M - godzina
    • P1D - doba
    • P1M – miesiąc
      Allowed values:
    • "PT1M"
    • "PT5M"
    • "PT15M"
    • "PT1H"
    • "PT60M"
    • "P1D"
    • "P1M"
      Examples values:
    • "PT15M"
  • Direction
    string

    Kierunek, którego dotyczą dane:

    • G - generacja
    • P - pobór
    • C - całkowity
      Allowed values:
    • "G"
    • "P"
    • "C"
      Examples values:
    • "G"
  • CurveType
    string

    Typ sposobu przekazywania wartości

    • A01 - wszystkie punkty
    • A03 - tylko punkty zmian
      Allowed values:
    • "A01"
    • "A03"
      Examples values:
    • "A01"
  • OperationType
    string

    Rodzaj operacji związany ze zgłoszeniem

    • U - utworzenie
    • M - modyfikacja
    • W - wycofanie
      Allowed values:
    • "U"
    • "M"
    • "W"
  • object

    Przedział czasu

  • object

    Przedział czasu z określeniem wykonania początku i końca

  • object

    Opis naruszeń walidacji w czasie przetwarzenia przesłanych dokumentów

  • object

    Odpowiedź potwierdzająca przyjęcie przesłanych danych do przetwarzania

  • object

    Odpowiedź z serwera w przypadku błędu

  • object

    Odpowiedź na zapytanie o status przetwarzania przesłanego dokumentu

  • object

    Nagłówek informacji o zmianie danych planistycznych

  • object

    Informacja o zmianie postoju

  • object

    Informacja o zmianie ubytku

  • object

    Informacja o zmianie niesprawności układu regulacji