Oracle Prime Cloud Release 16

Returns activities specified by the assigned code value.

get

/primeapi/restapi/v16.2/activity/project/{id}/codeType/{typeId}/codeValue/{code}

Request

Path Parameters

code: Type: string

Required: true
id: Type: integer (int64)

Required: true
typeId: Type: integer (int64)

Required: true

Response

Supported Media Types

application/json

200 Response

successful operation

Body

Root Schema : ApiEntityActivity

Type: object

Properties

accountingVarianceLaborUnits: Type: object Unit
activityCode: Type: string

The project activity code assigned to the activity.
activityFinancial: Type: object ApiEntityActivityFinancial
activityId: Type: integer (int64)

The unique identifier for the activity.
activityName: Type: string

The name of the activity.
activityPercentComplete: Type: object Percent
activityPriority: Type: string

Allowed Values: [ "TOP", "HIGH", "NORMAL", "LOW", "LOWEST" ]

Determines the priority of the activity when performing role leveling.
activityStatus: Type: string

Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED" ]

Determines the status of the activity. Valid values are Not Started, In Progress, and Completed.
activityType: Type: string

Allowed Values: [ "ACTIVITY", "RESOURCE_DEPENDENT", "LEVEL_OF_EFFORT", "START_MILESTONE", "FINISH_MILESTONE", "SUMMARY" ]

The type of activity. Valid values are Task Dependent, Resource Dependent, Level of Effort, Start Milestone, and Finish Milestone.
activityUncertainties: Type: array activityUncertainties

Unique Items Required: true

Lists the uncertainty distributions for the activity.
actualDuration: Type: object Duration
actualFinish: Type: string (date-time)

The date when the activity was completed.
actualLaborUnits: Type: object Unit
actualNonLaborUnits: Type: object Unit
actualStart: Type: string (date-time)

The date work on the activity began.
actualThisPeriodLaborUnits: Type: object Unit
actualThisPeriodNonLaborUnits: Type: object Unit
atCompletionBudgetLaborUnits: Type: object Unit
atCompletionDuration: Type: object Duration
atCompletionLaborUnits: Type: object Unit
atCompletionNonLaborUnits: Type: object Unit
baselineDuration: Type: object Duration
baselineFinishDate: Type: string (date-time)
baselinePlannedLaborUnits: Type: object Unit
baselinePlannedNonLaborUnits: Type: object Unit
baselineStartDate: Type: string (date-time)
calendar: Type: integer (int64)

The calendar assigned to the activity.
calendarName: Type: string

The name of the calendar.
codeValuesActivity: Type: array codeValuesActivity

Unique Items Required: true

Lists all activity code types assigned to the activity with its corresponding value.
completedWeight: Type: number (double)
constraintDate: Type: string (date-time)

The constraint date for the activity, if the activity has a constraint.
constraintType: Type: 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: Type: boolean

Default Value: false

Designates an activity as critical. An activity is defined as critical based upon the project settings configured for the project.
drivingPath: Type: boolean

Default Value: false

The sequence of project activities from start to finish where the Total Duration is longer than any other path.
durationPercentComplete: Type: object Percent
durationPercentOfPlanned: Type: object Percent
durationType: Type: 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: Type: 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: Type: 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: Type: object Unit
estimateAtCompletionLaborUnits: Type: object Unit
estimateToCompletionLaborUnits: Type: object Unit
expectedFinish: Type: string (date-time)

The date you expect work on the activity to finish.
finishDate: Type: string (date-time)

The current finish date for the activity.
floatPath: Type: integer (int64)
floatPathOrder: Type: integer (int64)
freeFloat: Type: object Duration
laborUnitsCompletePercent: Type: object Percent
lateFinish: Type: 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: Type: 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.
location: Type: integer (int64)
name: Type: string

The name of the activity.
nonLaborUnitsCompletePercent: Type: object Percent
owner: Type: string

The user responsible for the activity.
parentActivity: Type: integer (int64)

The ID of the higher-level activity that contains the activity.
percentCompleteType: Type: 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: Type: 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: Type: object Percent
physicalPercentComplete: Type: object Percent
plannedDuration: Type: object Duration
plannedFinish: Type: 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: Type: object Unit
plannedNonLaborUnits: Type: object Unit
plannedStart: Type: 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: Type: object Unit
primaryResource: Type: integer (int64)

The user designated as the primary resource for the activity.
projectId: Type: integer (int64)

The unique identifier of the project to which the activity was added.
recordCount: Type: integer (int32)

The number of activities added to the project.
remainingDuration: Type: object Duration
remainingFinish: Type: 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: Type: object Duration
remainingLaborUnits: Type: object Unit
remainingLateFinish: Type: 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: Type: 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: Type: object Unit
remainingStart: Type: 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: Type: string (date-time)

The date when a suspended task or activity is resumed.
schedulePercentComplete: Type: object Percent
schedulePerfIndexLaborUnits: Type: object Unit
scheduleVarianceLaborUnits: Type: object Unit
scheduleVarIndexLaborUnits: Type: object Unit
scopePercentComplete: Type: object Percent
secondaryConstraintDate: Type: string (date-time)

The date for the activity's secondary constraint, if the activity has a secondary constraint.
secondaryConstraintType: Type: 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: Type: integer (int32)

The number that specifies the position of the activity relative to others within the view.
starred: Type: boolean

Default Value: false
startDate: Type: 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: Type: string (date-time)

The date work has temporarily stopped on a given activity.
totalFloat: Type: object Duration
unitsPercentComplete: Type: object Percent
varDuration: Type: object Percent
varFinishDate: Type: object Duration
varianceAtCompletionLaborUnits: Type: object Unit
varLaborUnits: Type: object Unit
varNonLaborUnits: Type: object Unit
varStartDate: Type: object Duration
wbsId: Type: integer (int64)

The WBS that the activity is associated with.
weight: Type: number (double)

The importance of the activity in relation to other activities.
workPackageId: Type: integer (int64)

The unique identifier for the work package that the activity is associated with.

Nested Schema : Unit

Type: object

Nested Schema : ApiEntityActivityFinancial

Type: object

Properties

accountingVariance: Type: object Cost
activity: Type: integer (int64)

The unique identifier of the activity.
activityId: Type: integer (int64)
actualExpenseCost: Type: object Cost
actualLaborCost: Type: object Cost
actualMaterialCost: Type: object Cost
actualNonLaborCost: Type: object Cost
actualThisPeriodLaborCost: Type: object Cost
actualThisPeriodMaterialCost: Type: object Cost
actualThisPeriodNonLaborCost: Type: object Cost
actualTotalCost: Type: object Cost
atCompletionExpenseCost: Type: object Cost
atCompletionLaborCost: Type: object Cost
atCompletionMaterialCost: Type: object Cost
atCompletionNonLaborCost: Type: object Cost
atCompletionTotalCost: Type: object Cost
atCompletionVariance: Type: object Cost
blplannedExpenseCost: Type: object Cost
blplannedLaborCost: Type: object Cost
blplannedMaterialCost: Type: object Cost
blplannedNonLaborCost: Type: object Cost
blplannedTotalCost: Type: object Cost
budgetAtCompletion: Type: object Cost
costVarianceIndex: Type: number (double)
costVarianceLaborUnits: Type: object Unit
costVarianceLaborUnitsIndex: Type: number (double)
earnedValueCost: Type: object Cost
earnedValueLaborUnits: Type: object Unit
estimateAtCompletionCost: Type: object Cost
estimateToCompletionCost: Type: object Cost
expenseCostPercentComplete: Type: object Percent
expenseCostVariance: Type: object Cost
laborCostPercentComplete: Type: object Percent
laborCostVariance: Type: object Cost
materialCostPercentComplete: Type: object Percent
materialCostVariance: Type: object Cost
nonLaborCostPercentComplete: Type: object Percent
nonLaborCostVariance: Type: object Cost
plannedExpenseCost: Type: object Cost
plannedLaborCost: Type: object Cost
plannedMaterialCost: Type: object Cost
plannedNonLaborCost: Type: object Cost
plannedTotalCost: Type: object Cost
plannedValueCost: Type: object Cost
project: Type: integer (int64)
remainingExpenseCost: Type: object Cost
remainingLaborCost: Type: object Cost
remainingMaterialCost: Type: object Cost
remainingNonLaborCost: Type: object Cost
remainingTotalCost: Type: object Cost
schedulePerformanceIndex: Type: number (double)
scheduleVariance: Type: object Cost
scheduleVarianceIndex: Type: number (double)
toCompletePerformanceIndex: Type: number (double)
totalCostVariance: Type: object Cost
varCost: Type: object Cost
wbsId: Type: integer (int64)

Nested Schema : Percent

Type: object

Properties

bigDecimal: Type: number
double: Type: number (double)

Nested Schema : activityUncertainties

Type: array

Unique Items Required: true

Lists the uncertainty distributions for the activity.

Items

Type: object ApiEntityActivityUncertainty

Nested Schema : Duration

Type: object

Properties

bigDecimal: Type: number
double: Type: number (double)

Nested Schema : codeValuesActivity

Type: array

Unique Items Required: true

Lists all activity code types assigned to the activity with its corresponding value.

Items

Type: object ApiEntityCodeValueActivity

Nested Schema : Cost

Type: object

Nested Schema : ApiEntityActivityUncertainty

Type: object

Properties

activity: Type: integer (int64)

The ID of the activity that the uncertainty object is linked to.
activityUncertaintyId: Type: integer (int64)

The database generated unique value for the an uncertainty object.
distributionShape: Type: 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: Type: object Percent
maximumRemainingDuration: Type: object Duration
minimumRemainingDuration: Type: object Duration
monteCarloScenario: Type: string

Allowed Values: [ "PRE_MITIGATED", "POST_MITIGATED", "BOTH" ]

The Risk Analysis scenario.
mostLikelyRemainingDuration: Type: object Duration
project: Type: integer (int64)

The ID of the project that the activity is in.

Nested Schema : ApiEntityCodeValueActivity

Type: object

Properties

activityId: Type: integer (int64)
codeType: Type: object ApiEntityCodeType
codeValue: Type: object ApiEntityCodeValue
codeValueActivityId: Type: integer (int64)

KEY

Nested Schema : ApiEntityCodeType

Type: object

Properties

assignments: Type: array assignments

Unique Items Required: true
codeTypeCode: Type: string

Allowed Values: [ "Length[1-40]" ]

This field displays the name of a code or value.
codeTypeId: Type: integer (int64)
codeTypeName: Type: string

Allowed Values: [ "Length[1-40]" ]

STRING
workspace: Type: integer (int64)

The ID of the owning workspace.

Nested Schema : ApiEntityCodeValue

Type: object

Properties

codeTypeId: Type: integer (int64)

The ID for the code type.
codeValueCode: Type: string

Allowed Values: [ "LENGTH[1-32]" ]

The unique identifier for the code value.
codeValueId: Type: integer (int64)

The unique identifier for the code value.
codeValueName: Type: string

Allowed Values: [ "LENGTH[1-100]" ]

The name of the code value.
parentCodeValue: Type: integer (int64)

The parent code value.
sequenceNumber: Type: integer (int32)

The number that specifies the position of the code value item within the code type list.

Nested Schema : assignments

Type: array

Unique Items Required: true

Items

Type: object ApiEntityCodeEntityType

Nested Schema : ApiEntityCodeEntityType

Type: object

Properties

codeType: Type: object ApiEntityCodeType
entityType: Type: string

Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "PROJECT_FUND", "WORKSPACE_FUND" ]
primaryKey: Type: integer (int64)