Jump to

• Request
• Response

Create RiskImpacts

post

/riskImpact

Send a request to this endpoint to create one or more riskImpact. An application object will be created for each JSON object provided in the request body.

Request

Header Parameters

• Authorization:
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<RiskImpact>

Type: array

Title: List<RiskImpact>

Show Source

• Array of: object RiskImpact
  Title: RiskImpact

  RiskImpact Entity

{
    "title":"List<RiskImpact>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RiskImpact"
    }
}

Nested Schema : RiskImpact

Type: object

Title: RiskImpact

RiskImpact Entity

Show Source

• CreateDate: string (date-time)
  The date this risk impact was created.
• CreateUser: string
  The name of the user that created the risk impact.
• IsBaseline: boolean
  The boolean value indicating if this business object is related to a Project or Baseline.
• IsTemplate: boolean
  The boolean value indicating if this business object is related to a template Project.
• LastUpdateDate: string (date-time)
  The date this risk impact was last updated.
• LastUpdateUser: string
  The name of the user that last updated the risk impact.
• ProjectId: string
  The short name of the associated project.
• ProjectName: string
  The name of the associated project.
• ProjectObjectId: integer (int32)
  The unique ID of the associated project.
• RiskId: string
  The ID of the Risk. Must be unique within a project.
• RiskName: string
  The name of the Risk. Does not need to be unique.
• RiskObjectId(required): integer (int32)
  The unique ID of the associated risk.
• RiskThresholdLevelCode: string
  The 10 character short name for the threshold level. Must be unique.
• RiskThresholdLevelName: string
  The 40 character name for the threshold level. Does not need to be unique.
• RiskThresholdLevelObjectId(required): integer (int32)
  The unique ID of the associated Risk Threshold.
• RiskThresholdName: string
  The name of the associated risk score type.
• RiskThresholdObjectId: integer (int32)
  The unique ID of the associated Risk Threshold Type.

{
    "title":"RiskImpact",
    "required":[
        "RiskObjectId",
        "RiskThresholdLevelObjectId"
    ],
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this risk impact was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created the risk impact."
        },
        "IsBaseline":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a Project or Baseline."
        },
        "IsTemplate":{
            "type":"boolean",
            "description":"The boolean value indicating if this business object is related to a template Project."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this risk impact was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated the risk impact."
        },
        "ProjectId":{
            "type":"string",
            "description":"The short name of the associated project."
        },
        "ProjectName":{
            "type":"string",
            "description":"The name of the associated project."
        },
        "ProjectObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated project.",
            "format":"int32"
        },
        "RiskId":{
            "type":"string",
            "description":"The ID of the Risk. Must be unique within a project."
        },
        "RiskName":{
            "type":"string",
            "description":"The name of the Risk. Does not need to be unique."
        },
        "RiskObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated risk.",
            "format":"int32"
        },
        "RiskThresholdLevelCode":{
            "type":"string",
            "description":"The 10 character short name for the threshold level. Must be unique."
        },
        "RiskThresholdLevelName":{
            "type":"string",
            "description":"The 40 character name for the threshold level. Does not need to be unique."
        },
        "RiskThresholdLevelObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated Risk Threshold.",
            "format":"int32"
        },
        "RiskThresholdName":{
            "type":"string",
            "description":"The name of the associated risk score type."
        },
        "RiskThresholdObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated Risk Threshold Type.",
            "format":"int32"
        }
    },
    "description":"RiskImpact Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Resource Created.

Body ()

Root Schema : CreateRiskImpactResponse

Type: object

Title: CreateRiskImpactResponse

CreateRiskImpactResponse Entity

Show Source

• RiskObjectId: integer (int32)
  The unique ID of the associated risk.
• RiskThresholdObjectId: integer (int32)
  The unique ID of the associated Risk Threshold Type.

{
    "title":"CreateRiskImpactResponse",
    "type":"object",
    "properties":{
        "RiskObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated risk.",
            "format":"int32"
        },
        "RiskThresholdObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated Risk Threshold Type.",
            "format":"int32"
        }
    },
    "description":"CreateRiskImpactResponse Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top