View Activities by Configured Field
get
/primeapi/restapi/activity/project/{id}/configuredField/{viewColumnName}/{value}
This endpoint returns activities that meet the following requirements:
- The object belongs to a project with an ID value that matches the value of the {id} path parameter.
- The object has a configured field with a column name that matches the value of the {viewColumnName} path parameter and a value that matches the value of the {value} path parameter.
Request
Path Parameters
-
id: integer(int64)
The system-generated identifier of a project.
-
value: string
The value of a configured field.
-
viewColumnName: string
The view column name of a configured field.
Response
Supported Media Types
- application/json
200 Response
successful operation
Nested Schema : ApiEntityActivity
Type:
Show Source
object
-
accountingVarianceLaborUnits(optional):
object Unit
-
activityCode(optional):
string
The project activity code assigned to the activity.
-
activityConfiguredFields(optional):
object ApiEntityActivityConfiguredFields
-
activityFinancial(optional):
object ApiEntityActivityFinancial
-
activityId(optional):
integer(int64)
The unique identifier for the activity.
-
activityName(optional):
string
The name of the activity.
-
activityPercentComplete(optional):
object Percent
-
activityPriority(optional):
string
Allowed Values:
[ "TOP", "HIGH", "NORMAL", "LOW", "LOWEST" ]
Determines the priority of the activity when performing role leveling. -
activitySettings(optional):
array activitySettings
Unique Items Required:
true
An object containing the settings applied to an activity. -
activityStatus(optional):
string
Allowed Values:
[ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ]
Determines the status of the activity. Valid values are Not Started, In Progress, and Completed. -
activityType(optional):
string
Allowed Values:
[ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "SUMMARY" ]
The type of activity. Valid values are Activity Dependent, Resource Dependent, Level of Effort, Start Milestone, and Finish Milestone. -
activityUncertainties(optional):
array activityUncertainties
Unique Items Required:
true
The uncertainties associated with an activity. -
activityWorkManagerTaskDateStatus(optional):
string
Allowed Values:
[ "NO_TASK_DATES", "ALL_WITHIN", "AT_LEAST_ONE_OUTSIDE" ]
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.
This is a read-only field. -
activityWorkManagerTaskStatus(optional):
string
Allowed Values:
[ "NO_TASKS", "ACTIVITY_COMPLETE_TASKS_NOT", "TASKS_COMPLETE_ACTIVITY_NOT" ]
The current status of the task assigned to the activity. Valid values are New, Pending, Committed, and Completed.
This is a read-only field. -
activityWorkManagerTaskStatusIndicator(optional):
boolean
Indicates whether any of the activity's assigned tasks have dates or completion statuses that requires attention.
This is a read-only field. -
actualDuration(optional):
object Duration
-
actualFinish(optional):
string(date-time)
The date when the activity was completed.
-
actualLaborUnits(optional):
object Unit
-
actualNonLaborUnits(optional):
object Unit
-
actualStart(optional):
string(date-time)
The date work on the activity began.
-
actualThisPeriodLaborUnits(optional):
object Unit
-
actualThisPeriodNonLaborUnits(optional):
object Unit
-
atCompletionBudgetLaborUnits(optional):
object Unit
-
atCompletionDuration(optional):
object Duration
-
atCompletionLaborUnits(optional):
object Unit
-
atCompletionNonLaborUnits(optional):
object Unit
-
baselineDuration(optional):
object Duration
-
baselineFinishDate(optional):
string(date-time)
The finish date for the activity in the project baseline.
-
baselinePlannedLaborUnits(optional):
object Unit
-
baselinePlannedNonLaborUnits(optional):
object Unit
-
baselineStartDate(optional):
string(date-time)
The current start date of the activity in the project baseline.
-
calendar:
integer(int64)
The calendar assigned to the activity.
-
calendarName(optional):
string
The name of the calendar.
-
codeValuesActivity(optional):
array codeValuesActivity
Unique Items Required:
true
The categories applied to an activity. -
completedWeight(optional):
number(double)
The weight of the activity percent completed value.
-
constraintDate(optional):
string(date-time)
The constraint date for the activity, if the activity has a constraint.
-
constraintType(optional):
string
Allowed Values:
[ "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ]
The main restriction impacting the activity start or finish date. -
critical(optional):
boolean
Designates an activity as critical. An activity is defined as critical based upon the project settings configured for the project.
-
drivingPath(optional):
boolean
The sequence of project activities from start to finish where the Total Duration is longer than any other path.
-
durationPercentComplete(optional):
object Percent
-
durationPercentOfPlanned(optional):
object Percent
-
durationType(optional):
string
Allowed Values:
[ "FIXED_RATE", "FIXED_QUANTITY", "FIXED_DURATION_AND_UNITS", "FIXED_DURATION" ]
Determines how remaining duration, units, and units/time are calculated when you update an activity that has resources assigned. The valid values are Fixed Units/Time, Fixed Units, Fixed Duration & Units, and Fixed Duration & Units/Time. -
earlyFinish(optional):
string(date-time)
The earliest possible date the activity can finish.
This date is calculated based on network logic, schedule constraints, and resource availability. -
earlyStart(optional):
string(date-time)
The earliest possible date the remaining work for the activity can begin.
This date is calculated based on network logic, schedule constraints, and resource availability. -
earnedValueLaborUnits(optional):
object Unit
-
estimateAtCompletionLaborUnits(optional):
object Unit
-
estimateToCompletionLaborUnits(optional):
object Unit
-
expectedFinish(optional):
string(date-time)
The date you expect work on the activity to finish.
-
finishDate(optional):
string(date-time)
The current finish date for the activity.
-
floatPath(optional):
integer(int64)
Indicates which critical path the activity is on. An activity with a floatPath value of 1 is on the most critical path, whereas an activity with a floatPath value of 2 is on the second most critical path, and so on.
-
floatPathOrder(optional):
integer(int64)
The position of the activity on its critical path.
-
freeFloat(optional):
object Duration
-
laborUnitsCompletePercent(optional):
object Percent
-
lateFinish(optional):
string(date-time)
The latest possible date the activity can finish without delaying the project finish date.
This date is calculated based on activity relationships, schedule constraints, and resource availability. -
lateStart(optional):
string(date-time)
The latest possible date the remaining work for the activity can begin without delaying the project finish date.
This date is calculated based on activity relationships, schedule constraints, and resource availability. -
link(optional):
string(url)
Read Only:
true
-
location(optional):
integer(int64)
The physical location associated with the activity.
-
name(optional):
string
The name of the activity.
-
nonLaborUnitsCompletePercent(optional):
object Percent
-
owner(optional):
string
The user responsible for the activity.
-
percentCompleteType(optional):
string
Allowed Values:
[ "PHYSICAL", "DURATION", "UNITS" ]
Determines the way in which the application calculates the percent complete for the activity. Valid values are Physical, Duration, and Units. -
percentCompleteWeightedBy(optional):
string
Allowed Values:
[ "COST", "QUANTITY", "HOUR", "MANUAL" ]
The method used to calculate the scope percentage completion for scope assignments. The weight is calculated using cost, quantity, hours, or manually entered values. -
performancePercentComplete(optional):
object Percent
-
physicalPercentComplete(optional):
object Percent
-
plannedDuration(optional):
object Duration
-
plannedFinish(optional):
string(date-time)
The date the activity is scheduled to finish if the activity has not started.
This date is calculated by the project scheduler but can be updated manually by the project manager. This date is not changed by the project scheduler after the activity has started. -
plannedLaborUnits(optional):
object Unit
-
plannedNonLaborUnits(optional):
object Unit
-
plannedStart(optional):
string(date-time)
The date the activity is scheduled to start.
This date the activity is scheduled to begin is calculated by the project scheduler but can be updated manually by the project manager. This date cannot be changed by the project scheduler after the activity has started. -
plannedValueLaborUnits(optional):
object Unit
-
primaryResource(optional):
integer(int64)
The user designated as the primary resource for the activity.
-
projectId(optional):
integer(int64)
The unique identifier of the project to which the activity was added.
-
recordCount(optional):
integer(int32)
The number of activities added to the project.
-
remainingDuration(optional):
object Duration
-
remainingFinish(optional):
string(date-time)
The date the remaining work for the activity is scheduled to finish.
If this activity is not started, this date is the planned finish. This date can be updated manually by the user, but it is overwritten when you schedule the project. -
remainingFloat(optional):
object Duration
-
remainingLaborUnits(optional):
object Unit
-
remainingLateFinish(optional):
string(date-time)
The latest possible date the activity must finish without delaying the project finish date.
This date is calculated by the project scheduler based on activity relationships, schedule constraints, and resource availability. When the activity is complete, this field is blank. -
remainingLateStart(optional):
string(date-time)
The latest possible date the remaining work for the activity must begin without delaying the project finish date.
This date is calculated by the project scheduler based on activity relationship, schedule constraints, and resource availability. -
remainingNonLaborUnits(optional):
object Unit
-
remainingStart(optional):
string(date-time)
The date the remaining work for the activity is scheduled to begin.
This date can be updated manually by the user. Before the activity is started, this date is the same as the planned start. -
resumeDate(optional):
string(date-time)
The date when a suspended task or activity is resumed.
-
schedulePercentComplete(optional):
object Percent
-
schedulePerfIndexLaborUnits(optional):
object Unit
-
scheduleVarianceLaborUnits(optional):
object Unit
-
scheduleVarIndexLaborUnits(optional):
object Unit
-
scopePercentComplete(optional):
object Percent
-
secondaryConstraintDate(optional):
string(date-time)
The date for the activity's secondary constraint, if the activity has a secondary constraint.
-
secondaryConstraintType(optional):
string
Allowed Values:
[ "START_ON", "START_ON_OR_BEFORE", "START_ON_OR_AFTER", "FINISH_ON", "FINISH_ON_OR_BEFORE", "FINISH_ON_OR_AFTER", "AS_LATE_AS_POSSIBLE", "MANDATORY_START", "MANDATORY_FINISH" ]
The secondary restriction impacting the activity start or finish date. -
sequenceNumber(optional):
integer(int32)
The number that specifies the position of the activity relative to others within the view.
-
starred(optional):
boolean
Specifies whether the activity has been marked as important.
-
startDate(optional):
string(date-time)
The current start date of the activity.
For started activities, this is the actual start date. For not started activities, this is the planned start date until the project is scheduled. When scheduled, the start date field is set to the remaining early start date. -
suspendDate(optional):
string(date-time)
The date work has temporarily stopped on a given activity.
-
totalFloat(optional):
object Duration
-
unitsPercentComplete(optional):
object Percent
-
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. -
varDuration(optional):
object Percent
-
varFinishDate(optional):
object Duration
-
varianceAtCompletionLaborUnits(optional):
object Unit
-
varLaborUnits(optional):
object Unit
-
varNonLaborUnits(optional):
object Unit
-
varStartDate(optional):
object Duration
-
wbsId(optional):
integer(int64)
The WBS that the activity is associated with.
-
weight(optional):
number(double)
The importance of the activity in relation to other activities.
-
workManagerTaskCount(optional):
integer(int64)
The number of tasks assigned to an activity.
This is a read-only field. -
workManagerTaskPlannedCompleteCount(optional):
integer(int64)
The number of planned tasks assigned to the activity that are completed.
-
workManagerTaskPlannedNotCompleteCount(optional):
integer(int64)
The number of planned tasks assigned to the activity that are not completed.
-
workManagerTaskPlannedOutsideCount(optional):
integer(int64)
The number of planned tasks assigned to the activity whose Start or Finish dates fall outside of the activity's Start or Finish dates.
-
workManagerTaskUnplannedCompleteCount(optional):
integer(int64)
The number of unplanned tasks assigned to the activity that are completed.
-
workManagerTaskUnplannedNotCompleteCount(optional):
integer(int64)
The number of unplanned tasks assigned to the activity that are not completed.
-
workPackageId(optional):
integer(int64)
The unique identifier for the work package that the activity is associated with.
Nested Schema : Unit
Type:
object
Nested Schema : ApiEntityActivityConfiguredFields
Type:
Show Source
object
-
activityId(optional):
integer(int64)
The unique identifier for the activity.
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with an activity.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with an activity.
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with an activity.
-
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 : ApiEntityActivityFinancial
Type:
Show Source
object
-
accountingVariance(optional):
object Cost
-
activity(optional):
integer(int64)
The unique identifier of the activity.
-
activityId(optional):
integer(int64)
The unique identifier of the activity.
-
actualExpenseCost(optional):
object Cost
-
actualLaborCost(optional):
object Cost
-
actualMaterialCost(optional):
object Cost
-
actualNonLaborCost(optional):
object Cost
-
actualThisPeriodLaborCost(optional):
object Cost
-
actualThisPeriodMaterialCost(optional):
object Cost
-
actualThisPeriodNonLaborCost(optional):
object Cost
-
actualTotalCost(optional):
object Cost
-
atCompletionExpenseCost(optional):
object Cost
-
atCompletionLaborCost(optional):
object Cost
-
atCompletionMaterialCost(optional):
object Cost
-
atCompletionNonLaborCost(optional):
object Cost
-
atCompletionTotalCost(optional):
object Cost
-
atCompletionVariance(optional):
object Cost
-
blplannedExpenseCost(optional):
object Cost
-
blplannedLaborCost(optional):
object Cost
-
blplannedMaterialCost(optional):
object Cost
-
blplannedNonLaborCost(optional):
object Cost
-
blplannedTotalCost(optional):
object Cost
-
budgetAtCompletion(optional):
object Cost
-
costVarianceIndex(optional):
number(double)
The ratio of the cost variance and the earned value of work performed on the WBS or activity.
-
costVarianceLaborUnits(optional):
object Unit
-
costVarianceLaborUnitsIndex(optional):
number(double)
The ratio of the cost variance labor units and the earned value labor units for the activity.
-
earnedValueCost(optional):
object Cost
-
earnedValueLaborUnits(optional):
object Unit
-
estimateAtCompletionCost(optional):
object Cost
-
estimateToCompletionCost(optional):
object Cost
-
expenseCostPercentComplete(optional):
object Percent
-
expenseCostVariance(optional):
object Cost
-
laborCostPercentComplete(optional):
object Percent
-
laborCostVariance(optional):
object Cost
-
link(optional):
string(url)
Read Only:
true
-
materialCostPercentComplete(optional):
object Percent
-
materialCostVariance(optional):
object Cost
-
nonLaborCostPercentComplete(optional):
object Percent
-
nonLaborCostVariance(optional):
object Cost
-
plannedExpenseCost(optional):
object Cost
-
plannedLaborCost(optional):
object Cost
-
plannedMaterialCost(optional):
object Cost
-
plannedNonLaborCost(optional):
object Cost
-
plannedTotalCost(optional):
object Cost
-
plannedValueCost(optional):
object Cost
-
project(optional):
integer(int64)
The system-generated identifier of a project.
-
remainingExpenseCost(optional):
object Cost
-
remainingLaborCost(optional):
object Cost
-
remainingMaterialCost(optional):
object Cost
-
remainingNonLaborCost(optional):
object Cost
-
remainingTotalCost(optional):
object Cost
-
schedulePerformanceIndex(optional):
number(double)
The measure of work accomplished as a percentage of the work shceduled on a project.
-
scheduleVariance(optional):
object Cost
-
scheduleVarianceIndex(optional):
number(double)
The ratio of schedule variance and the work scheduled to be performed.
-
toCompletePerformanceIndex(optional):
number(double)
A measure of the value of the project work that is remaining.
-
totalCostVariance(optional):
object Cost
-
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. -
varCost(optional):
object Cost
-
wbsId(optional):
integer(int64)
The system-generated identifier of a WBS.
Nested Schema : activitySettings
Type:
array
Unique Items Required:
true
An object containing the settings applied to an activity.
Show Source
Nested Schema : activityUncertainties
Type:
array
Unique Items Required:
true
The uncertainties associated with an activity.
Show Source
Nested Schema : codeValuesActivity
Type:
array
Unique Items Required:
true
The categories applied to an activity.
Show Source
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with an activity.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with an activity.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with an activity.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : Cost
Type:
object
Nested Schema : ApiEntityActivitySetting
Type:
Show Source
object
-
activityId(optional):
integer(int64)
The unique identifier of an activity.
-
activitySettingId(optional):
integer(int64)
The unique identifier of an activity setting.
-
link(optional):
string(url)
Read Only:
true
-
settingName(optional):
string
The name of an activity setting.
-
settingValue(optional):
string
The value of an activity setting.
-
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 : ApiEntityActivityUncertainty
Type:
Show Source
object
-
activity(optional):
integer(int64)
The ID of the activity that the uncertainty object is linked to.
-
activityUncertaintyId(optional):
integer(int64)
The unique identifier of an uncertainty object.
-
distributionShape(optional):
string
Allowed Values:
[ "NONE", "TRIANGLE", "UNIFORM", "GAUSSIAN", "SINGLE_POINT" ]
The probability distribution that best models the three-point estimate durations. The valid values are Triangular and Uniform. -
existenceProbability(optional):
object Percent
-
link(optional):
string(url)
Read Only:
true
-
maximumRemainingDuration(optional):
object Duration
-
minimumRemainingDuration(optional):
object Duration
-
monteCarloScenario(optional):
string
Allowed Values:
[ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ]
The type of risk analysis run on the project. Pre-response: a quantitative risk analysis that doesn't take into account the impact of defined risk response plans. Post-response: A quantitative risk analysis that takes into account the impact of defined risk response plans. Pre- and Post-response: A quantitative risk analysis that uses both contexts. -
mostLikelyRemainingDuration(optional):
object Duration
-
project(optional):
integer(int64)
The ID of the project that the activity is in.
-
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 : ApiEntityCodeValueActivity
Type:
Show Source
object
-
activityId(optional):
integer(int64)
The unique identifier for the activity.
-
codeType(optional):
object ApiEntityCodeType
-
codeValue(optional):
object ApiEntityCodeValue
-
codeValueActivityId(optional):
integer(int64)
The unique identifier of an activity code value.
-
link(optional):
string(url)
Read Only:
true
-
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.
204 Response
Successful operation with no content.
404 Response
The requested activity does not exist, or you do not have access to it.