Get Activities from the Manual Activity Sheet of a Specific Shell
GET/ws/rest/service/v2/activity/sheet/manualactivities?project_number={project number}&activity_sheet_name={manual activity sheet name}&project_type={project_type}
Purpose
Retrieves a list of activities from the Manual Activity Sheet of a specified shell based on the project_number and activity sheet name mentioned in the query parameters.
Note:
- The API uses the fields added in the Integration form of the Activity Sheet (uDesigner) to retrieve the manual activity data from the activity sheet.
- All the request parameter related validations are applied.
- The Activity Sheet Name and Project Number are mandatory fields and validations are applied.
- There is no impact of directions present in the integration form of the Manual Activity Sheet.
- There is no sequence defined for the output response. The properties can be in any sequence.
- The shell status cannot be Inactive or on-hold.
- The Manual Activity Sheet should exist in the shell to access the activities.
Prerequisites
Ensure the following:
- To use this REST service, you have Get permission for Activity Sheet Services.
- The Manual Activity Sheet must be present in the Activity Sheet sub-node.
Request Parameters
The following parameters can be included in the query
| Request Parameter | Required? | Data Type | Description |
|---|---|---|---|
| project_number | Yes | String | An 'Active' Unifier shell number (shell number into which the system is going to update project details). For example, "P-0001". |
| activity_sheet_name | Yes | String | The name of the activity sheet. |
| project_type | No | String |
The project type category associated with the shell for fetching the activities created in corresponding sheets. Valid values include: "Current" (default) and "Baseline". If project_type is missing, "Current" is used as the default value. |
Response Format
A JSON object is returned in the following format.
{
"data": [],
"message": [],
"status": <REST status code value>
}
A successful response displays a status code 200.
A failed response displays a message with a status code.
Sample Success Response Output
A successful response displays with status code 200 in the following format:
{
"data": [
{
"uuu_P6ActivityType": "Task Dependent",
"uuu_P6ActualFinish": null,
"uuu_P6ActualStart": "2022-12-10T16:00:00",
"uuu_P6RemainingEarlyStart": "2022-11-30T08:00:00",
"uuu_P6ActivityId": "A22TestSheet",
"uuu_P6ActualDuration": 0.0,
"uuu_P6AtCompletionDuration": 0.0,
"uuu_P6Finish": "2022-12-13T16:00:00",
"uuu_P6PercentComplete": 100.0,
"uuu_P6RemainingTotalCost": 0.0,
"uuu_P6RemainingEarlyFinish": "2022-12-13T16:00:00",
"uuu_P6ActivityStatus": "Not Started",
"uuu_P6PlannedDuration": 0.0,
"uuu_P6ActualTotalCost": 0.0,
"uuu_P6PlannedFinish": null,
"id": 1482795,
"uuu_P6PlannedStart": null,
"uuu_P6EVCost": 40.0,
"uuu_P6ActivityName": "A22TestSheet",
"uuu_P6PlannedTotalCost": 1.0,
"uuu_P6Start": "2022-11-30T08:00:00",
"uuu_P6RemainingDuration": 80.0
}
],
"message": [
"success"
],
"status": 200,
"rest_audit_id": 18722
}
Sample Error Response
A failed response displays a status code in the following format:
{
"data": [],
"message": ["The API request contains empty value for: [activity_sheet_name]."],
"status": 12128,
"rest_audit_id": 18721
}
Validation Messages and Status Codes
The following table lists the messages displayed in each use-case or scenario.
| Parameter | Use-Case | Status | Message |
|---|---|---|---|
| project_number | project_number provided as blank | 12128 | The API request contains empty value for: [project_number]. |
| project_number | The project_number is missing in the URL. | 12206 | The API request is missing the required information: [project_number]. |
| project_number | Invalid project_number or null | 602 | Project/Shell Number is not correct. |
| project_number | Inactive/On Hold project_number | 12020 | The API request contains an invalid value: [project_number]. Please check the status of this project_number in Unifier. |
| activity_sheet_name | Activity sheet name is missing in the URL. | 12206 | The API request is missing the required information: [activity_sheet_name`]. |
| activity_sheet_name | Activity sheet name is empty/null for activity sheet type "manual", throwing validation | 12128 | The API request contains empty value for: [activity_sheet_name]. |
| activity_sheet_name | Activity Sheet Name exceeds 50 characters. | 12202 | Invalid value was found in a field: [activity_sheet_name]. Allowed length: [50] |
| activity_sheet_name | Activity Sheet Name does not exist. | 12205 | The API request contains an invalid value: [activity_sheet_name]. Please check if this activity_sheet_name has been configured in Unifier. |
| project_type | project_type is null or empty | 12144 | The API request contains empty value for: [project_type]. Allowed values: [Current, Baseline] |
| project_type | project_type value is invalid. | 12145 | Invalid value was found in a field: [project_type]. Allowed values: [Current, Baseline] |
| project_type | Baseline is not configured | 12036 | Invalid value was found in a field: [projectType]. Baseline not defined for this Project |
| project_type | project_type is missing. | The API request is missing the required information: [project_type]. Allowed values: [Current, Baseline]. |