Recost Project for Manual Activity Sheet

Post /ws/rest/service/v2/activity/sheet/recost

Purpose

Recost Project for Manual/System Activity Sheet in a specified Unifier Shell based on project_number and activitysheetName provided in the payload for the API.

This POST service includes recosting of current manual or system activity sheet data.

Prerequisites

Ensure you have:

  • Created the Unifier shell
  • The required Activity Sheet Services permissions under Activity Manager
  • The manual/system activity sheet exists.

Request Format

Send an API request as a JSON Map with the following structure:

{

"options":{"project_number": "<value>",

"data":[{"activitySheetName" : "<value>"},

"activitySheetType": "<value>"

or

{"sourceProjectId" : "<value>",

"activitySheetType": "<value>",

"projectType": "<value>"

]}

Request Parameters - Options Map

Specify the following parameter in the Options JSON map:

Request Parameter Required? Data Type Description
project_number Yes String A valid 'Active' shell number where the baseline schedule is to be created for a manual activity sheet.

Request Parameters - Data Map

Specify the following parameters in Data []:

Request Parameter Required? Data Type Description
activitySheetType Yes String

Specify the activity sheet type. Valid values include: "system", "manual".

For Primavera Cloud integrations/P6, specify "system" to insert data into the System Activity Sheet.

activitySheetName Yes, if "activitySheetType" is "manual". String The name of the Manual Activity Sheet Name in the Activity Manager,
sourceProjectId Yes, if activitySheetType is "system". String Project added in integration tab in either from Gateway Sync or Primavera Cloud.
projectType No String

The type of activity sheet. Valid values include:

  • "Current" and "Manual" for system sheet.
  • ""Current" for manual sheet

Default is "Current".

Response Format

A JSON object is returned in the following format:

{

"data": [],

"message": [<list of messages>],

"status": <REST status code value>,

"rest_audit_id": <id from the audit table>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Sample Success Request

To recost a project, send a request in the following format:

{

"options": {

"project_number": "P-0056"

},

"data" :[{

"activitySheetName" : "ManualSheet01" ,

"activitySheetType" : "Manual"

}]

}

Sample Success Response

A successful response with status code 200 displays in the following format:

{

"data": [],

"message": [

{

"activity SheetName": "ManualSheet01",

"message" : "Rec ost job created Su ccessfully.",

"jo bId" : 1688113665288

}

],

"status": 202,

"rest_audit_id": 12676

}

Sample Request For System Sheet

Send a equest for a system sheet as shown below:

{

"options": {

"project_number": "P-0115"

},

"data" :[{

"a ctivity SheetType" : " system",

"projectType":"Current",

"sou rceProjectId":"ActivitySystem"

}]

}}

Sample Response

A response to the above request displays the corresponding status code in the following format:

{

"data": [],

"message": [

{

"jobId": 1717136939962,

"sourceProjectId": "ActivitySystem",

"message": "Recost job created Successfully."

}

],

" status": 202,

"rest_audit_id": 298 77

}

Supported Validation Messages and Status Codes

The following validation messages and status codes display in the response when incorrect values are provided in the request.

Field Name Use-case Scenario Status Code Error Message
project_number project_number is not specified. 12018 The API request is missing the required information: [project_number].
project_number project_number is invalid. 602 Project/Shell Number is not correct.
project_number project_number is inactive. 12020 The API request contains an invalid value: [project_number]. Check the status of this project_number in Unifier.
project_number project_number is empty/blank. 12128 The API request contains empty value for: [project_number].
activitySheetType activitySheetType value is not specified in the request. 12010 The API request is missing the required information: [activitySheetType]
activitySheetType activitySheetType is empty/blank. 12034 The API request contains an empty value for: [activitySheetType]. Allowed values: [manual, system]
activitySheetType activitySheetType is of incorrect data type. 12704 Invalid value was found in a field: [activitySheetType]. Allowed only alphanumeric value.
activitySheetType Accepting only "manual" or "system", else displaying validation message. 12011 Invalid value was found in a field: [activitySheetType]. Allowed values: [manual, system]
activitySheetName activitySheetName is not specified in the request. 12012 The API request is missing the required information: [activitySheetName].
activitySheetName activitySheetName does not exist. 12013 The API request contains an invalid value: [activitySheetName]. Please check if this activitySheetName with sheet type=manual has been configured in Unifier.
activitySheetName activitySheetName value is null or empty. 12068 The API request contains empty value for: [activitySheetName].
sourceProjectId sourceProjectId is not configured in the source Unifier shell. 12021 The API request contains an invalid value: [sourceProjectId]. Please check if this sourceProjectId has been configured in Unifier.
sourceProjectId sourceProjectId is not specified in the request. 12005 The API request is missing the required information: [sourceProjectId]
sourceProjectId sourceProjectId value is a blank. 12032 The API request contains empty value for: [sourceProjectId].
projectType projectType is empty/blank for system sheet. 12144 The API request contains empty value for: [projectType]. Allowed values: [Current, Baseline]
projectType projectType is empty/blank for manual sheet. 12144 The API request contains empty value for: [projectType]. Allowed values: [Current, Baseline]
projectType projectType is of incorrect data type. 12142 Invalid value was found in a field: [projectType]. Allowed only alphanumeric value.
projectType An invalid value is passed in projectType for system sheet. 12145 Invalid value was found in a field: 'projectType'. Allowed values: [Current, Baseline]
projectType An invalid value is passed in projectType for manual sheet. 12145 Invalid value was found in a field: 'projectType'. Allowed values: [Current, Baseline]
projectType When "baseline" is passed, it is not configured for system sheet. 12036 Invalid value was found in a field: [projectType]. Baseline not defined for this Project.