Jump to

• Request
• Response

View a Measure

get

/api/restapi/measure/{measureId}

This endpoint returns a measure. that meet the following requirements:

• The object is associated with a measure with an ID value that matches the value of the {measureId} path parameter.

Request

Path Parameters

• measureId(required): integer(int64)
  ID of the Measure to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityMeasure

Type: object

Title: ApiEntityMeasure

Show Source

• 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.

{
    "title":"ApiEntityMeasure",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "description":{
            "maxLength":"4000",
            "type":"string",
            "description":"The detailed summary providing additional information about the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "granularity":{
            "type":"string",
            "description":"The level of granularity for the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "REPORTING_PERIOD",
                "YEARLY",
                "QUARTERLY",
                "MONTHLY",
                "SEMIMONTHLY",
                "WEEKLY",
                "DAILY"
            ]
        },
        "actualType":{
            "type":"string",
            "description":"Determines whether the Actual value of the measure is manually entered or calculated using a formula.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "FORMULA",
                "BUILTIN"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetType":{
            "type":"string",
            "description":"Determines whether the Target value of the measure is manually entered or calculated using a formula.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "FORMULA",
                "BUILTIN"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"It describes how data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the measure and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "enabledFlag":{
            "type":"boolean",
            "description":"The state of the measure. <br />Enabled: The measure can be associated with portfolios for monitoring. <br />Disabled: This measure cannot be used for monitoring portfolios.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "targetExpression":{
            "maxLength":"4000",
            "type":"string",
            "description":"The expression that is defined to capture the target value of a measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureDataType":{
            "type":"string",
            "description":"Determines the type of data needed for the measure's value. <br />Valid values are: Number, Cost, and Percentage.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PERCENTAGE",
                "COST",
                "BOOLEAN",
                "NUMBER"
            ]
        },
        "actualBaseExpression":{
            "maxLength":"4000",
            "type":"string",
            "description":"The expression that calculates the base value for when the data type of a measure is set to Percentage. <br />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).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetAggregationType":{
            "type":"string",
            "description":"Determines the type of expression and provides the format for the selected type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SUM",
                "MIN",
                "MAX",
                "COUNT",
                "AVERAGE",
                "PERCENT",
                "NONE"
            ]
        },
        "measureBasedFlag":{
            "type":"boolean",
            "description":"Determines whether the expression for the measure is based on project attributes or on other measures.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "periodId":{
            "type":"integer",
            "description":"The unique identifier of a default period.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "targetBaseExpression":{
            "maxLength":"4000",
            "type":"string",
            "description":"The expression that calculates the base value for when the data type of a measure is set to Percentage. <br />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).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualExpression":{
            "maxLength":"4000",
            "type":"string",
            "description":"The expression that is defined to capture the actual value of a measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "actualAggregationType":{
            "type":"string",
            "description":"Determines the type of aggregation to use in defining the expression. Valid values are <b>Sum</b>, <b>Average</b>, <b>Max</b>, <b>Min</b>, or <b>Count</b>.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SUM",
                "MIN",
                "MAX",
                "COUNT",
                "AVERAGE",
                "PERCENT",
                "NONE"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "measureSourceType":{
            "type":"string",
            "description":"Determines the type of entity the values are aggregated from.For example, for Activity as the measure source type, measure will aggregate activities' data.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY",
                "PROGRAM",
                "PROJECT",
                "RISK"
            ]
        },
        "measureEntityType":{
            "type":"string",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "WORKSPACE",
                "PROJECT",
                "PROGRAM"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested measure does not exist, or you do not have access to it.

Back to Top