Get Assignments
GET /ws/rest/service/v2/activity/sheet/assignments?project_number={project_number}&project_type={project_type}&activity_sheet_type={activity_sheet_type}&source_project_id={source_project_id}&activity_sheet_name={activity_sheet_name}
Purpose
Retrieves Assignments data of Activity Sheet in a specified Unifier Shell based on any of the following combinations of request parameters:
- source_project_id/activity_sheet_name and project_number
- sheet type and project_type
Prerequisites
Ensure the following:
- To get assignments for externally-synced or manual activity sheets from other applications, the source project ID or manual activity sheet is configured.
- To get assignments for system activity sheets, select Shell Details and then select the Primavera Cloud Integration tab in Unifier.
- For system activity sheets, the sourceProjectId (projectId of the external application configured from Oracle Primavera Cloud) already exists.
Note:
P6 system sheets are not supported. - For manual activity sheets, the activity sheet already exists.
- The activity sheets are created and activities exist for which assignments have to be fetched.
Request Format For Manual Activity Sheet
For a manual activity sheet, send a request in the following format:
{hostUrl}//ws/rest/service/v2/activity/sheet/assignments?project_number=<value>&project_type=<value>&activitySheetType=manual&activity_sheet_name=<value>
Request Format For System Activity Sheet
For a system activity sheet, send a request in the following format:
{hostUrl}/ws/rest/service/v2/activity/sheet/assignments?project_number=<value>&source_project_id=<value>&activity_sheet_name=<value>&activity_sheet_type=<value>&project_type=<value>
Request Parameters
Specify the following parameters in the request:
| Request Parameter | Required? | Data Type | Description |
|---|---|---|---|
| project_number | Yes | String | A valid shell number with an Active status to get Assignments data of Activities. |
| activity_sheet_type | Yes | String | The type of activity sheet to be retrieved. Valid values include: "manual" and "system". |
| activity_sheet_name | Yes If "activity_sheet_type" is "manual", | String | The name of the activity sheet. |
| source_project_id | No | String | The project code in Oracle Primavera Cloud. For example, MSK01. |
| project_type | No | String | The project types for fetching the activities created in corresponding sheets. Valid values include: "Current" (default) and "Baseline". |
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 - Manual Activity Sheet
For a manual activity sheet, send a request in the following format:
{hostUrl}//ws/rest/service/v2/activity/sheet/assignments?project_number=P-0115&project_type=Current&activitySheetType=manual&activity_sheet_name=ManualSheet
Sample Success Response - Manual Activity Sheet
A successful response with a status code displays in the following format
{
"data": [
{
"plannedPricePerUnit": 0.0,
"plannedUnits": 80.0,
"remainingCost": 0.0,
"atCompletionUnits": 80.0,
"plannedStart": "2024-01-22T21:30:00",
"duration": 8.0,
"plannedCost": 0.0,
"activityId": "A1000",
"actualsPricePerUnit": 0.0,
"resourceCode": "Rahul Anand",
"atCompletionCost": 0.0,
"remainingStart": "2024-01-22T21:30:00",
"remainingDuration": 8.0,
"remainingUnitsPerTime": 0.0,
"plannedDuration": 8.0,
"finish": "2024-01-23T05:30:00",
"id": 58090,
"actualCost": 0.0,
"plannedFinish": "2024-01-23T05:30:00",
"actualUnits": 0.0,
"plannedUnitsPerTime": 0.0,
"profile": "Linear",
"remainingFinish": "2024-01-23T05:30:00",
"start": "2024-01-22T21:30:00",
"remainingUnits": 80.0,
"rateSource": "Resource",
"costCode": null,
"workspaceCode": null
},
{
"plannedPricePerUnit": 150.0,
"plannedUnits": 80.0,
"remainingCost": 12000.0,
"atCompletionUnits": 80.0,
"plannedStart": "2024-01-22T21:30:00",
"duration": 8.0,
"plannedCost": 12000.0,
"activityId": "A1010",
"actualsPricePerUnit": 150.0,
"resourceCode": "Ravi Sharma",
"atCompletionCost": 12000.0,
"remainingStart": "2024-01-22T21:30:00",
"remainingDuration": 8.0,
"remainingUnitsPerTime": 0.0,
"plannedDuration": 8.0,
"finish": "2024-01-23T05:30:00",
"id": 58091,
"actualCost": 0.0,
"plannedFinish": "2024-01-23T05:30:00",
"actualUnits": 0.0,
"plannedUnitsPerTime": 0.0,
"profile": "Linear",
"remainingFinish": "2024-01-23T05:30:00",
"start": "2024-01-22T21:30:00",
"remainingUnits": 80.0,
"rateSource": "Resource",
"costCode": null,
"workspaceCode": "NON_PROD3"
},
{
"plannedPricePerUnit": 0.0,
"plannedUnits": 8.0,
"remainingCost": 0.0,
"atCompletionUnits": 8.0,
"plannedStart": "2024-01-22T21:30:00",
"duration": 8.0,
"plannedCost": 0.0,
"activityId": "A1010",
"actualsPricePerUnit": 0.0,
"resourceCode": "Ravi2",
"atCompletionCost": 0.0,
"remainingStart": "2024-01-22T21:30:00",
"remainingDuration": 8.0,
"remainingUnitsPerTime": 0.0,
"plannedDuration": 8.0,
"finish": "2024-01-23T05:30:00",
"id": 58092,
"actualCost": 0.0,
"plannedFinish": "2024-01-23T05:30:00",
"actualUnits": 0.0,
"plannedUnitsPerTime": 0.0,
"profile": "Linear",
"remainingFinish": "2024-01-23T05:30:00",
"start": "2024-01-22T21:30:00",
"remainingUnits": 8.0,
"rateSource": "Resource",
"costCode": null,
"workspaceCode": null
},
{
"plannedPricePerUnit": 30.0,
"plannedUnits": 8.0,
"remainingCost": 240.0,
"atCompletionUnits": 8.0,
"plannedStart": "2024-01-22T21:30:00",
"duration": 8.0,
"plannedCost": 240.0,
"activityId": "A1000",
"actualsPricePerUnit": 30.0,
"atCompletionCost": 240.0,
"roleCode": "RoleName7396",
"remainingStart": "2024-01-22T21:30:00",
"remainingDuration": 8.0,
"remainingUnitsPerTime": 0.0,
"plannedDuration": 8.0,
"finish": "2024-01-23T05:30:00",
"id": 58093,
"actualCost": 0.0,
"plannedFinish": "2024-01-23T05:30:00",
"actualUnits": 0.0,
"plannedUnitsPerTime": 0.0,
"profile": "Linear",
"remainingFinish": "2024-01-23T05:30:00",
"start": "2024-01-22T21:30:00",
"remainingUnits": 8.0,
"rateSource": "Role",
"costCode": null,
"workspaceCode": "bink"
}
],
"message": ["success"],
"rest_audit_id": 24630,
"status": 200
}
Sample Success Request For No Assignments
For a system activity sheet, send a request in the following format:
{hostUrl}/ws/rest/service/v2/activity/sheet/assignments?project_number=P-0115&source_project_id=ActivityManual&activity_sheet_name=SysAct01&activity_sheet_type=system&project_type=Current
Sample Success Response
A successful response with a status code displays in the following format:
{
"data": [],
"message": ["success"],
"rest_audit_id": 24886,
"status": 200
}
Sample Failure Request
This is an example of a failed request:
{hostUrl}//ws/rest/service/v2/activity/sheet/assignments?project_number=P-0115&project_type=Current&activitySheetType=manual&activity_sheet_name=
Sample Failure Response
A failed response to the above request displays with a status code in the following format:
{
"data": [],
"message": [
"The API request contains empty value for: [activity_sheet_name]. If the activity_sheet_type=manual, then activity_sheet_name cannot be empty."
],
"status": 12068,
"rest_audit_id": 18721
}
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 | source is not specified in the request. | 602 | Project/Shell Number is not correct. |
| project_number | project_number is not specified. | 12018 | The API request is missing the required information: [project_number]. |
| 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]. |
| activity_sheet_type | activitySheetType value is not specified in the request. | 12010 | The API request is missing the required information: [activitySheetType] |
| activity_sheet_type | Invalid activity_sheet_type specified in the request. | 12011 | Invalid value was found in a field: [activitySheetType]. Allowed values: [manual, system] |
| activity_sheet_type | activitySheetType is empty/blank. | 12034 | The API request contains an empty value for: [activitySheetType]. Allowed values: [manual, system] |
| activity_sheet_name | activity_sheet_name is not specified in the request. | 12012 | The API request is missing the required information: [activitySheetName]. |
| activity_sheet_name | activity_sheet_name 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. |
| activity_sheet_name | activity_sheet_name exceeds maximum length. | 12017 | Invalid value was found in a field: [activity_sheet_name]. Allowed length: [250] |
| activity_sheet_name | activity_sheet_name value is null or empty. | 12068 | The API request contains empty value for: [activitySheetName]. |
| source_project_id | source_project_id is not specified in the request. | 12005 | The API request is missing the required information: [sourceProjectId] |
| source_project_id | source_project_id exceeds maximum length. | 12014 | Invalid value was found in a field: [source_project_id]. Allowed length: [250] |
| source_project_id | source_project_id 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. |
| source_project_id | source_project_id has invalid special characters. | 12022 | The API request contains invalid characters in: [source_project_id]. The following characters are not allowed : / \\ : * ? \" < > | ' = |
| source_project_id | source_project_id value is a blank. | 12032 | The API request contains empty value for: [sourceProjectId]. |
| project_type | Baseline sheet is not configured. | 12036 | Invalid value was found in a field: [projectType]. Baseline not defined for this Project. |
| project_type | projectType is empty/blank for system sheet. | 12144 | The API request contains empty value for: [projectType]. Allowed values: [Current, Baseline] |
| project_type | An invalid value is passed in projectType for system sheet. | 12145 | Invalid value was found in a field: 'projectType'. Allowed values: [Current, Baseline] |