View a Measure by Workspace and Name
get
/primeapi/restapi/measure/workspace/{workspaceId}/measureName/{measureName}
This endpoint returns measures that meet the following requirements:
- The object belongs to a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Request
Path Parameters
-
measureName: string
The name of a measure.
-
workspaceId: integer(int64)
The system-generated identifier of a workspace.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityMeasure
Type:
Show Source
object
-
actualAggregationType(optional):
string
Allowed Values:
[ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ]
Determines the type of aggregation to use in defining the expression. Valid values are Sum, Average, Max, Min, or Count. -
actualBaseExpression(optional):
string
The expression that calculates the base value for when the data type of a measure is set to Percentage.
For example, if a measure is calculating the percentage of projects in a portfolio where the schedule variance is less than 10, the Base Expression would calculate the number of projects in the portfolio. The Base Expression would be: count(object.Project_projectCode). -
actualExpression(optional):
string
The expression that is defined to capture the actual value of a measure.
-
actualType(optional):
string
Allowed Values:
[ "MANUAL", "FORMULA", "BUILTIN" ]
Determines whether the Actual value of the measure is manually entered or calculated using a formula. -
description(optional):
string
The detailed summary providing additional information about the measure.
-
enabledFlag(optional):
boolean
The state of the measure.
Enabled: The measure can be associated with portfolios for monitoring.
Disabled: This measure cannot be used for monitoring portfolios. -
granularity(optional):
string
Allowed Values:
[ "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
-
link(optional):
string(url)
Read Only:
true
-
measureBasedFlag(optional):
boolean
Determines whether the expression for the measure is based on project attributes or on other measures.
-
measureDataType(optional):
string
Allowed Values:
[ "PERCENTAGE", "COST", "BOOLEAN", "NUMBER" ]
Determines the type of data needed for the measure's value.
Valid values are: Number, Cost, and Percentage. -
measureId(optional):
integer(int64)
The unique identifier of a measure.
-
measureName(optional):
string
The name of the measure.
-
periodId(optional):
integer(int64)
The unique identifier of a default period.
-
pushDownType(optional):
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
How data is shared between parent and child workspaces.
Manual: Data can be pulled down by child workspaces. This is the default option.
Automatic: Data is automatically shared with all child workspaces. -
targetAggregationType(optional):
string
Allowed Values:
[ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ]
Determines the type of expression and provides the format for the selected type. -
targetBaseExpression(optional):
string
The expression that calculates the base value for when the data type of a measure is set to Percentage.
For example, if a measure is calculating the percentage of projects in a portfolio where the schedule variance is less than 10, the Base Expression would calculate the number of projects in the portfolio. The Base Expression would be: count(object.Project_projectCode). -
targetExpression(optional):
string
The expression that is defined to capture the target value of a measure.
-
targetType(optional):
string
Allowed Values:
[ "MANUAL", "FORMULA", "BUILTIN" ]
Determines whether the Target value of the measure is manually entered or calculated using a formula. -
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. -
workspaceId(optional):
integer(int64)
The unique identifier of a workspace.
404 Response
The requested measure does not exist, or you do not have access to it.