Get Activities in 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}

Purpose

Retrieve a list of activities from the Manual Activity Sheet of a shell based on the project_number and activity sheet name mentioned in the query parameters.

Prerequisites

To get activities in Manual Activity Sheet, the Manual Activity Sheet should be present under the Activity Sheet sub-node.

To access the API, you should have "Get" permission Access in integration → Activity Sheet Services.

Notes:

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 should not be Inactive or in an on-hold status to access the API.
The Manual Activity Sheet should exist in the Shell to access the activities.

Request Parameters

Field Name	Data Type	Description
project_number	String	Valid 'Active' Unifier shell number (shell number into which the system is going to update project details). For example, "P-0001".
activity_sheet_name	String	The name of the activity sheet.

Validation Use-Cases and Error Codes

The following table lists the messages displayed in each use-case or scenario.

Use-Case	Status	Message
project_number provided as blank	12128	The API request contains empty value for: [project_number].
Missing the project_number property in url	12206	The API request is missing the required information: [project_number].
Invalid project_number or null	602	Project/Shell Number is not correct.
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.
If activity sheet name is missing in url	12206	The API request is missing the required information: [activity_sheet_name`].
If 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 exceeded 50 characters.	12202	Invalid value was found in a field: [activity_sheet_name]. Allowed length: [50]
Activity Sheet Name doesn't exist.	12205	The API request contains an invalid value: [activity_sheet_name]. Please check if this activity_sheet_name has been configured in Unifier.

Responses

If the provided project number and activity sheet name are correct, then a success response is displayed.

Otherwise, if any of the validations is not satisfied, the response will display a message and data will return as empty.

Sample Success Response Output:

{

"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 Output

{

"data": [],

"message": [

"The API request contains empty value for: [activity_sheet_name]."

],

"status": 12128,

"rest_audit_id": 18721

}

Related Topics