View all Program Risk Weather Periods by Program ID
get
/api/restapi/programRiskWeatherPeriod/program/{programId}
This endpoint returns program risk weather periods that meet the following requirements:
- The object belongs to a program with an ID value that matches the value of the {programId} path parameter.
Request
Path Parameters
-
programId(required): integer(int64)
The system-generated unique identifier of a program.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityProgramRiskWeatherPeriod>
Type:
array
Title:
Show Source
List<ApiEntityProgramRiskWeatherPeriod>
-
Array of:
object ApiEntityProgramRiskWeatherPeriod
Title:
ApiEntityProgramRiskWeatherPeriod
Nested Schema : ApiEntityProgramRiskWeatherPeriod
Type:
object
Title:
Show Source
ApiEntityProgramRiskWeatherPeriod
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
maxNonWorkingDays: integer
(int32)
The maximum number of non-working days in the period.
-
minNonWorkingDays: integer
(int32)
The minimum number of non-working days in the period.
-
mostLikelyNonWorkingDays: integer
(int32)
The most likely number of non-working days in the period.
-
nonWorkingDaysPercentage: number
(double)
The percentage of non-working days in the period.
-
nonWorkingPersistence: number
(double)
The probability of a non-working day following another non-working day in the period.
-
nonWorkingTimeDefinitionType: string
Allowed Values:
[ "PERCENTAGE", "DISTRIBUTION" ]
The method used to define the weather risk's non-working time. Valid values are Percentage and Distribution. If the value is Percentage, the required fields are non-working persistence and non-working days percentage. If the value is Distribution, the required fields are shape, minimum non-working days, most-likely non-working days, and maximum non-working days. -
periodFinish: string
(date-time)
The finish date of the period.
-
periodName: string
Minimum Length:
1
Maximum Length:255
The name of the period. -
periodStart: string
(date-time)
The start date of the period.
-
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
programRiskId: integer
(int64)
The system-generated identifier of a Risk.
-
programRiskWeatherPeriodId: integer
(int64)
The system-generated identifier for the period.
-
riskCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the risk. -
shape: string
Allowed Values:
[ "TRIANGLE", "UNIFORM", "BETAPERT" ]
The probability distribution that best models the estimates for non-working days in the period. Valid values are Triangle and Uniform. If the value is Uniform, the required fields are minimum and maximum non-working days. If the value is Triangle, the required fields are minimum, maximum, and most-likely non-working days. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
204 Response
Successful operation with no content.
400 Response
The requested program does not exist, or you do not have access to it.