Batch Update Program Risk Weather Periods
put
/api/restapi/programRiskWeatherPeriod/batch
Send a request to this endpoint to update one or more program risk weather periods.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityProgramRiskWeatherPeriodInput>
Type:
array
Title:
Show Source
List<ApiEntityProgramRiskWeatherPeriodInput>
-
Array of:
object ApiEntityProgramRiskWeatherPeriodInput
Title:
ApiEntityProgramRiskWeatherPeriodInput
This entity represents a ProgramRiskWeatherPeriod object, a unique ProgramRiskWeatherPeriod object can be identified by the following combinations of the fields.- programRiskWeatherPeriodId
- periodName,programRiskId
- periodName,riskCode,programId
- periodName,riskCode,programCode,workspaceCode
Nested Schema : ApiEntityProgramRiskWeatherPeriodInput
Type:
object
Title:
ApiEntityProgramRiskWeatherPeriodInput
This entity represents a ProgramRiskWeatherPeriod object, a unique ProgramRiskWeatherPeriod object can be identified by the following combinations of the fields.
Show Source
- programRiskWeatherPeriodId
- periodName,programRiskId
- periodName,riskCode,programId
- periodName,riskCode,programCode,workspaceCode
-
link: string(url)Read Only:true
Deprecated. As of 24.4.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(required): 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(required): string
(date-time)
The finish date of the period.
-
periodName(required): string
Minimum Length:
1
Maximum Length:255
The name of the period. -
periodStart(required): 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(required): 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)Read Only:true
Deprecated. As of 24.4.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace.
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid input.