ROBOHEAD REST API

REST API Documentation
Up

Models

Table of Contents

  1. Account
  2. AccountHoliday
  3. AccountSummary
  4. ActivityLog
  5. ActivityUser
  6. ActiveUserGroupList
  7. ActualExpense
  8. AllActiveGroup
  9. AnnotationViewer
  10. Announcement
  11. AnnouncementRole
  12. AnnouncementUser
  13. BudgetedExpense
  14. Campaign
  15. CampaignForm
  16. CampaignProject
  17. CampaignSecurity
  18. CampaignSummary
  19. ChangeTracking
  20. Chart
  21. Client
  22. ClientFee
  23. ClientFeeHistory
  24. ClientOption
  25. ClientSummary
  26. Coordinate
  27. CwClient
  28. CwUser
  29. DashboardMap
  30. DashboardPreference
  31. DashboardUserWeeklyActivityType
  32. EmailTemplate
  33. EstimateBudgetedExpense
  34. EstimateLaborExpense
  35. EstimateRateCard
  36. EstimateTypeTotals
  37. ExpenseFieldOptions
  38. Field
  39. FieldComparator
  40. FieldEvent
  41. FieldJavascript
  42. FieldOption
  43. FieldType
  44. FieldValue
  45. File
  46. FileActivityLog
  47. FileExternalLink
  48. FileVersion
  49. Folder
  50. FolderSecurity
  51. FinanceItem
  52. FinanceSummary
  53. Form
  54. FormHistory
  55. FulltextSearch
  56. GetCampaign
  57. GetFolderDetail
  58. GetProject
  59. GetProjectRequestActivity
  60. GetRequest
  61. GetTimeSheet
  62. GlobalList
  63. GroupUser
  64. IdValuePair
  65. IntervalDateDetail
  66. ItemLastRead
  67. ListColumn
  68. ListProjectTaskAndReview
  69. NameValuePair
  70. NonProjectTask
  71. Note
  72. NoteUser
  73. NotificationEvent
  74. NotificationEventScope
  75. NotificationMethodName
  76. NotificationPreference
  77. PayRate
  78. Permission
  79. Project
  80. ProjectFee
  81. ProjectFeeHistory
  82. ProjectFeeSummary
  83. ProjectForm
  84. ProjectPurchaseOrder
  85. PurchaseOrder
  86. PurchaseOrderChargeHistory
  87. ProjectSecurity
  88. ProjectSummary
  89. ProjectItem
  90. RateCard
  91. RateCardHistory
  92. Report
  93. ReportColumn
  94. ReportCondition
  95. ResourceUtilizationInfoMap
  96. ResourceUtilizationMap
  97. Result
  98. Review
  99. ReviewAnnotationViewer
  100. ReviewComment
  101. ReviewGroupUser
  102. ReviewItem
  103. ReviewMultipage
  104. ReviewOwner
  105. ReviewSummary
  106. ReviewUser
  107. ReviewUsergroup
  108. ReviewVersion
  109. ReviewVersionStatus
  110. ReviewerCommentDetail
  111. Role
  112. Rule
  113. RuleAction
  114. RuleCondition
  115. RunReport
  116. Section
  117. SectionField
  118. Series
  119. Stamp
  120. SummaryField
  121. Tag
  122. TagValue
  123. Task
  124. TaskDetailsList
  125. TaskHoursDetail
  126. TaskPredecessor
  127. TaskPriority
  128. TaskRole
  129. TaskSummary
  130. TaskUser
  131. TimeTaskList
  132. Timesheet
  133. TimesheetApprovers
  134. TimesheetStatusHistory
  135. Timeslip
  136. TimeslipNonprj
  137. Todo
  138. UnreadObjectCount
  139. User
  140. UserClient
  141. UserEmailMap
  142. UserFavority
  143. UserGroup
  144. UserHoliday
  145. UserPermission
  146. UserCapacity
  147. UserResourceUtilizationList
  148. UserSummary
  149. UserTaskRole
  150. UserTaskRoleRate
  151. UserCalendarResponse
  152. UserGanttDetails
  153. RateInfo
  154. MonthlyAccountSummary
  155. QuarterlyAccountSummary
  156. TaskGroup
  157. UserFilter
  158. Survey
  159. SurveyRecipient
  160. SurveyResponse
  161. ScheduleGanttView
  162. NoteThread
  163. NoteThreadUser
  164. ReviewCcUser
  165. PdfLayerDetail

Account Up

id
Long format: int64
globalListByContractTermsId
globalListByInvoiceFrequencyId
globalListByClassificationId
globalListByCurrencyId
globalListByAccountManagerId
globalListByIndustryId
createdBy
Long format: int64
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
accountName
accountUrl
timezone
defaultEmailDisplayName
inboxEmailName
accountCloseDate
date format: date
directS3Download
requestNumberFormat
resetRequestNumberYearlyFlag
startRequestNumber
fiscalYearStartDate
date format: date
projectNumberFormat
resetProjectNumberYearlyFlag
startProjectNumber
pwdExpiryDays
pwdMinimumLength
requireInitialPwdReset
pwdContainNumber
pwdContainSymbol
pwdUpperLower
pwdAsUserName
allowSaveUserName
allowSavePwd
allowEditForApproval
allowExternalRequests
allowExternalReviews
storageLimit
enableReviewModule
enableRequestModule
enableProjectModule
enableLibraryModule
enableCampaignModule
enableTimeModule
enableExpenseModule
enablePersonalTodos
enableTaskModule
enableClientModule
enableApi
expenseContribute
expenseView
sessionTimeoutMinutes
numContractedUsers
numContractedContacts
dateFormat
customLabels
requiredTaskDates
requiredReviewDates
weekStartDay
contractSignature
date format: date
firstUseDate
date format: date
poEndDate
date format: date
renewalType
loginCustomLabels
extraStorageRate
Double format: double
nameOnContract
contractLastExecutionDate
date format: date
goLiveDate
date format: date
otherTerms
legacyAccount
billingDay
baseRatePerUser
Double format: double
additionalUserRate
Double format: double
collaboratorModuleRate
Double format: double
requesterModuleRate
Double format: double
bundledModuleRate
Double format: double
enableSaml
samlEntityId
accountSummary
accountLogoUrl
welcomeLogoUrl
formatttedProjectNumberFormat
formatttedRequestNumberFormat
messagesMap
Object Map of custom messages.
maxNumFailedAttempts
numLastPwdCannotbeUsed
allowRequesterEditSubmittedRequest
requiredProjectDates
requiredCampaignDates
enableAdvancedDam
enableDamForContacts
enableClientSegmentation
enableChat
enableCwSync
enableEstimatesModule
enableBillingModule
enableAdvancedTimesheetApproval
enablePo

AccountHoliday Up

id
account
Client
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
startDate
date format: date
endDate
date format: date
description

AccountSummary Up

account
storageUsed
numUsers
numContacts
lastLogin
date format: date

ActivityLog Up

id
account
notificationEvent
performedBy
performedOn
date format: date
objectId
objectType
rootObjectId
rootObjectType
activityUserJobStatusId
activityUsers
performedByUserImage
userEmailAddressList
userEmailAddress
userTimeZone
subject
streamMessage
emailPlaintextMessage
emailHtmlMessage

ActivityUser Up

id
user
activityLog
inDashboardStream
inImmediateEmail
inDailyEmail
inWeeklyEmail

ActiveUserGroupList Up

id
Integer User Id or Group Id.
displayName
String User Name or Group Name.
isUser
Boolean If user object then it is true otherwise false when it is group object.
emailAddress
String User email address(Applicable for User object)
roleId
Integer User role Id (Applicable for User object).

ActualExpense Up

id
project
budgetedExpense
expenseFieldOptionsBySupplierId
expenseFieldOptionsByExpenseType
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
expenseDate
date format: date
actualAmount
Double format: double
invoiceNumber
deletedBudgetedExpenseReferenceId
description
user
markupPercentage
billAmount
globalList
invoiceInfo
invoiceId

AllActiveGroup Up

id
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
String Returned for user group only
reviewUsergroupName
String returend for review group only
createdByUser
modifiedByUser

AnnotationViewer Up

refreshComments
annotationViewers
String comma seperated annotation viewer

Announcement Up

id
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
type
header
body
startDate
date format: date
expiryDate
date format: date
announcementRoles
announcementUsers
roles

AnnouncementRole Up

id
role
announcement
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

AnnouncementUser Up

id
user
announcement
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
readDate
date format: date

BudgetedExpense Up

id
project
expenseFieldOptions
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
budgetedAmount
Double format: double
description
actualExpenseTotal
Double format: double
actualExpenses
leaf
fieldValues
Double format: double

Campaign Up

id
client
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
startDate
date format: date
dueDate
date format: date
description
budgetedExpense
budgetedRevenue
campaignSummary
campaignSecurities
campaignProjects
fieldValues
leaf
createdByUser
modifiedByUser
tag
campaignNumber
formattedCampaignNumber

CampaignForm Up

id
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
formType
customJs
introText
confirmationMessage
sections
formHistories
formStatus
modifiedByUser
formName

CampaignProject Up

id
project
campaign
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
sortOrder

CampaignSecurity Up

id
user
usergroup
campaign
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
security

CampaignSummary Up

campaignId
campaign
numProjects
numProjectsOverBudget
numProjectsBlocked
numTasksCompleted
numTasksInProgress
numTasksNotStarted
projectBudgetedExpense
Double format: double
projectBudgetedLabor
Double format: double
projectTotalBudgetedCost
Double format: double
projectEstimatedRevenue
Double format: double
projectActualExpense
Double format: double
projectTotalActualCost
Double format: double
budgetRemaining
Double format: double
onBudget
isBlocked
numProjectsBehindSchedule
isOnSchedule

ChangeTracking Up

id
user
changedOn
date format: date
objectId
objectType
trackingType
oldValue
newValue
description

Chart Up

xLabel
yLabel
start
limit
totalRecords
page
series

Client Up

id
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
description
code
clientLogoUrl
clientSummary
modifiedByUser
emailDisplayName
fiscalYearStartDate
date format: date
requestNumberFormat
startRequestNumber
resetRequestNumberYearlyFlag
projectNumberFormat
startProjectNumber
resetProjectNumberYearlyFlag
globalList
userClient
cwClient
classificationCode

ClientFee Up

id
user
globalListByFrequency
account
client
globalListByStatusId
purchaseOrder
globalListByEnds
globalListByFeeTypeId
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
billDate
date format: date
amount
description
state
recurring
repeatInterval
numOccurences
lastBillDate
date format: date
nextBillDate
date format: date
startDate
date format: date
endDate
date format: date
isCwSynced

ClientFeeHistory Up

id
user
account
client
globalListByStatusId
purchaseOrder
globalListByFeeTypeId
createdBy
createdOn
date format: date
billDate
date format: date
amount
description
isCwSynced
isClientFeeOpen
invoiceId
invoiceNumber

ClientSummary Up

numActiveProjects
numArchivedProjects
numActiveCampaigns
numArchivedCampaigns
budgetActiveProjects
Double format: double
budgetActiveCampaigns
Double format: double
budgetArchivedProjects
Double format: double
budgetArchivedCampaigns
Double format: double
revenueActiveProjects
Double format: double
revenueArchivedProjects
Double format: double
revenueArchivedCampaigns
Double format: double
actualExpenseActiveProjects
Double format: double
actualExpenseActiveCampaigns
Double format: double
actualExpenseArchivedProjects
Double format: double
actualExpenseArchivedCampaigns
Double format: double

Coordinate Up

xValue
yValue

CwClient Up

id
cwClientId
cwClientName
modifiedOn
createdOn
state
previousCwClientId

CwUser Up

id
cwUserId
cwEmailAddress
cwFirstName
cwLastName
modifiedOn
createdOn
state
previousCwUserId
globalList

RateCardHistory Up

id
rateCard
createdBy
createdOn
modifiedBy
modifiedOn
effectiveDate
unitCost

DashboardMap Up

id
Long format: int64
createdBy
Long format: int64
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
listType
value
displayValue
sortOrder

DashboardPreference Up

id
user
globalList
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
tabId
avatarFlag
numRecentActivity
sectionSortOrder
tabSortOrder
dashboardViewType
reportName
reportType
screenSize

DashboardUserWeeklyActivityType Up

requestSubmittedCount
projectStartedCount
projectCreatedCount
endWeek
date format: date
hoursEstimated
Double format: double
hoursWorked
Double format: double

EmailTemplate Up

id
globalList
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
templateType
subject
plaintextMessage
htmlMessage

EstimateBudgetedExpense Up

id
estimateTypeTotals
estimate
expenseFieldOptions
createdBy
createdOn
description
budgetedAmount
taxRate
taxAmount
total

EstimateLaborExpense Up

id
estimateTypeTotals
taskRole
estimate
createdBy
createdOn
description
hours
taxRate
taxAmount
total
rate

EstimateRateCard Up

id
estimateTypeTotals
rateCard
estimate
createdBy
createdOn
description
quantity
taxRate
taxAmount
total
unitCost

EstimateTypeTotals Up

id
estimate
createdBy
createdOn
estimateType
totalTax
total

ExpenseFieldOptions Up

id
account
client
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
listType
displayValue
sortOrder

Field Up

id
fieldType
globalList
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
objectType
displayName
noOfDecimal
fieldOptions
reportColumns
sectionFields
summaryFields
ruleConditions
fieldValues
listColumns
reportConditions
reportsForGroupByFieldId
ruleActions
reportsForSortByFieldId
fieldOptionJson

FieldComparator Up

id
fieldType
globalList

FieldEvent Up

id
fieldType
name
description

FieldJavascript Up

id
fieldEvent
sectionField
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
functionName

FieldOption Up

id
field
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
displayValue
sortOrder
projectsForProjectCode
projectsForProjectStatusId
fieldValues

FieldType Up

id
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
name
description

FieldValue Up

id
field
fieldOption
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
objectId
objectType
textValue
numValue
Double format: double
dateValue
date format: date
value
optionIds

File Up

id
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
objectId
objectType
fileName
fileVersionById
parentFileId
versionDescription
fileVersion
title
mimeType
size
Long format: int64
numPages
height
width
rhS3Path
reviewVersions
fileActivityLogs
fileExternalLink
usersForStandardAvatarFileId
usersForCustomAvatarFileId
createdByUserName
originalFileUrl
thumbnailUrl
previewImageUrl
fileSecurity
objectName
rhcInfo
modifiedByUser

FileActivityLog Up

id
file
user
activityOn
date format: date
description
objectId
objectType

FileExternalLink Up

id
account
user
createdBy
createdOn
Date format: date
modifiedBy
modifiedOn
Date format: date
expiryDate
Date format: date
externalUrl
file
groupId
linkedFileList

FileVersion Up

fileId
parentFileId
fileVersion
description

Folder Up

id
folderByDeletedParentReferenceId
account
folderByParentFolderId
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
folderName
folderPath
folderNamePath
folderSecurities
foldersForParentFolderId
foldersForDeletedParentReferenceId
isLeaf
createdByUserName

FolderSecurity Up

id
user
folder
usergroup
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
security

FinanceItem Up

objectType
itemName
estimateTotal
actualTotal
invoicedTotal

FinanceSummary Up

financeItemList
estimateTotal
actualTotal
invoicedTotal
estimateId

Form Up

id
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
formType
introText
confirmationMessage
sections
formHistories
formStatus
modifiedByUser
formName
client
state

FormHistory Up

id
form
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
formStatus
jsonText
formJavaScript
viewFormJavaScript
ruleJavaScript
rules
Object Set of rules
client
state

FulltextSearch Up

ActiveCampaignCount
ActiveProjectCount
ActiveRequestCount
ArchivedCampaignCount
ArchivedProjectCount
ArchivedRequestCount
CampaignIds
Integer comma seperated Id's
ProjectIds
Integer comma seperated Id's
RequestIds
Integer comma seperated Id's
FileIds
Integer comma seperated Id's
TaskIds
Integer comma seperated Id's
ReviewIds
Integer comma seperated Id's
NoteIds
Integer comma seperated Id's
FileCount
TaskCount
ReviewCount
NoteCount
activeCount
archivedCount
totalCount

GetCampaign Up

campaign
campaignForm

GetFolderDetail Up

folder
file

GetProject Up

project
projectForm

GetProjectRequestActivity Up

projectCount
endWeek
date format: date
requestCount

GetRequest Up

request
requestForm

GetTimeSheet Up

isTimeSheetOpen
timeSheet

GlobalList Up

id
Long format: int64
createdBy
Long format: int64
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
listType
value
displayValue
sortOrder

GroupUser Up

id
user
usergroup
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

IdValuePair Up

id
value

IntervalDateDetail Up

date
date format: date
isHoliday
isWeekend

ItemLastRead Up

id
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
itemType
objectId
lastReadTimestamp
date format: date

ListColumn Up

id
field
account
formType
selectedFlag
sortOrder

ListProjectTaskAndReview Up

review
task

NameValuePair Up

name
value

NonProjectTask Up

id
taskRole
account
createdBy
createdOn
client
modifiedBy
modifiedOn
state
displayValue
sortOrder

Note Up

id
noteByParentNoteId
account
noteByRootNoteId
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
objectId
objectType
description
noteType
lastReplyDate
date format: date
sendEmail
createdByUser
modifiedByUser
noteCreatorImageUrl
objectName
noOfReplies
createdByUserRoleId
noteUserNames
String comma seperated name's
noteUserIds
String comma seperated id's
noteUserGroups
noteUserGroupIds
String comma seperated id's
attachmentExists

NoteUser Up

id
user
note
usergroup
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

NotificationEvent Up

id
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
name
moduleType
description
subjectFormat
streamMessageFormat
emailPlaintextMessageFormat
emailHtmlMessageFormat
activityLogs
notificationEventScopes

NotificationEventScope Up

id
notificationEvent
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
scope
displayName
notificationPreferences

NotificationMethodName Up

index
String List of notificationMethodNames, index=>count:value:notificationMethodName

NotificationPreference Up

id
user
notificationEventScope
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
notificationMethod
notificationMethodNames

PayRate Up

id
user
createdBy
createdOn
modifiedBy
modifiedOn
effectiveDate
payRate
burden
isSalaried

Permission Up

id
role
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
name
description

Project Up

id
client
project
fieldOptionByProjectStatusId
fieldOptionByProjectCode
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
description
startDate
date format: date
dueDate
date format: date
originalStartDate
date format: date
originalDueDate
date format: date
projectNumber
requestNumber
formattedProjectNumber
formattedRequestNumber
requestStatusId
projectCreateDate
date format: date
requestCreateDate
date format: date
budgetedExpense
Double format: double
budgetedLabor
Double format: double
budgetedRevenue
Double format: double
actualExpense
Double format: double
actualLabor
Double format: double
actualRevenue
Double format: double
projectSecurities
budgetedExpenses
actualExpenses
campaignProjects
projects
projectSummary
reviews
tasks
createdByUser
modifiedByUser
requestStatus
fieldValues
leaf
requesterEmail
requesterClient
requesterTitle
campaignId
campaignName
minStartDateInProject
date format: date
maxDueDateInProject
date format: date
campaignSecurity
tag
user
globalListByBillingStatusId
globalListByBillingTypeId

ProjectFee Up

id
userTaskRoleRate
globalListByStatusId
globalListByEnds
globalListByFeeTypeId
purchaseOrder
project
createdBy
createdOn
date format: date
billDate
date format: date
amount
description
state
recurring
repeatInterval
numOccurences
lastBillDate
date format: date
nextBillDate
date format: date
startDate
date format: date
endDate
date format: date
isCwSynced
purchaseOrder

ProjectFeeHistory Up

id
userTaskRoleRate
account
globalList
project
createdBy
createdOn
date format: date
billDate
date format: date
amount
description
isCwSynced
purchaseOrder
projectFee
invoiceId
invoiceNumber

ProjectFeeSummary Up

fixedResourceAmount
amountRemaining
projectEstimateTotal
previouslyEntered

ProjectForm Up

id
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
formType
customJs
introText
confirmationMessage
sections
formHistories
formStatus
modifiedByUser
formName

ProjectPurchaseOrder Up

id
account
globalList
purchaseOrder
project
createdBy
createdOn
date format: date
sortOrder
endDate
date format: date

PurchaseOrder Up

id
account
client
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
poNumber
state
validFromDate
date format: date
validToDate
date format: date
amount
billingContact
clientSponsor
description
amountIncurred
projectPurchaseOrder

PurchaseOrderChargeHistory Up

objectId
date
Date format: date
chargeType
description
expenseType
resource
project
amount
status

ProjectSecurity Up

id
user
project
usergroup
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
security

ProjectSummary Up

projectId
project
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
numTasks
numTasksOverdue
numTasksBlocking
numTasksBlocked
numApprovalsOverdue
onBudget
isBlocked
numReviews
budgetTotal
Double format: double
actualTotal
Double format: double
isOnSchedule
numTasksCompleted
numTasksInProgress
numTasksNotStarted
totalActualHours
totalEstimatedHours
minStartDateInProject
date format: date
maxDueDateInProject
date format: date
totalActualTime
totalEstimatedTime

RateCard Up

id
account
client
createdBy
createdOn
modifiedBy
modifiedOn
state
title
description
sortOrder

Report Up

id
user
fieldByGroupByFieldId
globalList
fieldBySortByFieldId
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
reportName
description
state
criteria
scheduledFlag
frequency
days
startTime
Double format: double
recipient
emailSubject
emailMessage
objectState
reportFormat
reportColumns
reportConditions
totalFieldIds
String comma seperated Id's
standardFieldIds
String comma seperated Id's
customFieldExists
parentFieldExists
customFieldCount
dashboardMetricReport
dashboardMetricReportType
sortByField
sortDirection
moneyFieldIds
String comma seperated Id's
childObjectState
Integer Applicable for Review and Approval Report(Active:1,Archive:2,Both:3)

ReportColumn Up

id
field
report
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
totalFlag
sortOrder

ReportCondition Up

id
field
globalList
report
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
value

ResourceUtilizationInfoMap Up

allocatedPercentage
Double format: double
weekdate
date format: date

ResourceUtilizationMap Up

accountHolidays
intervalDateDetails
userResourceUtilizationList

Result Up

returnCode
Integer Return Code will be 0 in case of request success, or 1 in case of request failure
messageKey
String Sepecific message key.
detailedMessage
String Detail message.
exception
String Will give exception details in case of request failure
customParams
Object Will return map of custom parameters in case of request success. The parameters will vary with the call. Igrnore if not applicable.
browser
String Browser deatils.
sessionId
String Session Id.
errorMessages
Object Provides map of error messages in case of failure.
success
Boolean Value will be true in case of request success or will be false in case of request failure.

Review Up

id
project
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
reviewName
reviewTypeId
statusId
downloadFlag
startDate
date format: date
endDate
date format: date
emailSubject
emailMessage
showResponsesToAllReviewers
progress
notifyCommentAuthorOnReply
notifyMeOnResponseSubmission
reviewItems
reviewSummary
reviewComments
reviewOwners
reviewAnnotationViewers
reviewUsers
leaf
objectType
reviewSecurity
campaignSecurity
statusString
reviewTypeString
progressString
creatorDisplayName
modifierDisplayName
approvalsString
approvalsWithChangesString
rejectionsString
pendingsString
tag

ReviewAnnotationViewer Up

id
user
reviewMultipage
review
reviewVersion
lastReadTimestamp
date format: date

ReviewComment Up

id
reviewVersion
user
stamp
reviewMultipage
reviewComment
review
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
commentPath
markupTypeId
markupPosition
videoTimestamp
date format: date
commentNumber
comments
approvalType
statusId
lastReplyDate
date format: date
reviewVersionStatuses
reviewComments
additionalAttributes

ReviewGroupUser Up

id
user
reviewUsergroup
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

ReviewItem Up

id
review
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
defaultThumbnailFlag
optionalTitle
sortOrder
reviewVersions
numOfMultipages

ReviewMultipage Up

id
reviewVersion
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
pageNumber
fileName
height
width
size
Long format: int64
pageUrl
reviewComments
reviewAnnotationViewers

ReviewOwner Up

id
user
review
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

ReviewSummary Up

reviewId
review
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
numVersions
isOverdue
isOpen
numApprovals
numApprovalsWithChanges
numRejections
numPending
numReviewers
numComments
numFiles
numCommentsNotStarted
numCommentsInProgress
numCommentsCompleted

ReviewUser Up

id
user
review
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
statusId
state
reviewVersionStatuses
statusString
versionFileName
recentActivity
numOfComments
lastCommentDate
date format: date

ReviewUsergroup Up

id
account
client
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
reviewUsergroupName
description
reviewGroupUsers
users
createdByUser
modifiedByUser

ReviewVersion Up

id
version
reviewItem
file
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
enableAnnotation
annotateEntireWebsiteFlag
multipageStatus
uploadType
description
reviewMultipages
reviewComments
reviewAnnotationViewers
reviewVersionStatuses
approvalsString
approvalsWithChangesString
rejectionsString
pendingsString
numOfComments
numOfUnreadComments
isUnreadForUser
creatorDisplayName
hasResponseAssociated

ReviewVersionStatus Up

id
reviewUser
reviewVersion
reviewComment
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
statusId

ReviewerCommentDetail Up

userImageUrl
userDisplayName
numOfComments
lastCommentDate
date format: date

Role Up

id
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
name
description
announcementRoles
users
permissions
sortOrder

Rule Up

id
formHistory
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
name
state
sortOrder
jsonText
ruleConditions
ruleActions

RuleAction Up

id
field
rule
section
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
actionType
hiddenFlag
emailAddressList
emailSubject
message
sendTeamEmail
valueToSet

RuleCondition Up

id
field
globalList
rule
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
value

RunReport Up

fieldId
String fieldValue
id
objectState
objectSecurity

Section Up

id
form
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
description
helpText
templateFlag
hiddenFlag
displayOrder
ruleActions
sectionFields

SectionField Up

id
field
section
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
displayOrder
requiredFlag
hiddenFlag
helpText
fieldLabel
state
maxLength
fieldSize
defaultValue

Series Up

seriesId
name
coordinates

Stamp Up

id
account
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
labelText
labelColor
labelBackgroundColor
sortOrder

SummaryField Up

id
field
account
formType
selectedFlag
sortOrder

Tag Up

account
id
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
tagValues

TagValue Up

id
tag
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
objectId
objectType

Task Up

id
globalList
project
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
description
estimatedHours
actualHours
startDate
date format: date
startTime
Double format: double
dueDate
date format: date
dueTime
Double format: double
actualStartDate
date format: date
actualEndDate
date format: date
originalStartDate
date format: date
originalDueDate
date format: date
skipWeekendsFlag
skipHolidaysFlag
taskOrderId
taskSummary
timeslips
taskPriorities
taskPredecessorsForTaskId
taskPredecessorsForTaskPredecessorId
users
taskUsers
leaf
objectType
taskSecurity
actualTime
Double format: double
estimatedTime
Double format: double
taskPredecessorNames
modifiedByUser
taskRole
tag
useTaskRate
taskRate

TaskDetailsList Up

projectNumber
taskDescription
taskDueDate
date format: date
taskActualHours
taskStartDate
date format: date
projectStartDate
date format: date
taskName
taskEstimatedHours
projectName
projectId
taskId
taskStatus
taskHoursDetails

TaskHoursDetail Up

userRoleId
userName
userId

TaskPredecessor Up

id
taskByTaskId
taskByTaskPredecessorId
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

TaskPriority Up

id
user
todo
task
workType
sortOrder

TaskRole Up

id
account
client
createdBy
createdOn
modifiedBy
modifiedOn
state
displayValue
sortOrder

TaskSummary Up

taskId
task
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
isBlocking
isBlocked
isOverdue
actualLabourExpense
Double format: double
progress

TaskUser Up

id
user
task
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

TimeTaskList Up

taskId
taskName
projectName
projectNumber
isNonProjectTask

Timesheet Up

id
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
weekEndDate
date format: date
isTimesheetOpen
globalList
weekStartDate
date format: date
totalHours
overdueAnnouncement

TimesheetApprovers Up

id
globalList
userByAlternateApproverId
userByApproverId
timesheet

TimesheetStatusHistory Up

id
globalList
user
timesheet
performedOn
date format: date
comments

Timeslip Up

id
user
task
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
timeslipDate
date format: date
hours
isCwSynced
state
billRate
payRate
billAmount
payAmount
burdendPayAmount
globalList
timesheets
sourceBillRate
invoiceId
invoiceNumber

TimeslipNonprj Up

id
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
timeslipDate
date format: date
hours
nonProjectTask
globalList
timesheet
billRate
payRate
state
isCwSynced
billAmount
payAmount
burdendPayAmount
sourceBillRate
invoiceId
invoiceNumber

Todo Up

id
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
title
description
markAsComplete
dueDate
date format: date
taskPriorities
tag

UnreadObjectCount Up

2
Integer 2=>objectTypeRequest:value=>unreadRequest
3
Integer 3=>objectTypeProject:value=>unreadProject
6
Integer 6=>objectTypeCampaign:value=>unreadCampaign
9
Integer 9=>objectTypeTask:value=>unreadTask
10
Integer 10=>objectTypeReview:value=>unreadReview

User Up

id
fileByStandardAvatarFileId
account
fileByCustomAvatarFileId
role
task
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
firstName
lastName
emailAddress
password
title
timezone
dateFormat
workPhone
mobilePhone
homePhone
defaultReviewEmailMessage
pwdModifiedOn
date format: date
lastLogin
date format: date
avatarPosition
taskTimerStartTime
date format: date
taskCurrentlyWorkingMinutes
taskUsers
timeslipNonprjs
campaignSecurities
timesheets
reviewGroupUsers
tags
reports
noteUsers
taskPriorities
userFavorites
reviewUsers
changeTrackings
dashboardPreferences
notificationPreferences
reviewComments
userPermissions
reviewOwners
timeslips
fileActivityLogs
fileExternalLink
groupUsers
reviewAnnotationViewers
folderSecurities
todos
activityUsers
projectSecurities
itemLastReads
userHolidaies
announcementUsers
userImageUrl
userDisplayName
userSummary
userTypeAheadDisplayName
displayTimeZone
modifiedByUser
projectSummaryMetricConfig
campaignSummaryMetricConfig
projectSummaryMetricConfigList
campaignSummaryMetricConfigList
apiKey
userClient
resourceManager
cwUser
user
timesheetApprover
userByAlternateTimesheetApprover
userByAlternateResourceApprover
userByResourceManagerId

UserClient Up

id
user
client
createdOn
createdBy

UserEmailMap Up

EmailDate
date format: date
From
Timestamp
Double format: double
Subject
PlainTextMessage
To
MessageId

UserFavority Up

id
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
objectId
objectType
parentObjectId
parentObjectType
sortOrder
objectName
parentObjectName

UserGroup Up

id
account
client
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
state
name
description
users
createdByUser
modifiedByUser

UserHoliday Up

id
user
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
startDate
date format: date
endDate
date format: date
description

UserPermission Up

id
user
permission
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date

UserResourceUtilizationList Up

userImageUrl
userTimeOffDateSet
percentUtilization
Double format: double
taskDetailsList

UserSummary Up

numActiveProjects
numArchivedProjects
numBlockedProjects
numOverBudgetProjects
numBehindScheduleProjects
numActiveCampaigns
numArchivedCampaigns
numBlockedCampaigns
numOverBudgetCampaigns
numOpenTasks
numOverdueTasks
numBlockingTasks
numBlockedTasks
numUpcomingTasks
numOpenApprovals
numOverdueApprovals
numRequestSubmitted
numRequestApproved
numRequestDenied
numRequestUpdateRequired
numProjectByStatus
Object Map of number of projects for perticular status. The map contains status name as key and number of projects for that status as number.
numOpenFeedbacks
numOverdueFeedbacks

UserTaskRole Up

id
user
taskRole
createdBy
createdOn

UserTaskRoleRate Up

id
user
taskRole
createdBy
createdOn
modifiedBy
modifiedOn
rate
effectiveDate

ClientOption Up

id
fieldOption
client
createdBy
createdOn
sortOrder

Estimate Up

id
account
client
project
createdBy
createdOn
modifiedBy
modifiedOn
state
description
assumptions
goals
approach
internalNotes
totalTax
total
estimateDate
approvalTimestamp
approvedBy
globalList
approvedOn
approvalCcList
approvalComment

RateInfo Up

currentUserRate
oldUserRateList
futureUserRateList

MonthlyAccountSummary Up

id
account
monthOf
projectsCreated
requestsCreated
tasksCreated
avgProjectDuration
avgTaskDuration
avgProjectDuration
avgTaskDuration
avgReqApprovalDuration
avgProjectStartShift
avgProjectDueShift
avgBudgetVariance
avgActiveDuration
avgTaskStartShift
avgTaskDueShift
avgTaskStartSlip
avgTaskDueSlip
avgTaskHoursVariance

QuarterlyAccountSummary Up

id
account
quarterOf
projectsCreated
requestsCreated
tasksCreated
avgProjectDuration
avgTaskDuration
avgProjectDuration
avgTaskDuration
avgReqApprovalDuration
avgProjectStartShift
avgProjectDueShift
avgBudgetVariance
avgActiveDuration
avgTaskStartShift
avgTaskDueShift
avgTaskStartSlip
avgTaskDueSlip
avgTaskHoursVariance

UserCapacity Up

id
user
createdBy
createdOn
modifiedBy
modifiedOn
state
monday
tuesday
wednesday
thursday
friday
saturday
sunday

UserTaskRoleAllocation Up

id
user
userTaskRole
createdBy
createdOn
modifiedBy
modifiedOn
state
effectiveDate
percentAllocation

UserTaskRoleAllocationHistory Up

weekDate
userTaskRoleAllocation

TaskGroup Up

id
account
client
createdBy
createdOn
modifiedBy
modifiedOn
state
value
sortOrder

UserFilter Up

id
account
createdBy
createdOn
userId
listType
objectType
parentObjectType
isFavorite
filterName
filterColor

Survey Up

id
account
createdBy
createdOn
modifiedBy
modifiedOn
projectId
comment
urlExpiryTime
surveyRecipients
surveyResponses
surveyFiles

SurveyRecipient Up

id
account
Survey
surveyResponses
userByUserId
userByLastSentBy
recipientEmail
surveyUrl
sentStatus
lastSentOn
recipientUserEmail

SurveyResponse Up

id
surveyRecipient
Survey
createdOn
modifiedOn
rating
firstName
lastName
comment

Portfolio Up

id
account
file
title
logoFileId
portfolioSummary
displayTeamFlag
styleAttribute
createdBy
createdOn
modifiedBy
modifiedOn
state
useReviewFileFlag
readyFlag
portfolioProjectMetrics
portfolioProjects
portfolioSummaryMetrics
portfolioRecipients
portfolioProjectFields

PortfolioProjectMetric Up

id
portfolio
account
field

PortfolioProject Up

id
portfolio
account
project
slideFlag
sortOrder

PortfolioSummaryMetric Up

id
portfolio
account
portfolioMetricGlobal
summaryMetricValue

PortfolioMetricGlobal Up

id
globalList
portfolioSummaryMetrics

PortfolioRecipient Up

id
portfolio
account
user
recipientEmail
state
status
expiryType
scheduledDate
expiryDate
scheduledTime
scheduledFlag
portfolioUrl
emailSubject
emailMessage
sentOn
createdOn

PortfolioProjectField Up

id
portfolio
account
field

FinalDeliverableProjectFile Up

id
project
file
finalDeliverableFile

FinalDeliverableFile Up

id
account
project
file
processType
width
height

ProjectItem Up

projectId
projectName
formattedProjectNumber
objectId
objectType
objectName
objectStartDate
objectDueDate
campaignId

ScheduleGanttVO Up

result
mask
Object Column mask map.
columnList
List Output column list
ganttDetails
Object Project Details

UserCalendarResponse Up

review
task
userHoliday
accountHoliday
calendarBarText
objectType

UserGanttDetails Up

id
user
children
startDate
endDate
leaf

NoteThread Up

id
noteByLastThreadNoteId
account
noteByRootNoteId
createdBy
createdOn
modifiedBy
modifiedOn
state
subject
objectId
objectType
rootObjectId
rootObjectType
threadType
threadNoteCount
lastNoteUserId
lastNoteText
lastThreadActivityOn

NoteThreadUser Up

id
user
noteThread
account
usergroup
createdBy
createdOn

ReviewUser Up

id
user
review
reviewStage
createdBy
createdOn
date format: date
modifiedBy
modifiedOn
date format: date
statusId
state
reviewVersionStatuses

PdfLayerDetail Up

id
versionId
fileName
url
value