Manage the Shared Data of Dictionary Objects
post
/api/restapi/dictionary/manageSharedData
Send a request to the endpoint to assign, unassign, and promote the various dictionary objects to different workspaces. This endpoint will work only for managing the shared data of records that are owned by workspace.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : ApiEntityAssignUnassignRequestBaselineCategoryIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestBaselineCategoryIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
BaselineCategoryIdentifier
Title:
BaselineCategoryIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : BaselineCategoryIdentifier
Type:
objectTitle:
Show Source
BaselineCategoryIdentifier-
baselineCategoryId: integer
(int64)
The system-generated unique identifier of a baseline category.
-
baselineCategoryName: string
Maximum Length:
255The name of the baseline category. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityWorkspaceAssignUnassignRequest
Type:
objectTitle:
Show Source
ApiEntityWorkspaceAssignUnassignRequest-
action: string
Allowed Values:
[ "ASSIGN", "UNASSIGN", "UPDATE" ]This field represents the assign or unassign action in the request. -
workspaceCode(required): string
Maximum Length:
60The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityCalendarAssignUnassignRequest
Type:
objectTitle:
Show Source
ApiEntityCalendarAssignUnassignRequest-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
The list of workspaces the object is inherited to.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
CalendarIdentifier
Title:
CalendarIdentifier
Nested Schema : workspaces
Type:
arrayThe list of workspaces the object is inherited to.
Show Source
-
Array of:
object ApiEntityCalendarWorkspaceAssignUnassignRequest
Title:
ApiEntityCalendarWorkspaceAssignUnassignRequest
Nested Schema : CalendarIdentifier
Type:
objectTitle:
Show Source
CalendarIdentifier-
calendarCode: string
Maximum Length:
255The unique code for the calendar. -
calendarId: integer
(int64)
The unique identifier for the calendar.
-
projectCode: string
Maximum Length:
60The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityCalendarWorkspaceAssignUnassignRequest
Type:
objectTitle:
Show Source
ApiEntityCalendarWorkspaceAssignUnassignRequest-
action: string
Allowed Values:
[ "ASSIGN", "UNASSIGN", "UPDATE" ]This field represents the assign or unassign action in the request. -
isAssignableToProject: boolean
Indicates whether or not the calendar can be assigned to a project.
-
isAssignableToResource: boolean
Indicates whether or not the calendar can be assigned to a resource.
-
workspaceCode(required): string
Maximum Length:
60The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestCodeTypeIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestCodeTypeIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
CodeTypeIdentifier
Title:
CodeTypeIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : CodeTypeIdentifier
Type:
objectTitle:
Show Source
CodeTypeIdentifier-
codeTypeCode: string
Displays the code or ID of the Code Type.
-
codeTypeId: integer
(int64)
The system-generated identifier of a code type.
-
projectCode: string
Maximum Length:
60The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestCostCategoryIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestCostCategoryIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
CostCategoryIdentifier
Title:
CostCategoryIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : CostCategoryIdentifier
Type:
objectTitle:
Show Source
CostCategoryIdentifier-
abbreviation: string
Minimum Length:
1Maximum Length:10The abbreviation for the cost category name. -
costCategoryId: integer
(int64)
The system-generated identifier of a cost category.
-
costCategoryName: string
Minimum Length:
1Maximum Length:255The name of the cost category. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestCurrencyIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestCurrencyIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
CurrencyIdentifier
Title:
CurrencyIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : CurrencyIdentifier
Type:
objectTitle:
Show Source
CurrencyIdentifier-
currencyCode: string
Minimum Length:
1Maximum Length:3The unique identifier for the currency. The currency code is 3 characters. -
currencyId: integer
(int64)
The unique identifier of a currency.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestCurveIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestCurveIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
CurveIdentifier
Title:
CurveIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : CurveIdentifier
Type:
objectTitle:
Show Source
CurveIdentifier-
curveId: integer
(int64)
The unique identifier of a curve.
-
curveName: string
Maximum Length:
255The name of the curve profile. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestLocationIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestLocationIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
LocationIdentifier
Title:
LocationIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : LocationIdentifier
Type:
objectTitle:
Show Source
LocationIdentifier-
locationCode: string
Minimum Length:
1Maximum Length:60The user-specified unique identifier of the location. -
locationId: integer
(int64)
The unique identifier for the location.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestMeasureIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestMeasureIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
MeasureIdentifier
Title:
MeasureIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : MeasureIdentifier
Type:
objectTitle:
Show Source
MeasureIdentifier-
measureId: integer
(int64)
The unique identifier of a measure.
-
measureName: string
Maximum Length:
255The name of the measure. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestReasonIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestReasonIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
ReasonIdentifier
Title:
ReasonIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : ReasonIdentifier
Type:
objectTitle:
Show Source
ReasonIdentifier-
reasonId: integer
(int64)
The unique identifier of a reason.
-
reasonName: string
Maximum Length:
255The name of the reason for recommitting to a task. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestReportCycleIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestReportCycleIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
ReportCycleIdentifier
Title:
ReportCycleIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : ReportCycleIdentifier
Type:
objectTitle:
Show Source
ReportCycleIdentifier-
cycleName: string
Maximum Length:
255The name of the reporting cycle. -
reportCycleId: integer
(int64)
The unique identifier of a report cycle.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestRiskMatrixIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestRiskMatrixIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
RiskMatrixIdentifier
Title:
RiskMatrixIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : RiskMatrixIdentifier
Type:
objectTitle:
Show Source
RiskMatrixIdentifier-
matrixName: string
Maximum Length:
60The name of the risk scoring matrix. -
programCode: string
Maximum Length:
60The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
projectCode: string
Maximum Length:
60The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
riskMatrixId: integer
(int64)
The system-generated identifier of the risk matrix.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
RiskScoreTypeIdentifier
Title:
RiskScoreTypeIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : RiskScoreTypeIdentifier
Type:
objectTitle:
Show Source
RiskScoreTypeIdentifier-
programCode: string
Maximum Length:
60The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
The unique identifier for the program.
-
projectCode: string
Maximum Length:
60The unique identifier for a project set by the user who created the project. -
projectId: integer
(int64)
The unique identifier for the project.
-
riskScoreTypeId: integer
(int64)
The unique identifier of a score type.
-
riskScoreTypeName: string
Maximum Length:
255The name of the risk score type. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestRuleOfCreditIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestRuleOfCreditIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
RuleOfCreditIdentifier
Title:
RuleOfCreditIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : RuleOfCreditIdentifier
Type:
objectTitle:
Show Source
RuleOfCreditIdentifier-
rocId: integer
(int64)
Unique identifier of the rule of credit.
-
rocName: string
Minimum Length:
1Maximum Length:255The name of the rule of credit. -
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestStrategyTypeIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestStrategyTypeIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
StrategyTypeIdentifier
Title:
StrategyTypeIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : StrategyTypeIdentifier
Type:
objectTitle:
Show Source
StrategyTypeIdentifier-
levelName: string
The name of a strategy.
-
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.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier
Type:
objectTitle:
Show Source
ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier-
objectIdentifier:
objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
-
workspaces: array
workspaces
This field represents the assign or unassign action of the object to the workspace.
Nested Schema : objectIdentifier
This is a generic field that represents the fields that uniquely identify an object.
Match All
This is a generic field that represents the fields that uniquely identify an object.
Show Source
-
object
UnitsOfMeasureIdentifier
Title:
UnitsOfMeasureIdentifier
Nested Schema : workspaces
Type:
arrayThis field represents the assign or unassign action of the object to the workspace.
Show Source
-
Array of:
object ApiEntityWorkspaceAssignUnassignRequest
Title:
ApiEntityWorkspaceAssignUnassignRequest
Nested Schema : UnitsOfMeasureIdentifier
Type:
objectTitle:
Show Source
UnitsOfMeasureIdentifier-
key: string
Maximum Length:
60The abbreviation for the unit of measure name. -
unitOfMeasureId: integer
(int64)
The unique identifier for the unit of measure.
-
workspaceCode: string
The user-specified identifier of a workspace.
-
workspaceId: integer
(int64)
The unique identifier of a workspace.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
The requested curve does not exist, or you do not have access to it.