API docs by Redocly

B2B API dla usług wymiany danych planistycznych TSO (1.0.0)

Download OpenAPI specification:

Planning Data Submissions

Submit a work schedule

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (ScheduleSubmissionMeta)

Metadata describing a work schedule submission. Extends the generic submission metadata with a mandatory business type identifying the submission as a planning schedule (PLP).

required
object (TimeSeriesData)

The time-series dataset representing the submitted schedule. Contains the resource identifier, the applicable time interval, and time series with the actual schedule values.

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"
}

Submit an availability schedule

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (AvailabilitySubmissionMeta)

Metadata describing an availability schedule submission. Extends the generic submission metadata with a mandatory business type identifying the dataset as an availability report (HRM).

required
object (TimeSeriesData)

The time-series dataset representing the declared availability of the resource. Contains the resource identifier, the applicable time interval, and time series with the availability values.

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"
}

Submit an outage

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (OutageSubmissionMeta)

Metadata describing an outage submission. Extends the generic submission metadata with a mandatory business type identifying the dataset as an outage report (POS).

required
object (OutageSubmissionData)

Base type for outage submission data. The final structure depends on the value of operationType, which determines whether the submission represents the creation, modification, or withdrawal of an outage.

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"
}

Submit a derate

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (DerateSubmissionMeta)

Metadata describing a derate submission. Extends the generic submission metadata with a mandatory business type identifying the dataset as a derate report (UBT).

required
object (DerateSubmissionData)

Base type for derate submission data. The final structure depends on the value of operationType, which determines whether the submission represents the creation, modification, or withdrawal of a derate.

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"
}

Submit a control malfunction

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (ControlMalfunctionSubmissionMeta)

Metadata describing a control malfunction submission. Extends the generic submission metadata with a mandatory business type identifying the dataset as a control malfunction report (NUR).

required
object (ControlMalfunctionSubmissionData)

Base type for control malfunction submission data. The final structure depends on the value of operationType, which determines whether the submission represents the creation, modification, or withdrawal of a control malfunction.

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"
}

Submit a DSO's dispatch instruction

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (DispatchInstructionSubmissionMeta)

Metadata describing a dispatch instruction submission. Extends the generic submission metadata with a mandatory business type identifying the dataset as a dispatch instruction (PRU).

required
object (TimeSeriesData)

The time-series dataset representing the dispatch instruction. Contains the resource identifier, the applicable time interval, and time series with the instructed operating values.

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"
}

Submit an exchange schedule

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (ExchangeScheduleSubmissionMeta)

Metadata describing an exchange schedule submission. Extends the generic submission metadata with a mandatory business type identifying the dataset as an exchange schedule (WYM).

required
object (TimeSeriesData)

The time-series dataset representing the exchange schedule. Contains the resource identifier, the applicable time interval, and time series with the scheduled exchange values.

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"
}

Submit a storage capacity

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (StorageCapacitySubmissionMeta)

Metadata describing a storage capacity submission. Extends the generic submission metadata with a mandatory business type identifying the dataset as a storage capacity report (PUZ).

required
object (TimeSeriesData)

The time-series dataset representing the storage capacity information. Contains the resource identifier, the applicable time interval, and time series with the declared capacity values.

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"
}

Submit a reactive power regulation limits

Authorizations:
mTLS
Request Body schema: application/json
required
required
object (ReactiveLimitSubmissionMeta)

Metadata describing a reactive power regulation limits submission. Extends the generic submission metadata with a mandatory business type identifying the submission as reactive power regulation limits (ORMB).

required
object (TimeSeriesData)

The time-series dataset representing the submitted reactive power regulation limits. Contains the resource identifier, the applicable time interval, and the complete set of time series describing the regulation range boundaries. For series where an actual limitation applies, seriesPeriods must be provided with the relevant time intervals and quantity values. For series where no limitation applies (the resource can regulate up to its nominal capability for the given combination), seriesPeriods must be omitted — this explicit absence is the canonical way to declare "no limitation beyond nominal capability".

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"
}

Retrieve the processing status of a planning data submission

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

Unique identifier of the submission assigned by the PSE system.

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",
  • "responseDetails": [
    ]
}

Current Planning Data

Retrieve the work schedule for a resource within the specified date range

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

Retrieve the availability schedule for a resource within the specified date range

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

Retrieve outages for a resource within the specified date range

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

Retrieve outage data in the current plan

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

mRID identifier of the resource

unavailabilityMrid
required
string <uuid>
Example: 12346017-d25d-4952-a3cf-0fa83560e16f

Unavailability identifier

Responses

Response samples

Content type
application/json
{
  • "unavailabilityMrid": "12346017-d25d-4952-a3cf-0fa83560e16f",
  • "unavailabilityPeriod": {
    },
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "orderNo": 1,
  • "businessType": "POS",
  • "direction": "GENERATION",
  • "recoverable": false,
  • "reasonDescription": {
    },
  • "state": "ACTIVE"
}

Retrieve derates for a resource within the specified date range

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

Retrieve derate data in the current plan

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

mRID identifier of the resource

unavailabilityMrid
required
string <uuid>
Example: 12346017-d25d-4952-a3cf-0fa83560e16f

Unavailability identifier

Responses

Response samples

Content type
application/json
{
  • "unavailabilityMrid": "12346017-d25d-4952-a3cf-0fa83560e16f",
  • "unavailabilityPeriod": {
    },
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "orderNo": 2,
  • "businessType": "UBTD",
  • "direction": "GENERATION",
  • "recoverable": false,
  • "reasonDescription": {
    },
  • "timeSeries": [
    ],
  • "state": "ACTIVE"
}

Retrieve control malfunctions for a resource within the specified date range

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve control malfunction data in the current plan

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

mRID identifier of the resource

unavailabilityMrid
required
string <uuid>
Example: 12346017-d25d-4952-a3cf-0fa83560e16f

Unavailability identifier

Responses

Response samples

Content type
application/json
{
  • "unavailabilityMrid": "12346017-d25d-4952-a3cf-0fa83560e16f",
  • "unavailabilityPeriod": {
    },
  • "mainResourceMrid": "_d8736017-d25d-4952-a3cf-0fa83560e16f",
  • "orderNo": 2,
  • "businessType": "FCRG",
  • "direction": "GENERATION",
  • "reasonDescription": "Dodatkowy opis przyczyny niedostępności",
  • "state": "ACTIVE"
}

Retrieve DSO's dispatch instructions

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

Retrieve exchange schedule

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

Retrieve storage capacity values

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

Retrieve reactive power regulation limits for a resource within the specified date range

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

mRID identifier of the resource

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

Start date and time of the range in UTC

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

End date and time of the range in UTC

Responses

Response samples

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

SSE Notifications

Subscribe to planning process events

Opens an SSE stream for the specified entity.

Resuming the connection requires providing the Last-Event-ID header.

path Parameters
entityId
required
integer

Identyfikator podmiotu odbierającego powiadomienia o zdarzeniach

header Parameters
Last-Event-ID
string

Identyfikator ostatniego otrzymanego zdarzenia. Po podaniu tego parametru przekazywane są informacje o zdarzeniach, które wystąpiły po zdarzeniu o zadanym identyfikatorze.

Responses