Jump to

• Request
• Response

Recalculate Workspace Cost Sheet

post

/api/restapi/cbs/recalculate/workspace/{workspaceId}

Send a request to this endpoint to recalculate workspace cost sheet for the given workspace ID.

Request

Path Parameters

• workspaceId(required): integer(int64)
  The system-generated identifier of a workspace.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityRecalculateWorkspaceCostSheetInput

Type: object

Title: ApiEntityRecalculateWorkspaceCostSheetInput

Show Source

• projectCostFieldTypes: array projectCostFieldTypes
  Cost types to include in project cost sheet recalculation. Required if project recalculate boolean flag is provided as true. 'FORMULA_CONFIGURED_FIELDS' type is deprecated and will be removed soon, to update formula configured fields, use the 'projectFormulaConfiguredFieldsRecalculate' boolean field.
  Allowed Values are: ACTUALS, BUDGET, COMMITMENTS, CONTRACTS, RISKS, SCOPE.
• projectFormulaConfiguredFieldsRecalculate: boolean
  Boolean flag to indicate whether Formula configured fields need to be updated based on existing project data. To ensure the latest project costs, recalculate the project costs before recalculating these fields.
• projectRecalculate: boolean
  Boolean flag to indicate whether all projects' cost fields based on the provided cost field types, need to be updated in the summary cost sheet.
• workspaceRecalculate: boolean
  Boolean flag to indicate whether workspace totals need to be updated based on current cost data from projects and child workspaces.

{
    "title":"ApiEntityRecalculateWorkspaceCostSheetInput",
    "type":"object",
    "properties":{
        "projectFormulaConfiguredFieldsRecalculate":{
            "type":"boolean",
            "description":"Boolean flag to indicate whether Formula configured fields need to be updated based on existing project data. To ensure the latest project costs, recalculate the project costs before recalculating these fields.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "projectCostFieldTypes":{
            "type":"array",
            "description":"Cost types to include in project cost sheet recalculation. Required if project recalculate boolean flag is provided as true. 'FORMULA_CONFIGURED_FIELDS' type is deprecated and will be removed soon, to update formula configured fields, use the 'projectFormulaConfiguredFieldsRecalculate' boolean field.<br />Allowed Values are: ACTUALS, BUDGET, COMMITMENTS, CONTRACTS, RISKS, SCOPE.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ],
                "enum":[
                    "ACTUALS",
                    "BUDGET",
                    "COMMITMENTS",
                    "CONTRACTS",
                    "RISKS",
                    "SCOPE",
                    "FORMULA_CONFIGURED_FIELDS"
                ]
            },
            "types":[
                "array"
            ]
        },
        "workspaceRecalculate":{
            "type":"boolean",
            "description":"Boolean flag to indicate whether workspace totals need to be updated based on current cost data from projects and child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "projectRecalculate":{
            "type":"boolean",
            "description":"Boolean flag to indicate whether all projects' cost fields based on the provided cost field types, need to be updated in the summary cost sheet.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectCostFieldTypes

Type: array

Cost types to include in project cost sheet recalculation. Required if project recalculate boolean flag is provided as true. 'FORMULA_CONFIGURED_FIELDS' type is deprecated and will be removed soon, to update formula configured fields, use the 'projectFormulaConfiguredFieldsRecalculate' boolean field.
Allowed Values are: ACTUALS, BUDGET, COMMITMENTS, CONTRACTS, RISKS, SCOPE.

Show Source

• Array of: string
  Allowed Values: [ "ACTUALS", "BUDGET", "COMMITMENTS", "CONTRACTS", "RISKS", "SCOPE", "FORMULA_CONFIGURED_FIELDS" ]

{
    "type":"array",
    "description":"Cost types to include in project cost sheet recalculation. Required if project recalculate boolean flag is provided as true. 'FORMULA_CONFIGURED_FIELDS' type is deprecated and will be removed soon, to update formula configured fields, use the 'projectFormulaConfiguredFieldsRecalculate' boolean field.<br />Allowed Values are: ACTUALS, BUDGET, COMMITMENTS, CONTRACTS, RISKS, SCOPE.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ],
        "enum":[
            "ACTUALS",
            "BUDGET",
            "COMMITMENTS",
            "CONTRACTS",
            "RISKS",
            "SCOPE",
            "FORMULA_CONFIGURED_FIELDS"
        ]
    },
    "types":[
        "array"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Successful operation

Body ()

Root Schema : ApiEntityScheduleJob

Type: object

Title: ApiEntityScheduleJob

Show Source

• jobId: integer (int64)
  The unique identifier for the background service.
• jobKey: integer (int64)
  The unique identifier for a job.
• jobStatus: string
  Allowed Values: [ "NOT_RAN_YET", "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

  The status of the background service.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityScheduleJob",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NOT_RAN_YET",
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobKey":{
            "type":"integer",
            "description":"The unique identifier for a job.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the CBS service. Verify the request contains valid data, then resubmit the request.

Back to Top