Reads ActivityRisks.
get
/activityRisk
Reads ActivityRisks objects from the database.
Request
Query Parameters
-
Fields(required): string
Fields to loadExample:
Name,ObjectId
-
Filter(required): string
Supported Filter Operators - :gt:, :lt:, :eq:, :gte:, :lte:, :and:, :or:Example:
ObjectId IN(1,2) :and: CreateDate:gte:'2021-04-20' :and: LastUpdateDate:lt:'2022-04-20' :and: Name :like: 'abc%'
-
OrderBy(required): string
OrderBy conditionExample:
ObjectId desc
Header Parameters
-
Authorization(required):
OAuth token
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK.
Root Schema : List<ActivityRisk>
Type:
array
Title:
Show Source
List<ActivityRisk>
-
Array of:
object ActivityRisk
Title:
ActivityRisk
ActivityRisk Entity
Nested Schema : ActivityRisk
Type:
object
Title:
ActivityRisk
ActivityRisk Entity
Show Source
-
ActivityId: string
The id of an activity impacted by the Risk.
-
ActivityName: string
The name of an activity impacted by the Risk. The activity name does not have to be unique.
-
ActivityObjectId(required): integer
(int32)
The unique ID of the activity to which the risk is assigned.
-
CreateDate: string
(date-time)
The date this activity was created.
-
CreateUser: string
The name of the user that created this activity risk.
-
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 activity was last updated.
-
LastUpdateUser: string
The name of the user that last updated this activity risk.
-
ProjectId: string
The short code 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.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.