Batch Update Measures

put

/primeapi/restapi/measure/batch

Send a request to this endpoint to update one or more measures. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.

Request

Supported Media Types
Body ()
Measure objects to be updated.
Root Schema : List<ApiEntityMeasure>
Type: array
Title: List<ApiEntityMeasure>
Show Source
Nested Schema : ApiEntityMeasure
Type: object
Show Source
  • 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.
  • 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).
  • The expression that is defined to capture the actual value of a measure.
  • Allowed Values: [ "MANUAL", "FORMULA", "BUILTIN" ]
    Determines whether the Actual value of the measure is manually entered or calculated using a formula.
  • The detailed summary providing additional information about the measure.
  • The state of the measure.
    Enabled: The measure can be associated with portfolios for monitoring.
    Disabled: This measure cannot be used for monitoring portfolios.
  • Allowed Values: [ "YEARLY", "QUARTERLY", "MONTHLY", "SEMIMONTHLY", "WEEKLY", "DAILY" ]
  • Determines whether the expression for the measure is based on project attributes or on other measures.
  • Allowed Values: [ "PERCENTAGE", "COST", "BOOLEAN", "NUMBER" ]
    Determines the type of data needed for the measure's value.
    Valid values are: Number, Cost, and Percentage.
  • The unique identifier of a measure.
  • The name of the measure.
  • The unique identifier of a default period.
  • 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.
  • Allowed Values: [ "SUM", "MIN", "MAX", "COUNT", "AVERAGE", "PERCENT", "NONE" ]
    Determines the type of expression and provides the format for the selected type.
  • 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).
  • The expression that is defined to capture the target value of a measure.
  • Allowed Values: [ "MANUAL", "FORMULA", "BUILTIN" ]
    Determines whether the Target value of the measure is manually entered or calculated using a formula.
  • 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.
  • The unique identifier of a workspace.

Response

Supported Media Types

200 Response

A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://:/primeapi/restapi//1","2":"https://:/primeapi/restapi//2"}}

400 Response

Invalid input for a baseline measure.