API / MCP server
Connect resource planning to the systems and AI tools you already use. Retrieve information, build your own reports and perform supported actions with controlled access.
Retrieve structured JSON data for reporting, integrations and your own workflows. Supported write operations can create and update information in RessursAgent.
Model Context Protocol lets a compatible AI client use RessursAgent as a tool. Ask about your organisation's data and request supported actions using your account and permissions.
See what your systems and AI tools can read, create and change in RessursAgent. This overview covers core objects and a selection of fields supported by REST API and MCP.
Field names are the actual names in the data model. Write fields apply to creation, updates or a specific action; not all can be changed after creation. Projects and resources are usually linked by an ID.
People, equipment, contact details, positions, disciplines, project periods, customers and locations.
nameresource_typeownershipis_activedisciplinepositiondepartmentemailphoneequipment_typeequipment_modelsupplierwork_base_addressexternal_idnameresource_typeownershipis_activedisciplinepositiondepartmentemailphoneequipment_typeequipment_modelsupplieremployed_fromemployed_untilwork_base_addressexternal_idnotenameproject_numberstatusstart_dateend_datecustomer_namelocation_addressproject_typeis_templatenameproject_numberstatusstart_dateend_datecustomer_namelocation_addresslocation_postal_codeexternal_idworklist_codenoteproject_typeis_templateresource_idcard_idexpires_atcard_numberexpires_atThe card number is not returned. Registration requires a signed-in user with specific HSE access. The expiry date can be renewed separately.
Assignments, allocation, resource requests, unavailability and calculated capacity per resource and day.
project_idresource_idstart_dateend_dateallocation_percentactivity_idproject_positionwork_schedule_template_idproject_idresource_idstart_dateend_dateallocation_percentwork_schedule_template_idwork_schedule_anchor_dateproject_idresource_typestatusquantitystart_dateend_dateallocation_percentpositionequipment_modelactivity_idproject_idresource_typequantitystart_dateend_dateallocation_percentdisciplinepositionequipment_typeequipment_modelwork_schedule_template_idRequests can also be submitted, rejected, cancelled and fulfilled through specific actions.
resource_idstart_dateend_datereasonunavailable_percentresource_idstart_dateend_datereasonunavailable_percentresource_idcapacity_datescheduled_hoursscheduled_capacity_percentunavailable_percenteffective_capacity_percentThese are calculated results available for reading. Influence them by changing inputs such as assignments, periods, locations and competencies.
Competency catalogue, recorded qualifications and validity, project requirements, shift templates and daily exceptions.
namecodecategorydescriptionrequires_expirysource_systemnamecodecategorydescriptionis_hms_cardrequires_expiryresource_idcompetency_idlevelvalid_fromvalid_untildocumentation_statussource_systemresource_idcompetency_idlevelvalid_fromvalid_untilcertificate_numbercommentdocumentation_confirmedQualifications owned by an external source system must be updated there. Certificate numbers and comments can be recorded but are not returned in this read object.
scopeentity_idcompetency_idis_mandatoryresource_typevalid_fromscopeentity_idcompetency_idis_mandatoryresource_typevalid_fromcommentnameworkday_patternhours_patternstandard_hours_per_workdaystart_weekdayproject_scopeis_activeis_night_shiftnamedescriptionworkday_patternhours_patternstandard_hours_per_workdaystart_weekdayproject_scopeproject_idsis_activeis_night_shiftresource_idexception_dateexception_typeplanned_hoursresource_idexception_dateexception_typeplanned_hourscommentcompetency_idplansresource_idsplanned_onPlanning teams, project teams and members, activities and project roles. REST API and MCP can also retrieve geographic clusters, collaboration pairs and calculated swap suggestions.
nameleader_resource_idend_datearchived_atnameleader_resource_idend_datecompetency_idsproject_idnamenotework_schedule_template_idplanned_start_dateplanned_end_dateproject_idnamenotework_schedule_template_idplanned_start_dateplanned_end_dateproject_team_idresource_idis_leadproject_team_idresource_idis_leadproject_idnamecodeparent_idsort_orderlead_resource_idplanned_start_dateplanned_end_dateproject_idnamedescriptioncodenotelead_resource_idplanned_start_dateplanned_end_dateparent_idpositionproject_idresource_idroleresponsibilityeffective_fromeffective_untilproject_idresource_idroleresponsibilityeffective_fromeffective_untilnameproject_idstart_dateend_datenotemembersnameproject_idstart_dateend_datenotemembersaxisradius_kmresource_categoryproject_countresource_countspan_kmprojectsmembersThese are calculated results available for reading. Influence them by changing inputs such as assignments, periods, locations and competencies.
resource_idpartner_idstrengthoverlap_daysshared_project_counthas_operator_linkhas_shared_project_teamThese are calculated results available for reading. Influence them by changing inputs such as assignments, periods, locations and competencies.
typescorestart_dateend_dateproject_idsincoming_resource_idsoutgoing_resource_idstravel_saving_kmown_production_gainmanual_planning_requiredThese are calculated results available for reading. Influence them by changing inputs such as assignments, periods, locations and competencies.
Bids with status, probability and requirements. Tags, positions, trades, equipment types and models, suppliers and equipment bases.
namecustomer_namestatuswin_probabilitystart_dateend_dateestimated_valuecurrency_codesimulation_inclusionnamecustomer_namestatuswin_probabilitystart_dateend_dateestimated_valuecurrency_coderequirementssimulation_inclusionBid requirements contain category, catalogue reference, quantity and period (category, catalog_item_id, quantity, start_date, end_date). Status and simulation inclusion use specific actions.
bid_opportunity_idresource_idresponsibilitybid_opportunity_idresource_idresponsibilitynamenameTags can also be attached to or removed from projects, resources and resource requests.
namenamenamepostal_codenamepostal_codekindhire_day_ratehire_currency_codehire_day_ratehire_currency_codeNotifications, notification events, comments and a limited extract of the audit log. Access to the relevant data domains is required.
notification_event_idrecipient_resource_idstatusread_atdismissed_atscheduled_forevent_typeentity_typeentity_idproject_idseveritytitlemessageoccurred_atentity_typeentity_idactionmessageactor_display_namesourcecreated_atentity_typeentity_idcommentapplies_fromapplies_untilversionentity_typeentity_idcommentapplies_fromapplies_untilexpected_versionProfile users can retrieve their own plan, competencies and changes through personal API/MCP access. The connection follows the signed-in user and requires a linked person resource.
namedisciplinepositionphoneemailsupplieremployed_fromReads the signed-in employee’s own information and requires a linked person resource.
projectNamestartDateendDateactivityNameprojectPositionmeetingPointmanagerNamemanagerPhoneallocationPercentmachineNamesscheduleReads the signed-in employee’s own information and requires a linked person resource.
registergapsmetcompetencyNamestatuslevelvalidFromvalidUntilReads the signed-in employee’s own information and requires a linked person resource.
resource_idchangesReads the signed-in employee’s own information and requires a linked person resource.
Examples / API workflows
Create people or equipment and update contact details, department, discipline and external references.
Update project periods and customer details. Create requests and adjust assignment dates, allocation and shift templates.
Combine capacity, competencies, clusters and bids in your reports. Read calculated results to support decisions.
Examples / questions for an AI client
Which resource requests are open next week?
Show next week's capacity and find resources with valid machine operator qualifications.
Create a resource request for the project with the position, period and allocation we agreed.
These examples suggest uses; no actions have been performed. Results depend on recorded data, your client and your access. Review proposed changes before asking the client to apply them.
Reading and editing depend on the organisation, user role and access granted. Available actions also depend on the object’s status and the application’s validation rules.
Capacity, clusters and optimisation suggestions are calculated from recorded data. Results are not written directly.
Notifications and log events can be read. Comments are separate editable objects. My page shows the relevant employee’s data.
Tell us which data and workflows you need. We will help clarify access, connections and supported actions.