Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : ApiEntityCombinedAssignUnassignRequest

Type: object

Title: ApiEntityCombinedAssignUnassignRequest

Show Source

• baselineCategories: array baselineCategories
  The list of baseline category assign, promote, and unassign requests to workspaces.
• calendars: array calendars
  The list of workspace calendar assign, promote, and unassign requests to workspaces.
• codeTypes: array codeTypes
  The list of code type assign, promote, and unassign requests to workspaces.
• costCategories: array costCategories
  The list of cost category assign, promote, and unassign requests to workspaces.
• currencies: array currencies
  The list of currency assign, promote, and unassign requests to workspaces.
• curves: array curves
  The list of curve assign, promote, and unassign requests to workspaces.
• locations: array locations
  The list of location assign, promote, and unassign requests to workspaces.
• measures: array measures
  The list of measure assign, promote, and unassign requests to workspaces.
• reasons: array reasons
  The list of reason assign, promote, and unassign requests to workspaces.
• reportCycles: array reportCycles
  The list of report cycle assign, promote, and unassign requests to workspaces.
• riskMatrices: array riskMatrices
  The list of risk matrix category assign, promote, and unassign requests to workspaces.
• riskScoreTypes: array riskScoreTypes
  The list of workspace risk score type assign, promote, and unassign requests to workspaces.
• ruleOfCredits: array ruleOfCredits
  The list of rule of credit assign, promote, and unassign requests to workspaces.
• strategyTypes: array strategyTypes
  The list of strategy type assign, promote, and unassign requests to workspaces.
• unitsOfMeasures: array unitsOfMeasures
  The list of unit of measure assign, promote, and unassign requests to workspaces.

{
    "title":"ApiEntityCombinedAssignUnassignRequest",
    "type":"object",
    "properties":{
        "riskScoreTypes":{
            "type":"array",
            "description":"The list of workspace risk score type assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "riskMatrices":{
            "type":"array",
            "description":"The list of risk matrix category assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRiskMatrixIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "calendars":{
            "type":"array",
            "description":"The list of workspace calendar assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCalendarAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "currencies":{
            "type":"array",
            "description":"The list of currency assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCurrencyIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "locations":{
            "type":"array",
            "description":"The list of location assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestLocationIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "curves":{
            "type":"array",
            "description":"The list of curve assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCurveIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "unitsOfMeasures":{
            "type":"array",
            "description":"The list of unit of measure assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeTypes":{
            "type":"array",
            "description":"The list of code type assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCodeTypeIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "costCategories":{
            "type":"array",
            "description":"The list of cost category assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCostCategoryIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "measures":{
            "type":"array",
            "description":"The list of measure assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestMeasureIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "baselineCategories":{
            "type":"array",
            "description":"The list of baseline category assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestBaselineCategoryIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "reportCycles":{
            "type":"array",
            "description":"The list of report cycle assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestReportCycleIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "reasons":{
            "type":"array",
            "description":"The list of reason assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestReasonIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "ruleOfCredits":{
            "type":"array",
            "description":"The list of rule of credit assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRuleOfCreditIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "strategyTypes":{
            "type":"array",
            "description":"The list of strategy type assign, promote, and unassign requests to workspaces. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestStrategyTypeIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : baselineCategories

Type: array

The list of baseline category assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestBaselineCategoryIdentifier
  Title: ApiEntityAssignUnassignRequestBaselineCategoryIdentifier

{
    "type":"array",
    "description":"The list of baseline category assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestBaselineCategoryIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : calendars

Type: array

The list of workspace calendar assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityCalendarAssignUnassignRequest
  Title: ApiEntityCalendarAssignUnassignRequest

{
    "type":"array",
    "description":"The list of workspace calendar assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCalendarAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : codeTypes

Type: array

The list of code type assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestCodeTypeIdentifier
  Title: ApiEntityAssignUnassignRequestCodeTypeIdentifier

{
    "type":"array",
    "description":"The list of code type assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCodeTypeIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : costCategories

Type: array

The list of cost category assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestCostCategoryIdentifier
  Title: ApiEntityAssignUnassignRequestCostCategoryIdentifier

{
    "type":"array",
    "description":"The list of cost category assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCostCategoryIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : currencies

Type: array

The list of currency assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestCurrencyIdentifier
  Title: ApiEntityAssignUnassignRequestCurrencyIdentifier

{
    "type":"array",
    "description":"The list of currency assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCurrencyIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : curves

Type: array

The list of curve assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestCurveIdentifier
  Title: ApiEntityAssignUnassignRequestCurveIdentifier

{
    "type":"array",
    "description":"The list of curve assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestCurveIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : locations

Type: array

The list of location assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestLocationIdentifier
  Title: ApiEntityAssignUnassignRequestLocationIdentifier

{
    "type":"array",
    "description":"The list of location assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestLocationIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : measures

Type: array

The list of measure assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestMeasureIdentifier
  Title: ApiEntityAssignUnassignRequestMeasureIdentifier

{
    "type":"array",
    "description":"The list of measure assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestMeasureIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : reasons

Type: array

The list of reason assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestReasonIdentifier
  Title: ApiEntityAssignUnassignRequestReasonIdentifier

{
    "type":"array",
    "description":"The list of reason assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestReasonIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : reportCycles

Type: array

The list of report cycle assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestReportCycleIdentifier
  Title: ApiEntityAssignUnassignRequestReportCycleIdentifier

{
    "type":"array",
    "description":"The list of report cycle assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestReportCycleIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : riskMatrices

Type: array

The list of risk matrix category assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestRiskMatrixIdentifier
  Title: ApiEntityAssignUnassignRequestRiskMatrixIdentifier

{
    "type":"array",
    "description":"The list of risk matrix category assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRiskMatrixIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : riskScoreTypes

Type: array

The list of workspace risk score type assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier
  Title: ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier

{
    "type":"array",
    "description":"The list of workspace risk score type assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ruleOfCredits

Type: array

The list of rule of credit assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestRuleOfCreditIdentifier
  Title: ApiEntityAssignUnassignRequestRuleOfCreditIdentifier

{
    "type":"array",
    "description":"The list of rule of credit assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestRuleOfCreditIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : strategyTypes

Type: array

The list of strategy type assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestStrategyTypeIdentifier
  Title: ApiEntityAssignUnassignRequestStrategyTypeIdentifier

{
    "type":"array",
    "description":"The list of strategy type assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestStrategyTypeIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : unitsOfMeasures

Type: array

The list of unit of measure assign, promote, and unassign requests to workspaces.

Show Source

• Array of: object ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier
  Title: ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier

{
    "type":"array",
    "description":"The list of unit of measure assign, promote, and unassign requests to workspaces. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityAssignUnassignRequestBaselineCategoryIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestBaselineCategoryIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestBaselineCategoryIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/BaselineCategoryIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object BaselineCategoryIdentifier
  Title: BaselineCategoryIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/BaselineCategoryIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : BaselineCategoryIdentifier

Type: object

Title: BaselineCategoryIdentifier

Show Source

• baselineCategoryId: integer (int64)
  The system-generated unique identifier of a baseline category.
• baselineCategoryName: string
  Maximum Length: 255

  The name of the baseline category.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"BaselineCategoryIdentifier",
    "type":"object",
    "properties":{
        "baselineCategoryId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a baseline category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "baselineCategoryName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the baseline category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityWorkspaceAssignUnassignRequest

Type: object

Title: ApiEntityWorkspaceAssignUnassignRequest

Show Source

• action: string
  Allowed Values: [ "ASSIGN", "UNASSIGN", "UPDATE" ]

  This field represents the assign or unassign action in the request.
• workspaceCode(required): string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityWorkspaceAssignUnassignRequest",
    "required":[
        "workspaceCode"
    ],
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"This field represents the assign or unassign action in the request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ASSIGN",
                "UNASSIGN",
                "UPDATE"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCalendarAssignUnassignRequest

Type: object

Title: ApiEntityCalendarAssignUnassignRequest

Show Source

• 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.

{
    "title":"ApiEntityCalendarAssignUnassignRequest",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"The list of workspaces the object is inherited to.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCalendarWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/CalendarIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object CalendarIdentifier
  Title: CalendarIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/CalendarIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

The list of workspaces the object is inherited to.

Show Source

• Array of: object ApiEntityCalendarWorkspaceAssignUnassignRequest
  Title: ApiEntityCalendarWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"The list of workspaces the object is inherited to.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCalendarWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : CalendarIdentifier

Type: object

Title: CalendarIdentifier

Show Source

• calendarCode: string
  Maximum Length: 255

  The unique code for the calendar.
• calendarId: integer (int64)
  The unique identifier for the calendar.
• projectCode: string
  Maximum Length: 60

  The 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.

{
    "title":"CalendarIdentifier",
    "type":"object",
    "properties":{
        "calendarId":{
            "type":"integer",
            "description":"The unique identifier for the calendar.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "calendarCode":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique code for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCalendarWorkspaceAssignUnassignRequest

Type: object

Title: ApiEntityCalendarWorkspaceAssignUnassignRequest

Show Source

• 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: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityCalendarWorkspaceAssignUnassignRequest",
    "required":[
        "workspaceCode"
    ],
    "type":"object",
    "properties":{
        "isAssignableToResource":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a resource.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "isAssignableToProject":{
            "type":"boolean",
            "description":"Indicates whether or not the calendar can be assigned to a project.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "action":{
            "type":"string",
            "description":"This field represents the assign or unassign action in the request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ASSIGN",
                "UNASSIGN",
                "UPDATE"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestCodeTypeIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestCodeTypeIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestCodeTypeIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeTypeIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object CodeTypeIdentifier
  Title: CodeTypeIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeTypeIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : CodeTypeIdentifier

Type: object

Title: CodeTypeIdentifier

Show Source

• 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: 60

  The 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.

{
    "title":"CodeTypeIdentifier",
    "type":"object",
    "properties":{
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestCostCategoryIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestCostCategoryIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestCostCategoryIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/CostCategoryIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object CostCategoryIdentifier
  Title: CostCategoryIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/CostCategoryIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : CostCategoryIdentifier

Type: object

Title: CostCategoryIdentifier

Show Source

• abbreviation: string
  Minimum Length: 1

  Maximum Length: 10

  The abbreviation for the cost category name.
• costCategoryId: integer (int64)
  The system-generated identifier of a cost category.
• costCategoryName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the cost category.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CostCategoryIdentifier",
    "type":"object",
    "properties":{
        "costCategoryId":{
            "type":"integer",
            "description":"The system-generated identifier of a cost category.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costCategoryName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the cost category.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "abbreviation":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string",
            "description":"The abbreviation for the cost category name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestCurrencyIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestCurrencyIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestCurrencyIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/CurrencyIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object CurrencyIdentifier
  Title: CurrencyIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/CurrencyIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : CurrencyIdentifier

Type: object

Title: CurrencyIdentifier

Show Source

• currencyCode: string
  Minimum Length: 1

  Maximum Length: 3

  The 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.

{
    "title":"CurrencyIdentifier",
    "type":"object",
    "properties":{
        "currencyCode":{
            "maxLength":"3",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the currency. The currency code is 3 characters.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The unique identifier of a currency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestCurveIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestCurveIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestCurveIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/CurveIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object CurveIdentifier
  Title: CurveIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/CurveIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : CurveIdentifier

Type: object

Title: CurveIdentifier

Show Source

• curveId: integer (int64)
  The unique identifier of a curve.
• curveName: string
  Maximum Length: 255

  The name of the curve profile.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CurveIdentifier",
    "type":"object",
    "properties":{
        "curveId":{
            "type":"integer",
            "description":"The unique identifier of a curve.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "curveName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the curve profile.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestLocationIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestLocationIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestLocationIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/LocationIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object LocationIdentifier
  Title: LocationIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/LocationIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : LocationIdentifier

Type: object

Title: LocationIdentifier

Show Source

• locationCode: string
  Minimum Length: 1

  Maximum Length: 60

  The 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.

{
    "title":"LocationIdentifier",
    "type":"object",
    "properties":{
        "locationId":{
            "type":"integer",
            "description":"The unique identifier for the location.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "locationCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestMeasureIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestMeasureIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestMeasureIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/MeasureIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object MeasureIdentifier
  Title: MeasureIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/MeasureIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : MeasureIdentifier

Type: object

Title: MeasureIdentifier

Show Source

• measureId: integer (int64)
  The unique identifier of a measure.
• measureName: string
  Maximum Length: 255

  The name of the measure.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"MeasureIdentifier",
    "type":"object",
    "properties":{
        "measureId":{
            "type":"integer",
            "description":"The unique identifier of a measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "measureName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the measure.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestReasonIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestReasonIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestReasonIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ReasonIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object ReasonIdentifier
  Title: ReasonIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ReasonIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ReasonIdentifier

Type: object

Title: ReasonIdentifier

Show Source

• reasonId: integer (int64)
  The unique identifier of a reason.
• reasonName: string
  Maximum Length: 255

  The 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.

{
    "title":"ReasonIdentifier",
    "type":"object",
    "properties":{
        "reasonId":{
            "type":"integer",
            "description":"The unique identifier of a reason.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reasonName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the reason for recommitting to a task.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestReportCycleIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestReportCycleIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestReportCycleIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ReportCycleIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object ReportCycleIdentifier
  Title: ReportCycleIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ReportCycleIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ReportCycleIdentifier

Type: object

Title: ReportCycleIdentifier

Show Source

• cycleName: string
  Maximum Length: 255

  The 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.

{
    "title":"ReportCycleIdentifier",
    "type":"object",
    "properties":{
        "cycleName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the reporting cycle.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reportCycleId":{
            "type":"integer",
            "description":"The unique identifier of a report cycle.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestRiskMatrixIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestRiskMatrixIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestRiskMatrixIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/RiskMatrixIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object RiskMatrixIdentifier
  Title: RiskMatrixIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/RiskMatrixIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : RiskMatrixIdentifier

Type: object

Title: RiskMatrixIdentifier

Show Source

• matrixName: string
  Maximum Length: 60

  The name of the risk scoring matrix.
• programCode: string
  Maximum Length: 60

  The 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: 60

  The 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.

{
    "title":"RiskMatrixIdentifier",
    "type":"object",
    "properties":{
        "riskMatrixId":{
            "type":"integer",
            "description":"The system-generated identifier of the risk matrix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "matrixName":{
            "maxLength":"60",
            "type":"string",
            "description":"The name of the risk scoring matrix.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestRiskScoreTypeIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/RiskScoreTypeIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object RiskScoreTypeIdentifier
  Title: RiskScoreTypeIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/RiskScoreTypeIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : RiskScoreTypeIdentifier

Type: object

Title: RiskScoreTypeIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The 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: 60

  The 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: 255

  The name of the risk score type.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RiskScoreTypeIdentifier",
    "type":"object",
    "properties":{
        "riskScoreTypeId":{
            "type":"integer",
            "description":"The unique identifier of a score type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "riskScoreTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the risk score type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestRuleOfCreditIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestRuleOfCreditIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestRuleOfCreditIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/RuleOfCreditIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object RuleOfCreditIdentifier
  Title: RuleOfCreditIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/RuleOfCreditIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : RuleOfCreditIdentifier

Type: object

Title: RuleOfCreditIdentifier

Show Source

• rocId: integer (int64)
  Unique identifier of the rule of credit.
• rocName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the rule of credit.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"RuleOfCreditIdentifier",
    "type":"object",
    "properties":{
        "rocId":{
            "type":"integer",
            "description":"Unique identifier of the rule of credit.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rocName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the rule of credit.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestStrategyTypeIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestStrategyTypeIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestStrategyTypeIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/StrategyTypeIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object StrategyTypeIdentifier
  Title: StrategyTypeIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/StrategyTypeIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : StrategyTypeIdentifier

Type: object

Title: StrategyTypeIdentifier

Show Source

• 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.

{
    "title":"StrategyTypeIdentifier",
    "type":"object",
    "properties":{
        "levelName":{
            "type":"string",
            "description":"The name of a strategy.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "strategyTypeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier

Type: object

Title: ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier

Show Source

• 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.

{
    "title":"ApiEntityAssignUnassignRequestUnitsOfMeasureIdentifier",
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the assign or unassign action of the object to the workspace.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "objectIdentifier":{
            "description":"This is a generic field that represents the fields that uniquely identify an object.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/UnitsOfMeasureIdentifier"
                }
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : objectIdentifier

This is a generic field that represents the fields that uniquely identify an object.

Match All

Show Source

• object UnitsOfMeasureIdentifier
  Title: UnitsOfMeasureIdentifier

{
    "description":"This is a generic field that represents the fields that uniquely identify an object.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/UnitsOfMeasureIdentifier"
        }
    ]
}

Nested Schema : workspaces

Type: array

This field represents the assign or unassign action of the object to the workspace.

Show Source

• Array of: object ApiEntityWorkspaceAssignUnassignRequest
  Title: ApiEntityWorkspaceAssignUnassignRequest

{
    "type":"array",
    "description":"This field represents the assign or unassign action of the object to the workspace.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityWorkspaceAssignUnassignRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : UnitsOfMeasureIdentifier

Type: object

Title: UnitsOfMeasureIdentifier

Show Source

• key: string
  Maximum Length: 60

  The 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.

{
    "title":"UnitsOfMeasureIdentifier",
    "type":"object",
    "properties":{
        "key":{
            "maxLength":"60",
            "type":"string",
            "description":"The abbreviation for the unit of measure name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the unit of measure.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Promote a Calendar to Parent Workspace

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.

Back to Top