Jump to

• Request
• Response

View all Project Risk Mitigations by Code

get

/api/restapi/riskMitigation/code/{riskMitigationCode}

This endpoint returns project risk mitigations that meet the following requirements:

• The object has a code that matches the value of the {riskMitigationCode} path parameter.

Request

Path Parameters

• riskMitigationCode(required): string
  The user-specified identifier of a risk mitigation.

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<ApiEntityRiskMitigation>

Type: array

Title: List<ApiEntityRiskMitigation>

Show Source

• Array of: object ApiEntityRiskMitigation
  Title: ApiEntityRiskMitigation

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

Nested Schema : ApiEntityRiskMitigation

Type: object

Title: ApiEntityRiskMitigation

Show Source

• activityAssigned: boolean
  Indicates whether an activity is assigned to the response action.
• activityCode: string
  Maximum Length: 60

  The user-specified identifier of the activity.
• activityId: integer (int64)
  The system-generated identifier of the activity.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  The detailed summary of the risk mitigation.
• finishAfterExposure: string
  Allowed Values: [ "TRUE", "FALSE", "MISSING_DATES" ]

  Indicates whether the response action finishes after the start of exposure to the risk.
• finishDate: string (date-time)
  The latest finish date of all risk response action items. If the activity ID is null, then this field is READ ONLY.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• mitigationStatus: string
  Allowed Values: [ "PROPOSED", "SANCTIONED", "NOT_STARTED", "REJECTED", "IN_PROGRESS", "COMPLETED" ]

  The status of the risk response action item.
  Proposed: The response action has been proposed.
  Sanctioned: The response action has been sanctioned.
  Not Started: The response action has not started.
  In Progress: The response action has started but has not been completed.
  Completed: The response action has been completed.
  Rejected: The response action has been rejected.
• ownerId: integer (int64)
  The name of the resource responsible for the risk response action item.
• plannedFinishDate: string (date-time)
  The latest scheduled finish date of all the risk response action items. If the activity ID is null, then this field is READ ONLY.
• plannedStartDate: string (date-time)
  The earliest scheduled start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.
• 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.
• projectName: string
  Maximum Length: 255

  The name of the project.
• projectRiskId: integer (int64)
  The system-generated identifier of the project risk.
• riskCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the risk.
• riskMitigationCode: string
  Minimum Length: 0

  Maximum Length: 60

  The unique identifier for the risk response action item.
• riskMitigationFinancial: riskMitigationFinancial
  The financial fields associated with a risk mitigation.
• riskMitigationId: integer (int64)
  The system-generated identifier of a risk mitigation.
• riskMitigationName: string
  Minimum Length: 0

  Maximum Length: 255

  The name of the risk response action item.
• startDate: string (date-time)
  The earliest start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.
• timing: string
  Allowed Values: [ "STARTING_LATE", "FINISHING_LATE", "MISSING_DATES" ]

  Indicates whether the response action start or finish is before today's date.
• uniqueCode: string
  Maximum Length: 128

  A unique identifier for each Risk Mitigation per project that consists of the parent Risk Code followed by the Risk Mitigation Code.
• 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":"ApiEntityRiskMitigation",
    "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"
            ]
        },
        "projectName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityId":{
            "type":"integer",
            "description":"The system-generated identifier of the activity.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectRiskId":{
            "type":"integer",
            "description":"The system-generated identifier of the project risk.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskMitigationFinancial":{
            "description":"The financial fields associated with a risk mitigation.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityRiskMitigationFinancial"
                }
            ]
        },
        "riskMitigationId":{
            "type":"integer",
            "description":"The system-generated identifier of a risk mitigation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskMitigationCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier for the risk response action item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "riskMitigationName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the risk response action item.",
            "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"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"The detailed summary of the risk mitigation.",
            "exampleSetFlag":false
        },
        "plannedFinishDate":{
            "type":"string",
            "description":"The latest scheduled finish date of all the risk response action items. If the activity ID is null, then this field is READ ONLY.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "plannedStartDate":{
            "type":"string",
            "description":"The earliest scheduled start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "startDate":{
            "type":"string",
            "description":"The earliest start date of all risk response action items. If the activity ID is null, then this field is READ ONLY.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finishDate":{
            "type":"string",
            "description":"The latest finish date of all risk response action items. If the activity ID is null, then this field is READ ONLY.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ownerId":{
            "type":"integer",
            "description":"The name of the resource responsible for the risk response action item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityAssigned":{
            "type":"boolean",
            "description":"Indicates whether an activity is assigned to the response action.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "timing":{
            "type":"string",
            "description":"Indicates whether the response action start or finish is before today's date.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "STARTING_LATE",
                "FINISHING_LATE",
                "MISSING_DATES"
            ]
        },
        "finishAfterExposure":{
            "type":"string",
            "description":"Indicates whether the response action finishes after the start of exposure to the risk.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "TRUE",
                "FALSE",
                "MISSING_DATES"
            ]
        },
        "uniqueCode":{
            "maxLength":"128",
            "type":"string",
            "description":"A unique identifier for each Risk Mitigation per project that consists of the parent Risk Code followed by the Risk Mitigation Code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "mitigationStatus":{
            "type":"string",
            "description":"The status of the risk response action item. <br />Proposed: The response action has been proposed. <br />Sanctioned: The response action has been sanctioned. <br />Not Started: The response action has not started. <br />In Progress: The response action has started but has not been completed. <br />Completed: The response action has been completed. <br />Rejected: The response action has been rejected.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROPOSED",
                "SANCTIONED",
                "NOT_STARTED",
                "REJECTED",
                "IN_PROGRESS",
                "COMPLETED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : riskMitigationFinancial

The financial fields associated with a risk mitigation.

Match All

Show Source

• object ApiEntityRiskMitigationFinancial
  Title: ApiEntityRiskMitigationFinancial

{
    "description":"The financial fields associated with a risk mitigation.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityRiskMitigationFinancial"
        }
    ]
}

Nested Schema : ApiEntityRiskMitigationFinancial

Type: object

Title: ApiEntityRiskMitigationFinancial

Show Source

• actualCost: number (double)
  The response action Actual Cost.
• atCompletionTotalCost: number (double)
  The response action At Completion Cost.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• postResponseActualCost: number (double)
  The response action Post-Response Actual Cost.
• postResponseAtCompletionTotalCost: number (double)
  The response action Post-Response At Completion Cost.
• postResponseRemainingTotalCost: number (double)
  The response action Post-Response Remaining Cost.
• preResponseActualCost: number (double)
  The response action Pre-Response Actual Cost.
• preResponseAtCompletionCost: number (double)
  The response action Pre-Response At Completion Cost.
• preResponseRemainingTotalCost: number (double)
  The response action Pre-Response Remaining Cost.
• remainingTotalCost: number (double)
  The response action Remaining Cost.
• riskMitigationId: integer (int64)
  The system-generated identifier of a risk mitigation.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityRiskMitigationFinancial",
    "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"
            ]
        },
        "remainingTotalCost":{
            "type":"number",
            "description":"The response action Remaining Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "atCompletionTotalCost":{
            "type":"number",
            "description":"The response action At Completion Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "actualCost":{
            "type":"number",
            "description":"The response action Actual Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseRemainingTotalCost":{
            "type":"number",
            "description":"The response action Pre-Response Remaining Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseActualCost":{
            "type":"number",
            "description":"The response action Pre-Response Actual Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "preResponseAtCompletionCost":{
            "type":"number",
            "description":"The response action Pre-Response At Completion Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseRemainingTotalCost":{
            "type":"number",
            "description":"The response action Post-Response Remaining Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseActualCost":{
            "type":"number",
            "description":"The response action Post-Response Actual Cost.    ",
            "format":"double",
            "exampleSetFlag":false
        },
        "postResponseAtCompletionTotalCost":{
            "type":"number",
            "description":"The response action Post-Response At Completion Cost.",
            "format":"double",
            "exampleSetFlag":false
        },
        "riskMitigationId":{
            "type":"integer",
            "description":"The system-generated identifier of a risk mitigation.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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 project risk mitigation does not exist, or you do not have access to it.

Back to Top