Get Work Package
GET /ws/rest/service/v2/projectcostsheet/workpackage?project_number= <value>
Purpose
Get work packages associated with a specific shell.
Prerequisites
Ensure you have Full Access or Get permissions for CBS services to retrieve work packages from the shell cost sheet log.
Request Format
Send an API request as a JSON map with the following structure:
/ws/rest/service/v2/projectcostsheet/workpackage?project_number = <value>
Request Parameters
Specify the following parameters in the request:
Request Parameter | Required? | Data Type | Description |
|---|---|---|---|
project_number | Yes | String | A valid Unifier shell number. |
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 retrieve work packages associated with project, P0021, send a request in the following format:
/ws/rest/service/v2/projectcostsheet/workpackage?project_number=P-0021
Sample Success Response
A successful response with status code 200 displays in the following format:
{
"data": [
{
"owner": "Company Administrator",
"comments": "comments",
"vendor": "IDC Company",
"name": "A81",
"description": "description",
"ref_no": "A81",
"status": "Active"
},
{
"owner": "Company Administrator",
"comments": "Creating Work Package for Testing",
"vendor": "IDC Company",
"name": "68",
"description": "Work Package-4 Description",
"ref_no": "68",
"status": "Active"
}
],
"message": [
"success"
],
"status": 200,
"rest_audit_id": 3353
}
Sample Failed Response
A failed response displays the corresponding status code in the following format:
{
"data": [],
"message": [
"Create/Update/Delete cannot be performed when project/shell status is Inactive or View-Only or On-Hold."
],
"status": 1245,
"rest_audit_id": 4049
}
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 included in the request. | 13001 | Project/Shell number is mandatory and is missing in the input request |
project_number | project number is invalid. | 602 | Project/Shell Number is not correct. |
project_number | Project/Shell is not active. | 1245 | Create/Update/Delete cannot be performed when project/shell status is Inactive or View-Only or On-Hold. |
project_number | Cost sheet does not exist in the specified shell. | 707 | Cost sheet does not exist |
Related Topics
Get Names of Cost Sheet Snapshots
Update Lock Status of Cost Sheet
Last Published Tuesday, July 1, 2025