Create or Update Assignment Spreads

POST /ws/rest/service/v2/activity/sheets/assignments/spread

Purpose:

Create or update Assignment Spreads in a specific shell from the source system.

Permissions:

The user must have Create permissions enabled. Selecting or clearing Update permissions has no impact on a user’s ability to utilize this REST Service.

Prerequisites:

This REST Service is specific to updating externally synced Assignment Spread data from other applications. Therefore, sourceProjectID should be configured or added in the user interface tab Shell Details → Primavera Cloud Integration.

Sample Spread JSON Format:

{

"project": {

"baselineId": 182202,

"baselineName": "B3",

"isBaseline": true,

"projectCode": "AOPC",

"projectId": 310301,

"projectName": "AOPC"

},

"resourceAssignments": [

{

"activityCode": "A11",

"activityId": 246001,

"activityName": "Act1",

"actualCost": 0,

"actualCostProject": 0,

"actualUnits": 0,

"assignmentCode": "AA0",

"assignmentId": 100001,

"atCompletionCost": 0,

"atCompletionCostProject": 0,

"atCompletionUnits": 40,

"plannedCost": 0,

"plannedCostProject": 0,

"plannedUnits": 40,

"rateSource": "RESOURCE",

"remainingCost": 0,

"remainingCostProject": 0,

"remainingUnits": 40,

"resourceCode": "R19",

"resourceId": 56101,

"resourceName": "R1",

"spread": {

"actualCost": [

0,

0

],

"actualCostProject": [

0,

0

],

"actualUnits": [

0,

0

],

"atCompletionCost": [

0,

0

],

"atCompletionCostProject": [

0,

0

],

"atCompletionUnits": [

8,

0,

8,

8

],

"plannedCost": [

0,

0

],

"plannedCostProject": [

0,

0

],

"plannedUnits": [

8,

0,

8,

8

],

"remainingCost": [

0,

0

],

"remainingCostProject": [

0,

0

],

"remainingUnits": [

8,

0,

8,

8

],

"spreadDates": [

"2023-06-09T00:00:00",

"2023-06-10T00:00:00",

"2023-06-11T00:00:00",

"2023-06-12T00:00:00",

"2023-06-13T00:00:00",

"2023-06-14T00:00:00",

"2023-06-15T00:00:00"

]

}

},

{

"activityCode": "A22",

"activityId": 246002,

"activityName": "Act2",

"actualCost": 0,

"actualCostProject": 0,

"actualUnits": 0,

"assignmentCode": "AA1",

"assignmentId": 100002,

"atCompletionCost": 0,

"atCompletionCostProject": 0,

"atCompletionUnits": 40,

"plannedCost": 0,

"plannedCostProject": 0,

"plannedUnits": 40,

"rateSource": "RESOURCE",

"remainingCost": 0,

"remainingCostProject": 0,

"remainingUnits": 40,

"resourceCode": "R20",

"resourceId": 56201,

"resourceName": "R2",

"spread": {

"actualCost": [

0,

0

],

"actualCostProject": [

0,

0

],

"actualUnits": [

0,

0

],

"atCompletionCost": [

0,

0

],

"atCompletionCostProject": [

0,

0

],

"atCompletionUnits": [

8,

0,

8,

8

],

"plannedCost": [

0,

0

],

"plannedCostProject": [

0,

0

],

"plannedUnits": [

8,

0,

8,

8

],

"remainingCost": [

0,

0

],

"remainingCostProject": [

0,

0

],

"remainingUnits": [

8,

0,

8,

8

],

"spreadDates": [

"2023-06-09T00:00:00",

"2023-06-10T00:00:00",

"2023-06-11T00:00:00",

"2023-06-12T00:00:00",

"2023-06-13T00:00:00",

"2023-06-14T00:00:00",

"2023-06-15T00:00:00"

]

}

},

{

"activityCode": "A33",

"activityId": 246003,

"activityName": "Act3",

"actualCost": 0,

"actualCostProject": 0,

"actualUnits": 0,

"assignmentCode": "AA2",

"assignmentId": 100003,

"atCompletionCost": 0,

"atCompletionCostProject": 0,

"atCompletionUnits": 40,

"plannedCost": 0,

"plannedCostProject": 0,

"plannedUnits": 40,

"rateSource": "RESOURCE",

"remainingCost": 0,

"remainingCostProject": 0,

"remainingUnits": 40,

"resourceCode": "R21",

"resourceId": 56202,

"resourceName": "R3",

"spread": {

"actualCost": [

0,

0

],

"actualCostProject": [

0,

0

],

"actualUnits": [

0,

0

],

"atCompletionCost": [

0,

0

],

"atCompletionCostProject": [

0,

0

],

"atCompletionUnits": [

8,

0,

8,

8

],

"plannedCost": [

0,

0

],

"plannedCostProject": [

0,

0

],

"plannedUnits": [

8,

0,

8,

8

],

"remainingCost": [

0,

0

],

"remainingCostProject": [

0,

0

],

"remainingUnits": [

8,

0,

8,

8

],

"spreadDates": [

"2023-06-09T00:00:00",

"2023-06-10T00:00:00",

"2023-06-11T00:00:00",

"2023-06-12T00:00:00",

"2023-06-13T00:00:00",

"2023-06-14T00:00:00",

"2023-06-15T00:00:00"

]

}

],

"timescale": "daily"

}

Sample Request (Success Scenario):

{hosturl}/ws/rest/service/v2/activity/sheets/assignments/spread

Inputs in JSON Raw-data:

{

"options": {

"project_number": "P-0056",

"sourceProjectId": "P-0056",

"source": "Primavera Cloud",

"projectType": "Current"

},

"_attachment": {

"zipped_file_name": "AssignmentSpread.zip",

"zipped_file_size": 780,

"zipped_file_content": "UEsDBBQAAAAIAKuD7VYD1rN9XAIAAI8fAAAVAAAAQXNzaWdubWVudFNwcmVhZC5qc29u7Zhda9swFIbvB/sPQdcp6CMNSe/SrBeDbSnpejV2odkiaNhysJRBGfnvkxVbcmzP6soam6IQiO33yOe1zpH1kN/v300mYJ9nP1mkwM3EnOsrP6hkCRfsY6wvogXGEE8b0heaMi2CWwIqicvbk1gIKj8wI7gE6yw2Q1ab+zVoaCYTQZBA1FB0IjeqkI4mAORMZoc8Yisp+U6kTCipw76ZwdWD6DAaKf6LqyebHCGdu6ma9Hg2hzp9S7QOItUYe6DJOpPFzMGu6/fmCTrlR8GVbAj2QazXFQRd+qksEJ671cPSfcIUz0Rlqlt11nqCKoOzmr5PqBAsLu/eFtyNu/Wue+ZUsYeikOaJt1nCQE1kKeWCi51N2ZZc0r9FtNO67qmmWjfXcgnaupnq6zmCqKXZJbCtd4Xc54zG1VpqtUTZotVH+32FM3fy3QntxhyBGVOaQW3UWn7w+tS8jKVKNUudtVo8O8Xi+WdNM+dvkaHLVNoYSYVKN4MXx75thy6PNTKSAlk/g5fotDV90BtuywbQhEeu4PwKLr9CeGO+YNoZgaA3AnkjsDeCeCNm3ohrF1GbkurweDo4Tr3IiHEvMuJeZMQXRkbkQUb81pDx7mHzuF3fDYWNi0UnNjq1BxxxAMcXmgngWBx7V+ooLA2+8QVwDODon5AAjgEc/zM4EtILjqQXHMmFwRF7wJG8NXDcfLoQNGaJBcbPVNAdA2di9Sejbr/z60UzuEFFNQIvvtBM4MXi2LtAR2Fp8P0u8GLgRf+EBF4MvPhPvKh/ynkCiqdMRjQx23tMefKkBx7/AFBLAQI/ABQAAAAIAKuD7VYD1rN9XAIAAI8fAAAVACQAAAAAAAAAIAAAAAAAAABBc3NpZ25tZW50U3ByZWFkLmpzb24KACAAAAAAAAEAGAB4ZYwTebXZAQAAAAAAAAAAAAAAAAAAAABQSwUGAAAAAAEAAQBnAAAAjwIAAAAA"

}

Sample Response (Success Scenario):

{

"data": {

"jobId": 1689307060653

},

"message": [

"Job for spread data created successfully."

],

"status": 202,

"rest_audit_id": 14317

}

Sample Request (Failed Scenario):

{hosturl}ws/rest/service/v2/activity/sheets/assignments/spread

Inputs in JSON Raw Data:

{

"options": {

"project_number": "P-0056",

"sourceProjectId": "P-0056",

"source": "Primavera Cloud",

"projectType": ""

},

"_attachment": {

"zipped_file_name": "AssignmentSpread.zip",

"zipped_file_size": 780,

}

Sample Response (Failed Scenario):

{

"data": [],

"message": [

{

"message": "The API request contains empty value for: [projectType].",

"status": 12144

}

],

"status": 3000,

"rest_audit_id": 14316

}

Response Format:

JSON Map {

"status" : <integer value> ,

"data" : [ ] ,

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

"rest_audit_id": <id from the rest audit table matching this request>

}

Related Topics