Robohead API Documentation - User

Rest API Documentation for User module

EP : Extended Permissions

+  : Consider the permission with + and all permissions above it.
     Permission hierarchy : Account Admin > Project Manager > Project Member > Contact

Following are the filter details that can be applied to user list calls. Provide filter column name in 'column' parameter. Provide what type of filter should be applied in 'comparatorId' parameter. Provide filter value in 'value' parameter. All three parameters are required.

List of filters,

 Column name: User Role
     column: role_id
     comparatorId: Provide comparator Id 11(include) or 12(dose not include)
     value: Provide comma separated role Ids. (Get user role list by giving call to ListUserRoleType of user module)
 Column name: User Groups
     column: userGroup
     comparatorId: Provide comparator Id 11(include) or 12(dose not include)
     value: Provide comma separated usergroup Ids. (Get active groups list by giving call to ListActiveGroup of group module)
 Column name: Client
      column: client_id
      comparatorId: Provide comparator Id 11(include) or 12(dose not include)
      value: Provide comma separated client Ids. (Get active client list by giving call to ListAllActiveClient of client module)

Following are object types and their Ids,


    Account  = 1
    Request  = 2
    Project  = 3
    Folder   = 4
    Client   = 5
    Campaign = 6
    Task     = 9
    Review   = 10
    File     = 12
    Todo     = 13

Following are project metric settings and their Ids,


    Project Status  	= 1
    On Schedule         = 2
    On Budget           = 4
    Possible Delay   	= 8
    Overall Task Status = 16
    Total Budgeted Cost = 32
    Total Cost          = 64
    Burndown Chart   	= 128
    Budget Remaing      = 256

Following are campaign metric settings and their Ids,


    Project Metrics  	  = 1
    On Schedule           = 2
    On Budget             = 4
    Overall Task Status   = 8
    Camping Budgeted Cost = 16
    Campaign Cost         = 32
    Budget Remaing        = 64
    Burndown Chart        = 128
[{"name":"kudosCreatedOn","value":"DATE"},{"name":"projectName","value":"PROJECT NAME"},{"name":"projectNumber","value":"PROJECT #"},{"name":"recipientEmailAddress","value":"SURVEY SENT TO"},{"name":"senderFirstName","value":"FIRST NAME"},{"name":"senderLastName","value":"LAST NAME"},{"name":"comment","value":"COMMENT"}]

Paths List all operations

  • /user.do?cmd=UpdateProjectMetricConfig

  • /user.do?cmd=UpdateCampaignMetricConfig

  • /user.do?cmd=ListAccountActiveUser

  • /user.do?cmd=GetTaskRoleUsers

  • /user.do?cmd=AddToClient

  • /user.do?cmd=GetUserEstimatedAllocationAndStatus

  • /user.do?cmd=GetResourceManagerList

  • /user.do?cmd=GetUserAlternateTimesheetApprover

  • /user.do?cmd=GetUserAlternateResourceApprover

  • /user.do?cmd=ListAlternateTimesheetApproverUser

  • /user.do?cmd=ListAlternateResourceApproverUser

  • /user.do?cmd=UpdateUserAlternateTimesheetApprover

  • /user.do?cmd=UpdateUserAlternateResourceApprover

  • /user.do?cmd=GetTimesheetApproverList

  • /user.do?cmd=ListPurchaseOrderManagers

  • /user.do?cmd=ListClientFeeResources

  • /user.do?cmd=GetUserRateDetails

  • /user.do?cmd=AssignResourceApprover

  • /user.do?cmd=UserCapacityDetailsForUser

  • /user.do?cmd=DeleteUserCapacity

  • /user.do?cmd=AddUserCapacity

  • /user.do?cmd=GetUserTaskRoleAllocationHistory

  • /user.do?cmd=GetUserForecasting

  • /user.do?cmd=UpdateUserForecasting

  • /user.do?cmd=PopulateUserForecasting

  • /user.do?cmd=ExportUserForecastingView

  • /user.do?cmd=UpdateReviewSectionOrder