Batch Update Strategies
put
/primeapi/restapi/strategy/batch
Send a request to this endpoint to update one or more strategy configured fields.
Request
Supported Media Types
- application/json
One or more strategy objects.
Nested Schema : ApiEntityStrategy
Type:
Show Source
object
-
codeValuesStrategy(optional):
array codeValuesStrategy
Unique Items Required:
true
One or more strategy code values. -
description(optional):
string
A detailed description of a strategy.
-
link(optional):
string(url)
Read Only:
true
-
ownerId(optional):
integer(int64)
The system-generated identifier of the user responsible for executing the strategy.
-
parentStrategyId(optional):
integer(int64)
The system-generated identifier of the parent strategy of the strategy.
-
securityGuid(optional):
string
The globally unique identifier of the strategy.
-
seqNum(optional):
integer(int64)
The sequence number of the strategy.
-
status:
string
Allowed Values:
[ "ACTIVE", "INACTIVE" ]
The status of the strategy. -
strategyConfiguredFields(optional):
object ApiEntityStrategyConfiguredFields
-
strategyId(optional):
integer(int64)
The system-generated identifier of the strategy.
-
strategyName:
string
The name of a strategy.
-
strategyTypeId:
integer(int64)
The system-generated identifier of the level of the strategy.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
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.
-
workspaceId:
integer(int64)
The system-generated identifier of a workspace.
Nested Schema : codeValuesStrategy
Type:
array
Unique Items Required:
true
One or more strategy code values.
Show Source
Nested Schema : ApiEntityStrategyConfiguredFields
Type:
Show Source
object
-
costFlexMap(optional):
object costFlexMap
Additional Properties Allowed: additionalPropertiesThe cost fields associated with a project.
-
link(optional):
string(url)
Read Only:
true
-
otherFlexMap(optional):
object otherFlexMap
Additional Properties Allowed: additionalPropertiesThe non-cost and non-text fields associated with a project.
-
strategy(optional):
object ApiEntityStrategy
-
strategyId(optional):
integer(int64)
-
textFlexMap(optional):
object textFlexMap
Additional Properties Allowed: additionalPropertiesThe text fields associated with a project.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCodeValueStrategy
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueStrategyId(optional):
integer(int64)
The system-generated identfier of a strategy.
-
link(optional):
string(url)
Read Only:
true
-
strategyId:
integer(int64)
The system-generated identifier of the strategy.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : costFlexMap
Type:
object
Additional Properties Allowed
Show Source
The cost fields associated with a project.
Nested Schema : otherFlexMap
Type:
object
Additional Properties Allowed
Show Source
The non-cost and non-text fields associated with a project.
Nested Schema : textFlexMap
Type:
object
Additional Properties Allowed
Show Source
The text fields associated with a project.
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Nested Schema : additionalProperties
Type:
object
Response
Supported Media Types
- application/json
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://:/primeapi/restapi/
400 Response
Invalid input for the Strategy service.