Jump to

• Request
• Response

View all Strategy Measures by Parent

get

/api/restapi/strategyMeasure/parentCode

Send a request to this endpoint to view all strategy measures under parent with codes matching the code fields in query parameters.

Request

Query Parameters

• measureName(required): string
  The name of a measure.
  This is a required field.
• workspaceCode(required): string
  The user-specified identifier of a workspace.
  This is a required field.

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<ApiEntityStrategyMeasure>

Type: array

Title: List<ApiEntityStrategyMeasure>

Show Source

• Array of: object ApiEntityStrategyMeasure
  Title: ApiEntityStrategyMeasure

  This entity represents a StrategyMeasure object, a unique StrategyMeasure object can be identified by the following combinations of the fields.

  • strategyMeasureId

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

Nested Schema : ApiEntityStrategyMeasure

Type: object

Title: ApiEntityStrategyMeasure

This entity represents a StrategyMeasure object, a unique StrategyMeasure object can be identified by the following combinations of the fields.

• strategyMeasureId

Show Source

• enabledFlag: boolean
  Indicates whether the strategy measure is enabled.
• lastCalculatedDate: string (date-time)
  The date on which the strategy measure was last calculated.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• measureId(required): integer (int64)
  The system-generated identifier of a measure.
• strategyId(required): integer (int64)
  The system-generated identifier of a strategy.
• strategyMeasureId: integer (int64)
  The system-generated identifier of a strategy measure.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityStrategyMeasure",
    "required":[
        "measureId",
        "strategyId"
    ],
    "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",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategyId":{
            "type":"integer",
            "description":"The system-generated identifier of a strategy.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "enabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the strategy measure is enabled.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "measureId":{
            "type":"integer",
            "description":"The system-generated identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "lastCalculatedDate":{
            "type":"string",
            "description":"The date on which the strategy measure was last calculated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategyMeasureId":{
            "type":"integer",
            "description":"The system-generated identifier of a strategy measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a StrategyMeasure object, a unique StrategyMeasure object can be identified by the following combinations of the fields.<ul><li>strategyMeasureId</li>",
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top