View a Strategy Type
get
/api/restapi/strategyType/{strategyTypeId}
This endpoint returns strategy types that meet the following requirements:
- The object has an ID that matches the value of the {strategyTypeId} path parameter.
Request
Path Parameters
-
strategyTypeId(required): integer(int64)
The system-generated identifier of a strategy type.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityStrategyType
Type:
object
Title:
Show Source
ApiEntityStrategyType
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the strategy type and the workspace. Possible values are Owned and Inherited. -
icon: string
Allowed Values:
[ "STRATEGY_ROOK", "STRATEGY_PAWN", "STRATEGY_KNIGHT", "STRATEGY_BISHOP", "STRATEGY_QUEEN", "STRATEGY_KING" ]
A graphical representation of a strategy type. -
levelName: string
Maximum Length:
255
The name of a strategy type. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pushDownType: string
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. -
strategyTypeId: integer
(int64)
The system-generated identifier of a strategy type. This value should not be provided in create operation request data, however, it is required for update requests.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The system-generated identifier of a workspace.
404 Response
The Strategy Type does not exist, or you do not have access to it.