API danych planistycznych (0.0.1)

Download OpenAPI specification:

Zgłoszenia danych planistycznych

Przesłanie planu pracy

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object (TimeSeriesData)

Dane grafikowe

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Przesłanie zgłoszenia harmonogramu dyspozycyjności

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object (TimeSeriesData)

Dane grafikowe

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Przesłanie zgłoszenia postoju

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Przesłanie zgłoszenia ubytku

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Przesłanie zgłoszenia niesprawności układu regulacji

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object

Responses

Request samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Przesłanie zgłoszenia polecenia ruchowego OSD

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object (TimeSeriesData)

Dane grafikowe

Responses

Request samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Przesłanie zgłoszenia salda wymiany

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object (TimeSeriesData)

Dane grafikowe

Responses

Request samples

Content type
application/json
Example
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Przesłanie zgłoszenia pojemności użytkowej

Authorizations:
BearerAuth
Request Body schema: application/json
required
required
object (SubmissionMeta)

Nagłówek zgłoszenia danych planistycznych

required
object (TimeSeriesData)

Dane grafikowe

Responses

Request samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0"
}

Odczytanie statusu przetwarzania zgłoszenia danych planistycznych

Authorizations:
BearerAuth
path Parameters
serverMsgId
required
any <uuid>
Examples: 550e8400-e29b-41d4-a716-446655440000

Unikalne ID zgłoszenia nadane przez system PSE

Responses

Response samples

Content type
application/json
{
  • "serverMsgId": "550e8400-e29b-41d4-a716-446655440000",
  • "clientMsgId": "4bfa71da-146b-4df9-b972-6a5ce18f2342",
  • "receivedTime": "2024-03-12T02:00:00.000Z",
  • "status": "SUBMITTED",
  • "stdVersion": "1.0",
  • "responseDetails": [
    ]
}

Aktualne dane planistyczne

Pobranie planu pracy dla zasobu w zadanym zakresie dat

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
{
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "dataPeriod": {
    },
  • "timeSeries": [
    ]
}

Pobranie harmonogramu dyspozycyjności dla zasobu w zadanym zakresie dat

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
{
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "dataPeriod": {
    },
  • "timeSeries": [
    ]
}

Pobranie postojów dla zasobu w zadanym zakresie dat

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Pobranie ubytków dla zasobu w zadanym zakresie dat

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Pobranie niesprawności układów regulacji dla zasobu w zadanym zakresie dat

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Pobranie poleceń ruchowych OSD

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
{
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "dataPeriod": {
    },
  • "timeSeries": [
    ]
}

Pobranie wartości salda wymiany

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
{
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "dataPeriod": {
    },
  • "timeSeries": [
    ]
}

Pobranie wartości pojemności użytkowej

Authorizations:
BearerAuth
path Parameters
mainResourceMrid
required
string <= 60 characters
Example: _d8736017-d25d-4952-a3cf-0fa83560e16f

Identyfikator mRID obiektu

query Parameters
start
required
string <date-time>
Example: start=2024-03-12T02:00:00Z

Data i czas początku zakresu w UTC

end
required
string <date-time>
Example: end=2024-03-13T02:00:00Z

Data i czas końca zakresu w UTC

Responses

Response samples

Content type
application/json
{
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "dataPeriod": {
    },
  • "timeSeries": [
    ]
}