Jump to

• Request
• Response

View all Program Risk Weather Periods by Period Name

get

/api/restapi/programRiskWeatherPeriod/code/{periodName}

This endpoint returns program risk weather periods that meet the following requirements:

• The object has a name that matches the value of the {periodName} path parameter.

Request

Path Parameters

• periodName(required): string
  The user-specified identifier of a program risk weather period.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityProgramRiskWeatherPeriod>

Type: array

Title: List<ApiEntityProgramRiskWeatherPeriod>

Show Source

• Array of: object ApiEntityProgramRiskWeatherPeriod
  Title: ApiEntityProgramRiskWeatherPeriod

{
    "title":"List<ApiEntityProgramRiskWeatherPeriod>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramRiskWeatherPeriod",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProgramRiskWeatherPeriod

Type: object

Title: ApiEntityProgramRiskWeatherPeriod

Show Source

• 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.

{
    "title":"ApiEntityProgramRiskWeatherPeriod",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of a Risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programRiskWeatherPeriodId":{
            "type":"integer",
            "description":"The system-generated identifier for the period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "periodName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the period.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "shape":{
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TRIANGLE",
                "UNIFORM",
                "BETAPERT"
            ]
        },
        "periodStart":{
            "type":"string",
            "description":"The start date of the period.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "periodFinish":{
            "type":"string",
            "description":"The finish date of the period.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "minNonWorkingDays":{
            "type":"integer",
            "description":"The minimum number of non-working days in the period.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "maxNonWorkingDays":{
            "type":"integer",
            "description":"The maximum number of non-working days in the period.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "mostLikelyNonWorkingDays":{
            "type":"integer",
            "description":"The most likely number of non-working days in the period.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "nonWorkingDaysPercentage":{
            "type":"number",
            "description":"The percentage of non-working days in the period.",
            "format":"double",
            "exampleSetFlag":false
        },
        "nonWorkingPersistence":{
            "type":"number",
            "description":"The probability of a non-working day following another non-working day in the period.",
            "format":"double",
            "exampleSetFlag":false
        },
        "nonWorkingTimeDefinitionType":{
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PERCENTAGE",
                "DISTRIBUTION"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested program risk weather period does not exist, or you do not have access to it.

Back to Top