Application - com.hornbill.projectmanager
Entities
The following entities are defined for this applicationAccountStatus
There are no operations or events defined for the 'AccountStatus' entity.
Achievement
The following operations are defined for the 'Achievement' entity.
| Operation | Description |
|---|---|
| addAchievement | For internal use only - This flowcode operation awards an achievement to the specified user. |
AchievementImage
There are no operations or events defined for the 'AchievementImage' entity.
Bookmark
There are no operations or events defined for the 'Bookmark' entity.
BookmarkCategory
There are no operations or events defined for the 'BookmarkCategory' entity.
BookmarkHistory
There are no operations or events defined for the 'BookmarkHistory' entity.
Contact
The following operations are defined for the 'Contact' entity.
| Operation | Description |
|---|---|
| GetContainerId | Get the container id (Organisation) for the specified contact. |
| addContact | DEPRECATED (use addContactNew) |
| addContactNew | For internal use only - Add a New Contact |
| archiveContact | For internal use only - This flowcode is responsible for accepting one or more contactIds and changing their status from active to archived |
| changeOrg | For internal use only - Change the Contact's Organisation |
| guestUpdateProfile | This flowcode allows an authorised guest to update only there own contact record |
| removeOrg | For internal use only - Remove the Contact's Organisation |
| sendSystemNotification | Send notification to user |
| unarchiveContact | Updates the status of teh contact to be Active. Note that if the contact had access to the portal, this will not enable back to that state. |
| updateContact | DEPRECATED (Use updateContactNew) |
| updateContact3 | For internal use only - Update Contact |
| updateContactNew | DEPRECATED - Use updateContact3 or changeOrg instead - For internal use only - Update Contact |
Contact_extra
There are no operations or events defined for the 'Contact_extra' entity.
Contact_notes
There are no operations or events defined for the 'Contact_notes' entity.
ContactAccess
There are no operations or events defined for the 'ContactAccess' entity.
Container
The following operations are defined for the 'Container' entity.
| Operation | Description |
|---|---|
| addChild | For internal use only |
| addContainer | This is the description text for this flowcode operation |
| getChildren | This is the description text for this flowcode operation |
| getChildrenCount | This is the description text for this flowcode operation |
| getContainer | For internal use only |
| getRelatedContainers | This is the description text for this flowcode operation |
| removeChild | This is the description text for this flowcode operation |
| removeContainer | This is the description text for this flowcode operation |
| removePermission | This is the description text for this flowcode operation |
| setPermission | This is the description text for this flowcode operation |
| updateContainer | This is the description text for this flowcode operation |
ContainerPermissions
There are no operations or events defined for the 'ContainerPermissions' entity.
ContainerType
There are no operations or events defined for the 'ContainerType' entity.
Country
There are no operations or events defined for the 'Country' entity.
CustomList
There are no operations or events defined for the 'CustomList' entity.
EntityAttachments
The following operations are defined for the 'EntityAttachments' entity.
| Operation | Description |
|---|---|
| attachFile | Attach a file to the EntityAttachments |
| removeAttachment | Remove an attachment from the case |
| updateDescription | Update description of attachments |
Favorite
There are no operations or events defined for the 'Favorite' entity.
Groups
There are no operations or events defined for the 'Groups' entity.
Location
There are no operations or events defined for the 'Location' entity.
MessageClientTemplate
The following operations are defined for the 'MessageClientTemplate' entity.
| Operation | Description |
|---|---|
| add | Add Template |
| delete | Delete a template includding shared records |
| get | Returns a template based on an ID |
| update | Update Template |
MessageClientTemplateShare
The following operations are defined for the 'MessageClientTemplateShare' entity.
| Operation | Description |
|---|---|
| add | Add Shares to the template |
| addOrUpdate | Adds or Updates a sharing to a template. This asumes the sharing is one only for each template. Will replace if exists and if is "personal" it will remove the sharing record |
OrganizationContacts
There are no operations or events defined for the 'OrganizationContacts' entity.
Organizations
The following operations are defined for the 'Organizations' entity.
| Operation | Description |
|---|---|
| addToTimeline | Add to Org Timeline |
| archive | For internal use only - Archive an Organisation. If it has an activity stream, will post to the timeline. |
| unArchive | For internal use only - UnArchive an Organisation. If it has an activity stream, will post to the timeline. |
ProCapCustomQuestion
The following operations are defined for the 'ProCapCustomQuestion' entity.
| Operation | Description |
|---|---|
| add_json | Add progressive capture custom questions with answers |
ProfileConnections
There are no operations or events defined for the 'ProfileConnections' entity.
ProfileContacts
There are no operations or events defined for the 'ProfileContacts' entity.
ProfileContactTypes
There are no operations or events defined for the 'ProfileContactTypes' entity.
Profiles
There are no operations or events defined for the 'Profiles' entity.
ProfileStatus
There are no operations or events defined for the 'ProfileStatus' entity.
ProjectAttachments
The following operations are defined for the 'ProjectAttachments' entity.
| Operation | Description |
|---|---|
| addAttachment | This flowcode operation adds a new project attachment. |
| deleteAttachment | This flowcode operation deletes an existing project attachment. |
| getAttachments | This flowcode operation gets details of all attachments for the project provided. |
ProjectAuditHistory
The following operations are defined for the 'ProjectAuditHistory' entity.
| Operation | Description |
|---|---|
| addAuditHistory | This flowcode operation creates a new audit history entry for the specified project. |
| getAuditHistory | This flowcode operation gets details of all audit history entries for the project provided. |
| getAuditHistoryDetails | This flowcode operation gets details of the specified project audit history record. |
ProjectCosts
The following operations are defined for the 'ProjectCosts' entity.
| Operation | Description |
|---|---|
| addProjectCost | This flowcode operation creates a new project cost for the specified project. |
| deleteProjectCost | This flowcode operation deletes an existing project cost. |
| getProjectCost | This flowcode operation gets details of the specified project cost. |
| getProjectCosts | This flowcode operation gets details of all project costs for the project provided. |
| getProjectCostsChart | This flowcode operation gets details of all project costs for the project provided. |
| updateProjectCost | This flowcode operation updates the specified project cost. |
ProjectDocuments
The following operations are defined for the 'ProjectDocuments' entity.
| Operation | Description |
|---|---|
| addDocument | This flowcode operation creates a new project document for the specified project. |
| deleteDocument | This flowcode operation deletes an existing project document. |
| getDocuments | This flowcode operation gets details of all documents for the project provided. |
ProjectMembers
The following operations are defined for the 'ProjectMembers' entity.
| Operation | Description |
|---|---|
| addProjectMember | This flowcode operation creates a new project member for the specified project. |
| deleteProjectMember | This flowcode operation deletes an existing project member. |
| getProjectMembers | This flowcode operation gets details of all project members for the project provided. |
| updateProjectMember | This flowcode operation updates the existing specified project member. |
ProjectMilestones
The following operations are defined for the 'ProjectMilestones' entity.
| Operation | Description |
|---|---|
| addProjectMilestone | This flowcode operation creates a new project milestone for the specified project. |
| calculateProjectMilestoneProgress | This flowcode operation calculates the progress of the specified project milestone based on the project tasks that contribute towards it. |
| decreaseProjectMilestoneOrder | This flowcode operation increases the order of the specified project milestone by 1. |
| deleteProjectMilestone | This flowcode operation deletes an existing project milestone. |
| getProjectMilestone | This flowcode operation gets details of the specified project milestone. |
| getProjectMilestones | This flowcode operation gets details of all project milestones for the project provided. |
| increaseProjectMilestoneOrder | This flowcode operation increases the order of the specified project milestone by 1. |
| updateProjectMilestone | This flowcode operation updates the specified project milestone. |
ProjectProgress
The following operations are defined for the 'ProjectProgress' entity.
| Operation | Description |
|---|---|
| getProjectProgress | This flowcode operation gets the project progress details. |
ProjectProgressCheckpoints
There are no operations or events defined for the 'ProjectProgressCheckpoints' entity.
ProjectProgressCheckpointTypes
There are no operations or events defined for the 'ProjectProgressCheckpointTypes' entity.
ProjectProgressStages
There are no operations or events defined for the 'ProjectProgressStages' entity.
ProjectRelationships
The following operations are defined for the 'ProjectRelationships' entity.
| Operation | Description |
|---|---|
| addProjectRelationship | This flowcode operation creates a new project relationship for the specified project. |
| deleteProjectRelationship | This flowcode operation deletes an existing project relationship. |
| getProjectRelationship | This flowcode operation gets details of the specified project relationship. |
| getProjectRelationships | This flowcode operation gets details of all project relationships that match the search criteria provided. |
| updateProjectRelationship | This flowcode operation updates the specified project relationship. |
ProjectResources
The following operations are defined for the 'ProjectResources' entity.
| Operation | Description |
|---|---|
| addProjectResource | This flowcode operation creates a new project resource for the specified project. |
| calculateProjectResourceTasksTotal | This flowcode operation calculates the total time recorded for all project resource tasks for the specified project. |
| deleteProjectResource | This flowcode operation deletes an existing project resource. It is only possible to delete a project resource if you are the project manager of the project. |
| getProjectResource | This flowcode operation gets details of the specified project resource. |
| getProjectResources | This flowcode operation gets details of all project resources that match the search criteria provided. |
| getProjectResourcesCalendar | This flowcode operation gets details of all project resources that match the search criteria provided for display in the resources calendar. |
| updateProjectResource | This flowcode operation updates the specified project resource. |
ProjectResourceTasks
The following operations are defined for the 'ProjectResourceTasks' entity.
| Operation | Description |
|---|---|
| addProjectResourceTask | This flowcode operation creates a new project resource task for the specified project resource. |
| getProjectResourceTasksForProjectTask | This flowcode operation gets details of all project resources tasks for the specified project task that match the search criteria provided. |
ProjectRiskMatrix
The following operations are defined for the 'ProjectRiskMatrix' entity.
| Operation | Description |
|---|---|
| addProjectRiskMatrixEntry | This flowcode operation creates a new project risk matrix entry. |
| deleteAllProjectRiskMatrixEntries | This flowcode operation deletes all existing project risk matrix entries. |
| deleteProjectRiskMatrixEntry | This flowcode operation deletes an existing project risk matrix entry. |
| getProjectRiskMatrix | This flowcode operation gets details of all project risk matrix entries based on the search criteria provided. |
| getProjectRiskMatrixWeighting | This flowcode operation gets the project risk matrix weighitng based on the impact and probability values provided. |
| updateProjectRiskMatrixEntry | This flowcode operation updates the specified project risk matrix entry. |
ProjectRisks
The following operations are defined for the 'ProjectRisks' entity.
| Operation | Description |
|---|---|
| addProjectRisk | This flowcode operation creates a new project risk for the specified project. |
| deleteProjectRisk | This flowcode operation deletes an existing project risk. |
| getMyProjectRisks | This flowcode operation gets details of all project risks for the project user and all of their projects based on the search criteria provided. |
| getProjectRisk | This flowcode operation gets details of the specified project risk. |
| getProjectRisks | This flowcode operation gets details of all project risks for the project provided. |
| getProjectRisksChart | This flowcode operation gets details of all project risks for the project provided. |
| updateProjectRisk | This flowcode operation updates the specified project risk. |
Projects
The following operations are defined for the 'Projects' entity.
| Operation | Description |
|---|---|
| addProject | This flowcode operation creates a new project. |
| getProject | This flowcode operation gets details of the specified project. |
| getProjectVisibility | This flowcode operation returns the user's level of visibility for the specified project. |
| getProjects | This flowcode operation gets details of all projects that match the search criteria provided. |
| getRelatedEntityCounts | This flowcode operation gets counts of all related entities to the main projects entity. For example the number of risks and costs associated to the specified project. |
| resumeProject | This flowcode operation resumes the business process of the specified project. |
| updateProject | This flowcode operation updates an existing project. |
The following BPM operations are defined for the 'Projects' entity.
| Operation | Description |
|---|---|
| suspendProject | This flowcode operation suspends the business process that is associated to the speciifed project. |
| suspendProject2 | This flowcode operation suspends the business process that is associated to the speciifed project. |
The following events are defined for the 'Projects' entity.
| Event | Description |
|---|---|
| OnAllowTaskActionOverride | Entity system event handler for OnAllowTaskActionOverride. This flowcode operation allows a project manager to action or complete the specified task |
ProjectTasks
The following operations are defined for the 'ProjectTasks' entity.
| Operation | Description |
|---|---|
| addProjectTask | This flowcode operation creates a new project task for the specified project. |
| completeProjectTask | This flowcode operation completes the specified project task. |
| deleteProjectTask | This flowcode operation deletes an existing project task. It is only possible to delete a project task if you are the project manager of the project or the project task owner. |
| getActiveProjectTasks | This flowcode operation gets details of all active project tasks that match the search criteria provided. |
| getProjectTaskDependencies | This flowcode operation gets details of all task dependencies for the specified project task. |
| getProjectTasks | This flowcode operation gets details of all project tasks that match the search criteria provided. |
| getProjectTasksCalendar | This flowcode operation gets details of all project tasks that match the search criteria provided for display in the tasks calendar. |
| updateProjectTask | This flowcode operation updates the specified project task. |
ProjectTemplates
The following operations are defined for the 'ProjectTemplates' entity.
| Operation | Description |
|---|---|
| addProjectTemplate | This flowcode operation creates a new project template. |
| deleteAllProjectTemplates | This flowcode operation deletes all existing project templates. |
| deleteProjectTemplate | This flowcode operation deletes an existing project template. |
| getBusinessProcesses | This flowcode operation gets details of all active business processes for the Hornbill Project Manager application. |
| getProjectTemplates | This flowcode operation gets details of all project templates. |
| updateProjectTemplate | This flowcode operation updates the specified project template. |
ProjectTypes
The following operations are defined for the 'ProjectTypes' entity.
| Operation | Description |
|---|---|
| addProjectType | This flowcode operation creates a new project type. |
| deleteAllProjectTypes | This flowcode operation deletes all existing project types. |
| deleteProjectType | This flowcode operation deletes an existing project type. |
| getBusinessProcesses | This flowcode operation gets details of all active business processes for the Hornbill Project Manager application. |
| getProjectTypes | This flowcode operation gets details of all project types. |
| updateProjectType | This flowcode operation updates the specified project type. |
RelatedContainer
There are no operations or events defined for the 'RelatedContainer' entity.
Roles
There are no operations or events defined for the 'Roles' entity.
Site
There are no operations or events defined for the 'Site' entity.
Task
The following operations are defined for the 'Task' entity.
| Operation | Description |
|---|---|
| AttachFile | For internal use only - Attach a file to the task entity |
| deleteTask | For internal use only - Delete a task |
| getEntityTasks | Return tasks assigned to specific entity |
| getNewTasks | For internal use only - Load tasks from notifications |
| removeFile | For internal use only - Remove an attached file |
Task_categories
There are no operations or events defined for the 'Task_categories' entity.
Task_notes
There are no operations or events defined for the 'Task_notes' entity.
TaskBoard
The following operations are defined for the 'TaskBoard' entity.
| Operation | Description |
|---|---|
| addBoard | For internal use only - Create new board |
| addDefaultBoard | For internal use only - Adding default board and defining task lists |
| getBoard | For internal use only - Read board data |
| getBoardTasks | For internal use only - Flowcode return specified board lists with tasks |
| queryBoards | For internal use only - return boards belonging to user (query is taking user from session) |
| updateBoard | For internal use only - Update board data |
TaskBoardList
The following operations are defined for the 'TaskBoardList' entity.
| Operation | Description |
|---|---|
| addBoardList | For internal use only - adding new list to board |
| deleteBoardList | For internal use only - Delete specified list |
| filterBoardListTasks | For internal use only - return filtered tasks, for more secure searching (only tasks that user can see) to filtered data are added from session user id and roles |
| getBoardList | For internal use only - Return single list row |
| getBoardListTasks | For internal use only - Return list tasks that are assigned manually |
| getListTasks | For internal use only - Loading tasks one by one for all specified input id, checking every list for type (filter or manual) and calling specific query depends on it. At end return json stringified array of lists with tasks. |
| queryBoardLists | For internal use only - return lists belonging to user |
| updateBoardList | For internal use only - Updating board list record |
| updateListPositions | For internal use only - Updating lists position in order of appear in array |
TaskBoardListTask
There are no operations or events defined for the 'TaskBoardListTask' entity.
UserAccount
The following operations are defined for the 'UserAccount' entity.
| Operation | Description |
|---|---|
| getTeams | Flowcode Operation using the supplied Customer User Id to retrieve the user's Container Id and Customer Name |
UserEntityList
There are no operations or events defined for the 'UserEntityList' entity.
Operations
The following general operations are defined for the 'com.hornbill.projectmanager' application. You can click on each operation to see detailed information about that operation.
| Method | Source | Description |
|---|---|---|
| addEveryoneToRole | global | For internal use only - Add all users to the specified role |
| addEveryoneToWorkspace | global | For internal use only - Add all users to the specified workspace |
| addHistory | global | For internal use only - Add a historic bookmark for the page visited |
| addMembersToWorkspace | global | For internal use only - Add users, groups or members to a specified workspace |
| adminInitaliseData | global | Used by the Admin App to get all the initial data need on first lost. |
| coreInitaliseData | global | For internal use only - Used by the Core Web App to get all the initial data need on first lost. |
| getCoWokers | global | DEPRECATED - please use getCoworkersList |
| getCoWokersList | global | DEPRECATED - Please use getCoWorkersList |
| getCoWorkers | global | DEPRECATED - please use getCoworker |
| getCoWorkersList | global | For internal use only - Get a list of Co-workers |
| getContacts | global | DEPRECATED - use get contactsList |
| getContactsList | global | For internal use only - Get a list of contacts |
| getContactsList4 | global | For internal use only - Get a list of contacts |
| getContactsListByOrgFilter | global | For internal use only - Get filtered and paged list of organisations |
| getEmailList | global | DEPRECATED - For internal use only - Used to get email list (Paged) and count of emails. |
| getEmailList2 | global | For internal use only - Used to get email list (Paged) and count of emails |
| getEmailUnreadCounter | global | For internal use only - Returns the unread email counter for all shared mailboxed bellonging to the logged in user |
| getOrganisations | global | DEPRECATED - use getOrganisationList |
| getOrganisationsList | global | For internal use only - Get filtered and paged list of organisations |
| getSitesList | global | Get a list of Sites |
| getUnreadCountersForPosts | global | DEPRECATED - For internal use only - Get unread counters for a list of activity Id |
| getUserBasicNotificationConfig | global | For internal use only - Returns user event configuration |
| getUserGuestRecord | global | This operation returns a customer's details, depending on whether they are a co-worker or a contact. |
| getUserMemberships | global | Returns the List of My Roles and Groups as URNs includding the same user URN |
| getUsersIManage | global | For internal use only - Returns the List of Users I manage based on Groups |
| guestInitaliseData | global | Used by the Guest App to get all the initial data need on first lost. |
| postToTimeline | global | Make safe post to social object timeline, checking if user is following, if not doing it for him and unfollow. |
| resumeBpmInstance | local | This flowcode operation attempts to resume a business process instance if it is currently paused. |
| sendMessage | global | Send message to specific urn array |
| shrGetTimestamp | global | This flowcode returns a new calculated timestamp value based on the input parameters provided. |
| updateActivityStream | global | For internal use only - Unified access to the following APIs PostImage AcitvityPostImage ActivityPostMessage PostMessage |
| userUpdateProfile | global | Used by the Service Portal to update a basic user / users profile |
The following general BPM operations are defined for the 'com.hornbill.projectmanager' application. You can click on each operation to see detailed information about that operation.
| Method | Source | Description |
|---|
The following general Auto Responder (AR) operations are defined for the 'com.hornbill.projectmanager' application. You can click on each operation to see detailed information about that operation.
| Method | Source | Description |
|---|
The following general events are defined for the 'com.hornbill.projectmanager' application. You can click on each event to see detailed information about that event.
| Event | Source | Description |
|---|---|---|
| OnDevAppInstall | local | This flowcode operation adds any default data when the new application is installed |
| OnDevAppUpdate | local | This flowcode operation adds any default data when the new application is updated |