Jump to

• Request
• Response

View all Program Measure Values by Program

get

/api/restapi/programMeasureValue/program/{programId}

Send a request to this endpoint to view program measure values for the specified programId.

Request

Path Parameters

• programId(required): integer(int64)
  The system-generated identifier of a program;

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityProgramMeasureValue>

Type: array

Title: List<ApiEntityProgramMeasureValue>

Show Source

• Array of: object ApiEntityProgramMeasureValue
  Title: ApiEntityProgramMeasureValue

{
    "title":"List<ApiEntityProgramMeasureValue>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProgramMeasureValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityProgramMeasureValue

Type: object

Title: ApiEntityProgramMeasureValue

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.
• measureEntryType: string
  Allowed Values: [ "COMPUTE" ]

  The type of a measure entry.
• measureId: integer (int64)
  The unique identifier of a measure.
• programId: integer (int64)
  The system-generated identifier of a program.
• programMeasureValueId: integer (int64)
  The unique identifier of a program 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.

{
    "title":"ApiEntityProgramMeasureValue",
    "type":"object",
    "properties":{
        "targetDerivedValue":{
            "type":"number",
            "description":"The target value for the measure.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "programMeasureValueId":{
            "type":"integer",
            "description":"The unique identifier of a program measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The system-generated identifier of a program.",
            "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"
            ]
        },
        "actualDerivedValue":{
            "type":"number",
            "description":"The actual 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"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top