Batch Create Strategy Types
post
/api/restapi/strategyType/batch
Send a request to this endpoint to create one or more strategy types.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityStrategyTypeInput>
Type:
array
Title:
Show Source
List<ApiEntityStrategyTypeInput>
-
Array of:
object ApiEntityStrategyTypeInput
Title:
ApiEntityStrategyTypeInput
This entity represents a StrategyType object, a unique StrategyType object can be identified by the following combinations of the fields.- strategyTypeId
- levelName,workspaceId
- levelName,workspaceCode
Nested Schema : ApiEntityStrategyTypeInput
Type:
object
Title:
ApiEntityStrategyTypeInput
This entity represents a StrategyType object, a unique StrategyType object can be identified by the following combinations of the fields.
Show Source
- strategyTypeId
- levelName,workspaceId
- levelName,workspaceCode
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 23.12.The type of association in the relationship between the strategy type and the workspace. Possible values are Owned and Inherited. -
icon(required): string
Allowed Values:
[ "STRATEGY_ROOK", "STRATEGY_PAWN", "STRATEGY_KNIGHT", "STRATEGY_BISHOP", "STRATEGY_QUEEN", "STRATEGY_KING" ]
A graphical representation of a strategy type. -
levelName(required): string
Maximum Length:
255
The name of a strategy type. -
link: string(url)Read Only:true
Deprecated. As of 23.10.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)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The system-generated identifier of a workspace.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : List<ApiEntityStrategyType>
Type:
array
Title:
Show Source
List<ApiEntityStrategyType>
-
Array of:
object ApiEntityStrategyType
Title:
ApiEntityStrategyType
Nested 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.
400 Response
Invalid input for the Strategy Type service.