Rest API Documentation for Schedule Item module
EP : Extended Permissions
+ : Consider the permission with + and all permissions above it.
Permission hierarchy : Account Admin > Project Manager > Project Member > Contact
Following are object types and their Ids where notes can be added,
Request = 2
Project = 3
Client = 5
Campaign = 6
Task = 9
Review = 10
File = 12
Todo = 13
Paths List all operations
/scheduleItem.do?cmd=ListAvailablePredecesssor
- GET /scheduleItem.do?cmd=ListAvailablePredecesssor
Summary
Get all available Predecessor.
Description
Get all available predecessors list for the given project's task or review based on object type
Access
- Project Member with view + security
- Project Manager with Manage All EP and View All Active EP
- Account Admin
Parameters
Name Located in Description Required Schema objectId query Provide object Id
No integerobjectType query Provide object type for adding note to it. Refer to Object Types at the top.
Yes integerprojectId query Provide project Id.
Yes integerResponses
Response Type Description Success Retrieval successful.
Schema: List of TaskPredecessor{ TaskPredecessor }
Failure Unexpected error
Schema: Result
/scheduleItem.do?cmd=ListScheduleItemPreview
- GET /scheduleItem.do?cmd=ListScheduleItemPreview
Summary
Get List of Scheduled Item.
Description
Get List of Scheduled Item for preview.
Access
- Contact +
Parameters
Name Located in Description Required Schema shiftDateOption query Shift date options: Shift By Start Date (1) , Shift by Due Date (2)
Yes integertaskOverlapOption query If any of the task dates are overlapping, provide permission if it should be fixed or left as it is - (leave it(1) / fix it(2))
No integerprojectOverlapOption query If project dates are overlapping, provide permission if they should be updated or left as it is - (update(1) / no change(2))
No integerduration query Provide duration of every selected task by Task Id & suration in JSON like
[{"taskId":11502108,"duration":2},{"taskId":11502109,"duration":2}]
No stringobjectId query Provide object Id
No integerobjectType query Provide object type for adding note to it. Refer to Object Types at the top.
Yes integerprojectId query Provide project Id.
Yes integercmdString query "UpdateReviewDates" (When updating review dates)
"ShiftTasks" (When shifting taks)
"UpdateDuration" (When updating task dates.)
Yes stringstartDate query Provide start date for calendar
No string (date)endDate query Provide end date for calendar
No string (date)isMultiSelect query If multiple tasks selected. TRUE: 1, FALSE: 0.
No integerResponses
Response Type Description Success Task(s) duration updated successfully.
Schema: ResultResponse Sample : { "returnCode": 0, "messageKey": "msg_project_success_api_getProjectItems", "detailedMessage": "Failed to get message - msg_project_success_api_getProjectItems", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "4474B0CB795EB28A56174713CD80F79A", "customParams": { "maxDueDate": "12/11/2019 12:00 AM US/Eastern", "minStartDate": "11/27/2019 12:00 AM US/Eastern", "PredecessorDependecyList": [ { "id": null, "review": null, "task": null, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "objectType": 9, "objectId": 11502521, "predecessorObjectType": 10, "predecessorObjectId": 981000, "reviewObj": null, "taskObj": null } ] }, "errorMessages": null, "success": true }
Failure Unexpected error
Schema: Result
/scheduleItem.do?cmd=GetItemDependencies
- GET /scheduleItem.do?cmd=GetItemDependencies
Summary
Get list of dependencies.
Description
Get all available dependencies(Task predecessors) for the given campaign.
Access
- Project Member+ with campaign view permission.
Parameters
Name Located in Description Required Schema campaignId query Provide Campaign Id
Yes integerResponses
Response Type Description Success Retrieval successful.
Schema: List of TaskPredecessor{ TaskPredecessor }
Failure Unexpected error
Schema: Result
/scheduleItem.do?cmd=ShiftScheduledItems
- POST /scheduleItem.do?cmd=ShiftScheduledItems
Summary
Shift Scheduled Items.
Description
Shift Scheduled Items (tasks & reviews)
Access
- Project Member having Manage permission to Project of task
- Project Manager having Manage permission to Project of task or Manage all Project as EP
- Account Admin
Parameters
Name Located in Description Required Schema taskIds query Provide comma separated task Ids to shift.
Yes stringreviewIds query Provide comma separated review Ids to shift.
Yes stringtaskShiftOption query Provide one shift option to shift the tasks
- shift by start date(1)
- shift by due date(2)
Yes integerprojectOverlapOption query If projects dates overlapping with tasks, then provide permission if date should be shifted or not.
- update overlap project dates (1)
- leave project dates as it is (2)
No integertaskOverlapOption query If task dates overlapping within tasks, then provide permission if date should be shifted or not.
- leave task dates as it is (1)
- update overlap task dates (2)
No integershiftDate query Provide reference date to shift tasks by start date or due date.
Yes string (date)Responses
Response Type Description Success Schema: ResultResponse contain customParams, It provide shifted task's project start and due date.
Response Sample : { "returnCode": 0, "messageKey": "msg_task_success_shiftTasks", "detailedMessage": "Task shifted successfully.", "exception": null, "browser": "Mozilla 5.0 (Windows)", "sessionId": "94E86465FCA8065A7997D1EE8799A155", "customParams": { "projectMaxDueDate": "07/16/2018 12:00 AM Asia/Calcutta", "projectStartDate": "06/04/2018 12:00 AM Asia/Calcutta", "projectDueDate": "06/13/2018 12:00 AM Asia/Calcutta", "projectMinStartDate": "06/04/2018 12:00 AM Asia/Calcutta" }, "errorMessages": null, "success": true }
Failure Unexpected error
Schema: Result
/scheduleItem.do?cmd=FixOverlap
- POST /scheduleItem.do?cmd=FixOverlap
Summary
Fix schedule item(reviews & tasks) overlap
Description
Fix schedule item(reviews & tasks) overlap
Access
- Project Member having Manage permission to Project of task
- Project Manager having Manage permission to Project of task or Manage all Project as EP
- Account Admin
Parameters
Name Located in Description Required Schema taskIds query Provide comma separated task Ids to shift. In multiselect case.
Yes stringreviewIds query Provide comma separated review Ids to shift. In multiselect case.
Yes stringtaskId query Provide task Id to shift.
Yes integerreviewId query Provide review Id to shift.
Yes integerprojectOverlapOption query If projects dates overlapping with tasks, then provide permission if date should be shifted or not.
- update overlap project dates (1)
- leave project dates as it is (2)
No integersheduledItemOverlapOption query If Shcedules item(task & review) dates overlapping within, then provide permission if date should be shifted or not.
- leave task dates as it is (1)
- update overlap task dates (2)
- update overlap task dates & fill gaps(3)
No integeraddOperation query Provide 'true' if this overlap opration is done while adding new task or review. Provide 'false' if this overlap opration is done while updating task or review.
No booleanResponses
/scheduleItem.do?cmd=UpdateScheduleItemStatus
- GET /scheduleItem.do?cmd=UpdateScheduleItemStatus
Summary
Update multi-select task & review status
Description
Update multi-select task & review status.
Access
- User with ManageTaskStatusTime,ManageTask & ManageReview permission.
Parameters
Name Located in Description Required Schema taskIds query Provide comma separated task Ids.
Yes integerreviewIds query Provide comma separated review Ids..
Yes integerstatusId query Provide status Id.
Yes integerResponses
Response Type Description Success Schema: ResultAll items status updated successfully.
Response Sample : { "returnCode":0, "messageKey":"msg_scheduleItem_success_api_updateProjectItemsStatus", "detailedMessage":"All items status updated successfully.", "exception":null, "browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36", "sessionId":"9E2FEE83D6E3ACA2B39261E0044BD6D0", "customParams":null, "errorMessages":null, "success":true }
Failure Unexpected error
Schema: Result
/scheduleItem.do?cmd=GetScheduleItemCategoryList
- GET /scheduleItem.do?cmd=GetScheduleItemCategoryList
Summary
Get list of Schedule Item Category
Description
Get list of Schedule Item Category
Access
- User with View project permission .
Parameters
Name Located in Description Required Schema projectId query Provide project Id.
Yes integerResponses
Response Type Description Success Schema: ResultResponse Sample : [ { "id": 188, "account": null, "project": null, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "category": "cat2", "tasks": [], "reviews": [] }, { "id": 150, "account": null, "project": null, "createdBy": 0, "createdOn": null, "modifiedBy": null, "modifiedOn": null, "category": "Category 1", "tasks": [], "reviews": [] } ]
Failure Unexpected error
Schema: Result