Robohead API Documentation - Project

REST API Documentation for Project module

EP : Extended Permissions

+  : Consider the permission with + and all permissions above it.
      Permission hierarchy : Account Admin > Project Manager > Project Member > Contact
      Object (Project) security hierarchy : Manage > Contribute > View

Following is the json structure for add and update for project. It contains 3 arrays standardFields, customFields, deletedFields. If standard field is to be added, add its details under standardFields array, with its field Id and value. If custom field is to be added, add its details under customFields array, with its field Id and value. If value of any custom field is to be removed, add its Id and old value in the deletedFields array.

If field type is single select, multi select, radio or check box, pass Option Id as value. Applicable for both standard and custom fields. If multi select or check box, then specify diffrent objects for each option. One example given below, in custom fields array for multi select field - 89599 we have two option Ids 67297, 67298.

Following is the json structure with example :

{"standardFields":
     [
       {"id":Provide field Id,
        "value":Provide value for that standard field},
       {"id":1360,"value":"project new "},
       {"id":1362,"value":"07/01/2016"}
     ],
     "customFields":
     [
       {"id":Provide field Id,
        "value":Provide value for that custom field},
       {"id":89596,"value":67278},
       {"id":89599,"value":67297},
       {"id":89599,"value":67298}
     ],
     "deletedFields":
     [{"id":Provide field Id,
       "deletedValue":Provide deleted values}
    ]
 }

Following is the format for providing details for assigning user to task with perticular role. Provide task role Id and comma seperated user Ids to assign to the task with perticular role. To get list of task roles of the project give call to ListProjectTaskRole of Task module. 

  [{"taskRoleId":Provide task role Id,
    "userIds":Provide comma seperated user Id to assign to task with above role},
   {"taskRoleId":15655,"userIds":"10293,10108,10452"}
  ]

Following is the format for reassigning users for deleted task users. Provide sourceUser i.e. user to be deleted and targetUser i.e. user to be reassigned to the deleted user. These users will be reassigned to the tasks.

{"reassignUsers":
  [
    {"sourceUser":Provide task user Id which is to be deleted
    ,"targetUser":Provide user Id to reassign to task},
    {"sourceUser":"10457","targetUser":11683}
  ]
}

Following is the format for Review Participants. 

[
  {
    "reviewId": Provide review id,
    "reviewOwnerIds": Provide comma seperated review owner id's ,
    "reviewStages": [
      {
        "stageId": provide review stage id,
        "reviewUserIds": Provide comma seperated review user id's,
        "newReviwersEmail": ""
      }
    ]
  },
  {
    "reviewId": 1086673,
    "reviewOwnerIds": "96275",
    "reviewStages": [
      {
        "stageId": 960514,
        "reviewUserIds": "96275,96312",
        "newReviwersEmail": ""
      },
      {
        "stageId": 960515,
        "reviewUserIds": "10000,96322",
        "newReviwersEmail": ""
      }
    ]
  }
]

Using Following process we can create & apply filters. To Create, update, delete filters please refer this.

To apply filter need to pass 'userFilterId' in project list Request.

There are two filter Actions comes under 'filterAction' parameter. For Ad-hoc = 1, Save & Apply Filter OR Update & Apply Filter = 2.

Following is the list of output columns for List project calls.

name
description
projectNumber
formattedRequestNumber
numApprovalsOverdue
budgetedExpense
budgetedLabor
actualExpense
actualLabor
budgetedRevenue
actualRevenue
numTasksBlocked
numTasksBlocking
numTasksCompleted
numTasksInProgress
numTasksNotStarted
numTasksOverdue
totalActualTime
budgetTotal
actualTotal
totalEstimatedTime
numReviews
numTasks
campaignName
isBlocked
projectCode
onBudget
isOnSchedule
requestStatus
clientName
projectStatusId
createdByUser
modifiedByUser
modifiedOn
projectCreateDate
requestCreateDate
startDate
dueDate

Paths List all operations