Jump to

• Request
• Response

View a Project Measure Value

get

/api/restapi/projectMeasureValue/{projectMeasureValueId}

This endpoint returns a project measure value that meet the following requirements:

• The object has an ID that matches the value of the {projectMeasureValueId} path parameter.

Request

Path Parameters

• projectMeasureValueId(required): integer(int64)
  The system-generated identifier of a project measure value.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityProjectMeasureValue

Type: object

Title: ApiEntityProjectMeasureValue

Show Source

• actualBaseValue: number (double)
  The base actual value for the measure.
• actualDerivedValue: number (double)
  The actual value for the measure.
• actualExpressionValue: number (double)
  The actual expression value for the measure.
• lastCalculatedDate: string (date-time)
  The date on which the measure was last calculated.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• measureEntryType: string
  Allowed Values: [ "COMPUTE" ]

  The type of a measure entry.
• measureId: integer (int64)
  The unique identifier of a measure.
• projectId: integer (int64)
  The unique identifier of a project.
• projectMeasureValueId: integer (int64)
  The unique identifier of a project measure.
• targetBaseValue: number (double)
  The base target value for a measure.
• targetDerivedValue: number (double)
  The target value for the measure.
• targetExpressionValue: number (double)
  The target value for the measure.
• updateDate: string (date-time)
  Date when the record was last updated.
• varBaseValue: number (double)
  The variance for a measure base value associated with a portfolio.
• varDerivedValue: number (double)
  The variance for a measure value associated with a project. Calculated as actual value minus target value.
• varExpressionValue: number (double)
  The expression value for the measure.

{
    "title":"ApiEntityProjectMeasureValue",
    "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"
            ]
        },
        "targetDerivedValue":{
            "type":"number",
            "description":"The target value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier of a project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lastCalculatedDate":{
            "type":"string",
            "description":"The date on which the measure was last calculated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "varDerivedValue":{
            "type":"number",
            "description":"The variance for a measure value associated with a project. Calculated as actual value minus target value.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "varBaseValue":{
            "type":"number",
            "description":"The variance for a measure base value associated with a portfolio.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualDerivedValue":{
            "type":"number",
            "description":"The actual value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "varExpressionValue":{
            "type":"number",
            "description":"The expression value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "targetBaseValue":{
            "type":"number",
            "description":"The base target value for a measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "targetExpressionValue":{
            "type":"number",
            "description":"The target value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualBaseValue":{
            "type":"number",
            "description":"The base actual value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualExpressionValue":{
            "type":"number",
            "description":"The actual expression value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "measureEntryType":{
            "type":"string",
            "description":"The type of a measure entry.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "COMPUTE"
            ]
        },
        "projectMeasureValueId":{
            "type":"integer",
            "description":"The unique identifier of a project measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

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

Back to Top