Get Mapped External Projects
GET /ws/rest/service/v2/activity/sheet/mappedprojects?project_number={project number}&source_project_id={mapped external project id}
Purpose
Retrieves externally-synced project data in the Activity Sheet of a specified Unifier shell based on source_Project_Id and project_number. This REST service fetches the current project data and baseline project data.
Note: Validations are not implemented for System Activity Sheet data as it is assumed to be sent correctly from the source system.
Prerequisites
Ensure the source project ID is configured or added by selecting Shell Details, and then selecting the Primavera Cloud Integration tab in Unifier.
Request Format
Send an GET request in the format specified above.
Request Parameters
The following parameters can be specified in the request:
Request Parameter | Required? | Data Type | Description |
|---|---|---|---|
project_number | Yes | String | A valid shell number with an Active status. |
source_Project_Id | Yes | String | The project code in Oracle Primavera Cloud. |
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 Response
A successful response with status code 200 displays in the following format:
{
"data": [
{
"dataDate": "2021-04-04T10:00:00",
"scheduleType": "duration",
"projectStartDate": "2019-02-02T10:00:00",
"externalProjectId": 16101,
"workspaceCode": "NON-PROD",
"projectType": "Current",
"id": 289,
"projectName": "OPC-Sheet",
"projectId": "OPC-Sheet"
},
{
"dataDate": "2021-02-03T10:00:00",
"scheduleType": "duration",
"projectStartDate": "2020-02-02T10:00:00",
"externalProjectId": 16102,
"workspaceCode": "NON-PROD",
"projectType": "Baseline",
"id": 290,
"projectName": "OPC-Sheet-B1",
"projectId": "OPC-Sheet-B1"
}
],
"message": [],
"status": 200,
"rest_audit_id": 4587
}
Sample Failed Response
A failed response is returned with a status code in the following format:
{
"data": [],
"message": [
"The API request contains invalid characters in: [source_project_id]. The following characters are not allowed : / \\ : * ? \" < > | ' ="
],
"status": 12204,
"rest_audit_id": 4633
}
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 empty/blank. | 620 | Missing Project Number. |
project_number | project_number is invalid, blank, or not specified in the request. | 602 | Project/Shell Number is not correct. |
project_number | Project/Shell is not an active shell. | 12020 | The API request contains an invalid value: [project_number]. Check the status of this project_number in Unifier. |
source_project_id | source_project_id is not configured in the source Unifier shell. | 12205 | The API request contains an invalid value: [source_project_id]. Check if this source_project_id has been configured in Unifier. |
source_project_id | source_project_id value has invalid special characters. | 12204 | The API request contains invalid characters in: [source_project_id]. The following characters are not allowed : / \\ : * ? \" < > | ' = |
source_project_id | source_project_id value is blank. | 12206 | The API request is missing the required information: [source_project_id]. |
source_project_id | source_project_id exceeds maximum length. | 12202 | Invalid value was found in a field: 'source_project_id'. Allowed length: [250]. |
Related Topics
Create or Update Mapped External Projects
Last Published Wednesday, April 9, 2025