View Work Manger Task Activities by Assigned Code Value.
get
/primeapi/restapi/workManagerTask/project/{id}/codeType/{typeId}/codeValue/{code}
This endpoint returns work manager tasks that meet the following requirements:
- The object is assigned a code type that matches the value of the {typeId} path parameter with a value that matches the value of the {code} path parameter.
Request
Path Parameters
-
code: string
The user-specified identifier of a code value.
-
id: integer(int64)
The system-generated identifier of a code value.
-
typeId: integer(int64)
The system-generated identifier of a code value type.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityWorkManagerTask
Type:
Show Source
object
-
activityCompleteStatus(optional):
string
Allowed Values:
[ "NO_ACTIVITY", "ACTIVITY_COMPLETE_TASK_NOT", "TASK_COMPLETE_ACTIVITY_NOT", "BOTH_COMPLETE", "BOTH_NOT_COMPLETE" ]
Indicates the completion status of the activity and its assigned tasks. -
activityDateStatus(optional):
string
Allowed Values:
[ "INSIDE_ACTIVITY", "OUTSIDE_ACTIVITY", "NO_ACTIVITY" ]
Indicates the overall date status of the activity???s assigned tasks. Outside Activity: A task???s dates are outside of the activity???s Start and Finish dates. Inside Activity: All of the tasks??? dates are within the activity???s Start and Finish dates. No Tasks Assigned: No tasks are assigned to the activity -
activityId:
integer(int64)
Read Only:
true
The activity to which the task is assigned. The activity must have a Type of Activity Dependent or Resource Dependent. -
codeValues(optional):
array codeValues
Unique Items Required:
true
-
commitmentCount(optional):
integer(int64)
The number of commitments on a task.
-
completedDate(optional):
string(date-time)
The date when the task was completed.
-
durationHours(optional):
object Hour
-
favorite(optional):
boolean
-
itemCode:
string
Read Only:
true
The unique identifier assigned to the task. -
itemPrefix(optional):
string
The auto numbering prefix of a code.
-
itemSuffix(optional):
integer(int64)
The auto numbering suffix of a code.
-
link(optional):
string(url)
Read Only:
true
-
overdue(optional):
boolean
Indicates that the due date of a task is in the past.
-
predecessorCount(optional):
integer(int64)
The number of predecessor hand-offs assigned to the task.
-
project:
integer(int64)
Read Only:
true
The unique identifier for the project to which the task was added. -
projectCompanyId:
integer(int64)
Read Only:
true
The name of the company that owns the task. -
sequenceNumber:
integer(int32)
The number that specifies the position of a task within a task hierarchy.
-
slack(optional):
object Duration
-
startDate(optional):
string(date-time)
The date when the task is set to begin.
If the task is set to allow non-work days, the date is calculated as Due Date minus Duration plus 1 day.
If the task is not set to allow non-work days, the date is calculated as Due Date minus the sum of Duration plus Non-Work Days, plus 1 day.
This is a read-only field. -
status(optional):
string
Allowed Values:
[ "NEW", "PENDING", "COMMITTED", "COMPLETED" ]
The current status of the task. Valid values are New, Pending, Committed, and Completed.
This is a read-only field. -
successorCount(optional):
integer(int64)
The number of successor hand-offs assigned to the task.
-
tasksConfiguredFields(optional):
object ApiEntityWorkManagerTaskConfiguredFields
-
tasksId(optional):
integer(int64)
Read Only:
true
The unique identifier of a task. -
tasksName:
string
The name of the task.
-
tentativeDate(optional):
string(date-time)
The date by which the task is expected to be completed.
-
type(optional):
string
Allowed Values:
[ "PUBLIC", "PRIVATE" ]
The type of task. Valid values are Private and Public. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
useCalendar:
boolean
Enables the user to allow only the project calendar's work days and ignore non-work days when determining the value for Start and Due Date.
-
userId(optional):
integer(int64)
Read Only:
true
The person responsible for the task.
Nested Schema : ApiEntityWorkManagerTaskConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing cost fields in the form of key-value pairs.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe non-cost and non-text fields associated with a work manager task.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesAn object containing text fields in the form of key-value pairs.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workManagerTaskId(optional):
integer(int64)
The system-generated identifier of a task.
Nested Schema : ApiEntityCodeValueWorkManagerTask
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueTasksId(optional):
integer(int64)
Read Only:
true
The unique identifier of a code value of a task. -
link(optional):
string(url)
Read Only:
true
-
tasksId(optional):
integer(int64)
The unique identifier of a task.
-
uniqueName(optional):
string
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing cost fields in the form of key-value pairs.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The non-cost and non-text fields associated with a work manager task.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
An object containing text fields in the form of key-value pairs.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
204 Response
Successful operation with no content.
404 Response
The requested work manager task does not exist, or you do not have access to it.