Read ActivityCodeAssignments
get
/activityCodeAssignment
Reads ActivityCodeAssignment 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<ActivityCodeAssignment>
Type:
array
Title:
Show Source
List<ActivityCodeAssignment>
-
Array of:
object ActivityCodeAssignment
Title:
ActivityCodeAssignment
ActivityCodeAssignment Entity
Nested Schema : ActivityCodeAssignment
Type:
object
Title:
ActivityCodeAssignment
ActivityCodeAssignment Entity
Show Source
-
ActivityCodeDescription: string
The description of the associated activity code.
-
ActivityCodeObjectId(required): integer
(int32)
The unique ID of the associated activity code.
-
ActivityCodeTypeName: string
The name of the parent activity code type.
-
ActivityCodeTypeObjectId: integer
(int32)
The unique ID of the parent activity code type.
-
ActivityCodeTypeScope: string
The scope of the associated activity code type: Global, EPS, or Project. An activity code with Global scope can be assigned to any activity. An activity code with EPS scope can be assigned only to an activity within a project under that particular EPS. Similarly, an activity code with Project scope can be assigned only to an activity within that particular project.
-
ActivityCodeValue: string
The value of the associated activity code.
-
ActivityId: string
The short ID that uniquely identifies the activity to which the activity code is assigned.
-
ActivityName: string
The name of the activity to which the activity code is assigned.
-
ActivityObjectId(required): integer
(int32)
The unique ID of the activity to which the activity code is assigned.
-
CreateDate: string
(date-time)
The date this code assignment was created.
-
CreateUser: string
The name of the user that created this code assignment.
-
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 code assignment was last updated.
-
LastUpdateUser: string
The name of the user that last updated this code assignment.
-
ProjectId: string
The short code of the associated project.
-
ProjectObjectId: integer
(int32)
The unique ID of the associated project.
-
WBSObjectId: integer
(int32)
The unique ID of the WBS for the associated activity.
400 Response
Bad Request.
401 Response
Unauthorized.
403 Response
Forbidden.
404 Response
Not Found.
405 Response
Invalid Input.
500 Response
Internal Server Error.