Skip to main content
POST
Create an unavailability for a producer plant.

Path Parameters

contractID
string
required
Pattern: ^[\w-]+$
userID
string
required
Pattern: ^[\w-]+$

Body

start
string<date-time>
required

The timestamp when the feed limitation begins

end
string<date-time>
required

The timestamp when the feed limitation ends

availability_type
enum<string>
required

Is the feed capped (cannot feed more than) or scaled (a part of the plant is not available)?

  • cap - cap
  • scale - scale
Available options:
cap,
scale
value
number<double>
required

value of the feed limitation, for unit % between 0-100, for unit W up to plant capacity

unit
enum<string>
required

% for scaled feed limitation, W for capped feed limitation

  • % - %
  • W - W
Available options:
%,
W
reason_type
enum<string>
required

classification on limitation reason

  • technical - technical
  • weather-dependent - weather-dependent
  • other - other
Available options:
technical,
weather-dependent,
other
reason_description
string | null

short description to clarify limitation

Response

201 - application/json
start
string<date-time>
required

The timestamp when the feed limitation begins

end
string<date-time>
required

The timestamp when the feed limitation ends

availability_type
enum<string>
required

Is the feed capped (cannot feed more than) or scaled (a part of the plant is not available)?

  • cap - cap
  • scale - scale
Available options:
cap,
scale
value
number<double>
required

value of the feed limitation, for unit % between 0-100, for unit W up to plant capacity

unit
enum<string>
required

% for scaled feed limitation, W for capped feed limitation

  • % - %
  • W - W
Available options:
%,
W
reason_type
enum<string>
required

classification on limitation reason

  • technical - technical
  • economic - economic
  • redispatch - redispatch
  • weather-dependent - weather-dependent
  • other - other
Available options:
technical,
economic,
redispatch,
weather-dependent,
other
id
integer
required
reason_description
string | null

short description to clarify limitation