Jump to

• Request
• Response

View a Strategy Measure Value Trend

get

/api/restapi/strategyMeasureValue/strategyMeasureSpread/measure/{measureId}/strategy/{strategyId}

This endpoint returns strategy measure trends that meet the following requirements:

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

Request

Path Parameters

• measureId(required): integer(int64)
  The system-generated identifier of a measure.
• strategyId(required): integer(int64)
  The system-generated identifier of a strategy.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityMeasureSpreadItem

Type: object

Title: ApiEntityMeasureSpreadItem

Show Source

• end: string (date-time)
  The end date time for the last strategy measure's actual/target value present in the system.
• masterId: integer (int64)
  The strategy measure ID for the spread of measure data to be retrieved.
• periods: array periods
  A list of all the measure spread periods that exist based on the default tracking frequency and the start and end of strategy measure values present in the system.
• start: string (date-time)
  The start date time for the earliest strategy measure's actual/target value present in the system.

{
    "title":"ApiEntityMeasureSpreadItem",
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "description":"The start date time for the earliest strategy measure's actual/target value present in the system.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "end":{
            "type":"string",
            "description":"The end date time for the last strategy measure's actual/target value present in the system.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "periods":{
            "type":"array",
            "description":"A list of all the measure spread periods that exist based on the default tracking frequency and the start and end of strategy measure values present in the system.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityMeasureSpreadPeriod",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "masterId":{
            "type":"integer",
            "description":"The strategy measure ID for the spread of measure data to be retrieved.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : periods

Type: array

A list of all the measure spread periods that exist based on the default tracking frequency and the start and end of strategy measure values present in the system.

Show Source

• Array of: object ApiEntityMeasureSpreadPeriod
  Title: ApiEntityMeasureSpreadPeriod

{
    "type":"array",
    "description":"A list of all the measure spread periods that exist based on the default tracking frequency and the start and end of strategy measure values present in the system.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityMeasureSpreadPeriod",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityMeasureSpreadPeriod

Type: object

Title: ApiEntityMeasureSpreadPeriod

Show Source

• actualExpressionValue: number (double)
  This actual value of the strategy measure for the particular start and end value.
• bucketId: string (date-time)
  Bucket ID indicates the start date time for the strategy measure value.
• end: string (date-time)
  The end date time for the strategy measure value.
• start: string (date-time)
  The start date time for the strategy measure value.
• statusIndicatorColor: string
  The color for the status indicator icon based on the thresholds configured for the measure.
  The field is non-persistable and thus maximum length is not applicable.
• statusIndicatorIcon: string
  The status indicator icon based on the thresholds configured for the measure.
  The field is non-persistable and thus maximum length is not applicable.
• targetExpressionValue: number (double)
  The target value of the strategy measure for the particular start and end value.

{
    "title":"ApiEntityMeasureSpreadPeriod",
    "type":"object",
    "properties":{
        "start":{
            "type":"string",
            "description":"The start date time for the strategy measure value.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "end":{
            "type":"string",
            "description":"The end date time for the strategy measure value.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "targetExpressionValue":{
            "type":"number",
            "description":"The target value of the strategy measure for the particular start and end value.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "actualExpressionValue":{
            "type":"number",
            "description":"This actual value of the strategy measure for the particular start and end value.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "bucketId":{
            "type":"string",
            "description":"Bucket ID indicates the start date time for the strategy measure value.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusIndicatorColor":{
            "type":"string",
            "description":"The color for the status indicator icon based on the thresholds configured for the measure.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusIndicatorIcon":{
            "type":"string",
            "description":"The status indicator icon based on the thresholds configured for the measure.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top