View a Measure by Workspace and Name
get
/api/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.
- The object has a name that matches the value of the {measureName} path parameter.
Request
Path Parameters
-
measureName(required): string
The name of a measure.
-
workspaceId(required): integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityMeasure
Type:
object
Title:
Show Source
ApiEntityMeasure
-
actualAggregationType: 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: string
Maximum Length:
4000
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: string
Maximum Length:
4000
The expression that is defined to capture the actual value of a measure. -
actualType: string
Allowed Values:
[ "MANUAL", "FORMULA", "BUILTIN" ]
Determines whether the Actual value of the measure is manually entered or calculated using a formula. -
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the measure and the workspace. Possible values are Owned and Inherited. -
description: string
Maximum Length:
4000
The detailed summary providing additional information about the measure. -
enabledFlag: 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: string
Allowed Values:
[ "REPORTING_PERIOD", "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
The level of granularity for the measure. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
measureBasedFlag: boolean
Determines whether the expression for the measure is based on project attributes or on other measures.
-
measureDataType: 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. -
measureEntityType: string
Allowed Values:
[ "WORKSPACE", "PROJECT", "PROGRAM" ]
Determines the type of entity the values are created under.For example, for PROJECT as the measure entity type, measure will shown under projects' measures page. -
measureId: integer
(int64)
The unique identifier of a measure.
-
measureName: string
Maximum Length:
255
The name of the measure. -
measureSourceType: string
Allowed Values:
[ "ACTIVITY", "PROGRAM", "PROJECT", "RISK" ]
Determines the type of entity the values are aggregated from.For example, for Activity as the measure source type, measure will aggregate activities' data. -
periodId: integer
(int64)
The unique identifier of a default period.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
It describes 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: string
Allowed Values:
[ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ]
Determines the type of expression and provides the format for the selected type. -
targetBaseExpression: string
Maximum Length:
4000
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: string
Maximum Length:
4000
The expression that is defined to capture the target value of a measure. -
targetType: string
Allowed Values:
[ "MANUAL", "FORMULA", "BUILTIN" ]
Determines whether the Target value of the measure is manually entered or calculated using a formula. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
404 Response
The requested measure does not exist, or you do not have access to it.