Create a Strategy
post
/api/restapi/strategy
Send a request to this endpoint to create a strategy.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityStrategyInput
Type:
object
Title:
ApiEntityStrategyInput
This entity represents a Strategy object, a unique Strategy object can be identified by the following combinations of the fields.
Show Source
- strategyId
- strategyName,workspaceId
- strategyName,workspaceCode
-
codeValuesStrategy: array
codeValuesStrategy
The list of code values for a strategy. This entity can only be used to assign codeValues or create codeValues on the fly.
-
configuredFields: array
configuredFields
The list of configured fields for a strategy.
-
description: string
Maximum Length:
4000
A detailed description of a strategy. -
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. -
ownerId(required): integer
(int64)
The system-generated identifier of the user responsible for executing the strategy.
-
parentStrategyId: integer
(int64)
The system-generated identifier of the parent strategy of the strategy.
-
securityGuid: stringRead Only:true
Maximum Length:32
Deprecated. As of 23.12.The globally unique identifier of the strategy. -
seqNum: integer
(int64)
The sequence number of the strategy.
-
status(required): string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
The status of the strategy. -
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
strategyName(required): string
Maximum Length:
255
The name of a strategy. -
strategyTypeId(required): integer
(int64)
The system-generated identifier of the level of the strategy.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated. -
weight: number
(double)
The relative weight of the sibling strategy node to indicate the contribution of a given node to its parent strategy node.
-
weightPct(required): number
(double)
The weight or relative rank of the strategy node compared to its siblings. The value indicates the percentage that the strategy node is contributing to the parent strategy. The weight percentage for all sibling strategy nodes totals 100.
-
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId(required): integer
(int64)
The system-generated identifier of a workspace.
Nested Schema : codeValuesStrategy
Type:
array
The list of code values for a strategy. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueStrategyInput
Title:
ApiEntityCodeValueStrategyInput
This entity represents a CodeValueStrategy object, a unique CodeValueStrategy object can be identified by the following combinations of the fields.- codeValueStrategyId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeValueId
- codeTypeCode,codeValueCode,parentId
- codeValueCode,codeTypeId,parentId
Nested Schema : configuredFields
Type:
array
The list of configured fields for a strategy.
Show Source
-
Array of:
object ApiEntityStrategyConfiguredFieldValueInput
Title:
ApiEntityStrategyConfiguredFieldValueInput
This entity represents a StrategyConfiguredFieldValue object, a unique StrategyConfiguredFieldValue object can be identified by the following combinations of the fields.- columnDefinitionId
- columnName
- columnLabel
Nested Schema : ApiEntityCodeValueStrategyInput
Type:
object
Title:
ApiEntityCodeValueStrategyInput
This entity represents a CodeValueStrategy object, a unique CodeValueStrategy object can be identified by the following combinations of the fields.
Show Source
- codeValueStrategyId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeValueId
- codeTypeCode,codeValueCode,parentId
- codeValueCode,codeTypeId,parentId
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: stringMinimum Length:0
Maximum Length:255
Deprecated. As of 23.11.The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
codeValueStrategyId: integer
(int64)
The system-generated identifier of a strategy.
-
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. -
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
sequenceNumber: integer(int32)Deprecated. As of 23.11.The number that specifies the position of the code value item within the code type list. -
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityStrategyConfiguredFieldValueInput
Type:
object
Title:
ApiEntityStrategyConfiguredFieldValueInput
This entity represents a StrategyConfiguredFieldValue object, a unique StrategyConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: numberRead Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record. -
costValueWorkspace1: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace3 currency conversion. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
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. -
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityStrategy
Type:
object
Title:
ApiEntityStrategy
This entity represents a Strategy object, a unique Strategy object can be identified by the following combinations of the fields.
Show Source
- strategyId
- strategyName,workspaceId
- strategyName,workspaceCode
-
codeValuesStrategy: array
codeValuesStrategy
The list of code values for a strategy. This entity can only be used to assign codeValues or create codeValues on the fly.
-
configuredFields: array
configuredFields
The list of configured fields for a strategy.
-
description: string
Maximum Length:
4000
A detailed description of a strategy. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
ownerId: integer
(int64)
The system-generated identifier of the user responsible for executing the strategy.
-
parentStrategyId: integer
(int64)
The system-generated identifier of the parent strategy of the strategy.
-
securityGuid: string
Maximum Length:
32
The globally unique identifier of the strategy. -
seqNum: integer
(int64)
The sequence number of the strategy.
-
status: string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
The status of the strategy. -
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
strategyName: string
Maximum Length:
255
The name of a strategy. -
strategyTypeId: integer
(int64)
The system-generated identifier of the level of the strategy.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
weight: number
(double)
The relative weight of the sibling strategy node to indicate the contribution of a given node to its parent strategy node.
-
weightPct: number
(double)
The weight or relative rank of the strategy node compared to its siblings. The value indicates the percentage that the strategy node is contributing to the parent strategy. The weight percentage for all sibling strategy nodes totals 100.
-
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The system-generated identifier of a workspace.
Nested Schema : codeValuesStrategy
Type:
array
The list of code values for a strategy. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueStrategy
Title:
ApiEntityCodeValueStrategy
Nested Schema : configuredFields
Type:
array
The list of configured fields for a strategy.
Show Source
-
Array of:
object ApiEntityStrategyConfiguredFieldValue
Title:
ApiEntityStrategyConfiguredFieldValue
Nested Schema : ApiEntityCodeValueStrategy
Type:
object
Title:
Show Source
ApiEntityCodeValueStrategy
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: string
Minimum Length:
0
Maximum Length:255
The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
codeValueStrategyId: integer
(int64)
The system-generated identifier of a strategy.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : ApiEntityStrategyConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityStrategyConfiguredFieldValue
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: number
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
strategyId: integer
(int64)
The system-generated identifier of the strategy.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
400 Response
Invalid input for the Strategy service.