View all Strategies Measure Values by Workspace
get
/api/restapi/strategy/measureValue/workspace/{workspaceId}
This endpoint returns strategies that meet the following requirements:
- The object is associated with a workspace with an ID value that matches the value of the {workspaceId} path parameter.
Request
Path Parameters
-
workspaceId(required): integer(int64)
The system-generated identifier of a workspace.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityStrategyMeasureResponse>
Type:
arrayTitle:
Show Source
List<ApiEntityStrategyMeasureResponse>-
Array of:
object ApiEntityStrategyMeasureResponse
Title:
ApiEntityStrategyMeasureResponse
Nested Schema : ApiEntityStrategyMeasureResponse
Type:
objectTitle:
Show Source
ApiEntityStrategyMeasureResponse-
measureValues: array
measureValues
The value of a measure.
-
strategy:
strategy
A strategy object.
Nested Schema : measureValues
Type:
arrayThe value of a measure.
Show Source
-
Array of:
object ApiEntityStrategyMeasureValue
Title:
ApiEntityStrategyMeasureValueThis entity represents a StrategyMeasureValue object, a unique StrategyMeasureValue object can be identified by the following combinations of the fields.- strategyMeasureValueId
Nested Schema : strategy
A strategy object.
Match All
A strategy object.
Show Source
-
object
ApiEntityStrategy
Title:
ApiEntityStrategyThis entity represents a Strategy object, a unique Strategy object can be identified by the following combinations of the fields.- strategyId
- strategyName,workspaceId
- strategyName,workspaceCode
Nested Schema : ApiEntityStrategyMeasureValue
Type:
objectTitle:
ApiEntityStrategyMeasureValueThis entity represents a StrategyMeasureValue object, a unique StrategyMeasureValue object can be identified by the following combinations of the fields.
Show Source
- strategyMeasureValueId
-
actualBaseValue: number
(double)
The actual base value.
-
actualDerivedValue: number
(double)
The actual value for the measure.
If the measure is set manually, the current period's actual value displays. -
actualExprValue: number
(double)
The actual value of an expression.
-
entryType: string
Allowed Values:
[ "COMPUTE" ]The type of the strategy entry. -
lastCalcDate: string
(date-time)
The date on which the value was last calculated.
-
link: string
(url)
Read Only:
trueThe self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
measureId: integer
(int64)
The system-generated identifier of a measure.
-
strategyId: integer
(int64)
The system-generated identifier of a strategy.
-
strategyMeasureValueId: integer
(int64)
The system-generated identifier of a strategy.
-
targetBaseValue: number
(double)
The target base value.
-
targetDerivedValue: number
(double)
The target value for the measure.
If the measure is set manually, the current period's target value displays. -
targetExpressionValue: number
(double)
The target value of an expression.
-
updateDate: string
(date-time)
Read Only:
trueDate when the record was last updated. -
varBaseValue: number
(double)
The variance of a base value.
-
varDerivedValue: number
(double)
The variance of a derived value.
-
varExprValue: number
(double)
The variance of an expression value.
Nested Schema : ApiEntityStrategy
Type:
objectTitle:
ApiEntityStrategyThis 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:
4000A 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:
32The 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:
255The 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:
60The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The system-generated identifier of a workspace.
Nested Schema : codeValuesStrategy
Type:
arrayThe 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:
arrayThe list of configured fields for a strategy.
Show Source
-
Array of:
object ApiEntityStrategyConfiguredFieldValue
Title:
ApiEntityStrategyConfiguredFieldValue
Nested Schema : ApiEntityCodeValueStrategy
Type:
objectTitle:
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:
0Maximum Length:60This 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:
0Maximum Length:255The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1Maximum Length:60The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1Maximum Length:255The 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:
1Maximum Length:60The 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:
objectTitle:
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:
1Maximum Length:100The user-specified UDF column label. -
columnName: string
Minimum Length:
1Maximum Length:100The 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:
4000This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
204 Response
Successful operation with no content.
404 Response
The requested strategy does not exist, or you do not have access to it.