Create a Project Risk Weather Period
post
/api/restapi/riskWeatherPeriod
Send a request to this endpoint to create a project risk weather period.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityRiskWeatherPeriodInput
Type:
object
Title:
ApiEntityRiskWeatherPeriodInput
This entity represents a RiskWeatherPeriod object, a unique RiskWeatherPeriod object can be identified by the following combinations of the fields.
Show Source
- riskWeatherPeriodId
- periodName,projectRiskId
- periodName,riskCode,projectId
- periodName,riskCode,projectCode,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.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectRiskId(required): integer
(int64)
The system-generated identifier of a Risk.
-
riskCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the risk. -
riskWeatherPeriodId: integer
(int64)
The system-generated identifier for the period.
-
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
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityRiskWeatherPeriod
Type:
object
Title:
Show Source
ApiEntityRiskWeatherPeriod
-
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.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
projectRiskId: integer
(int64)
The system-generated identifier of a Risk.
-
riskCode: string
Minimum Length:
1
Maximum Length:60
The unique identifier for the risk. -
riskWeatherPeriodId: integer
(int64)
The system-generated identifier for the period.
-
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.
400 Response
Invalid input.