Read master data record
rillsoft_resource_pool_resource_getRetrieve complete master data for one resource pool object by type and ID, covering person roles, employment, calendar, absences, shifts, or team and customer details.
Instructions
Reads the complete master data of one object: a person with their identity, all their roles (efficiency, hourly rate), employment period, calendar, absences and shift cycles; a team with calendar, productivity and members; a customer with postal address and contact. Read-only, no undo step.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | id from rillsoft_resource_pool_catalog_list | |
| to | No | finish of the period, DD.MM.YYYY hh:mm; defaults to the project finish | |
| from | No | begin of the period for absences and shift cycles, DD.MM.YYYY hh:mm; defaults to the project start | |
| type | Yes | catalog the object comes from |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | internal id of the object | |
| to | Yes | finish of the evaluated period, DD.MM.YYYY hh:mm | |
| url | No | web address; only with project_customer | |
| code | No | code; missing when none is set | |
| cost | No | price per unit of quantity; only with material | |
| from | Yes | begin of the evaluated period, DD.MM.YYYY hh:mm | |
| name | Yes | display name | |
| rank | No | professional qualification; only with role | |
| type | Yes | catalog the object comes from | |
| No | e-mail address; missing when none is set | ||
| group | No | group the object belongs to; not reported for people | |
| notes | No | notes; missing when empty | |
| phone | No | phone number; only with project_customer | |
| roles | No | all roles of the person; only with employee | |
| active | No | true = employed within the project period; only with employee | |
| metric | No | metric; only with material and machine_role | |
| person | No | the person behind the person-by-role entry; only with employee | |
| teamId | No | team; only with employee and machine, and only when set | |
| address | No | postal address of the customer group; only with project_customer | |
| absences | No | absences within the evaluated period | |
| calendar | No | own calendar; missing when none is set | |
| employedTo | No | employed to DD.MM.YYYY; only with employee | |
| hourlyRate | No | cost rate per hour | |
| employeeIds | No | person-by-role entries of the team; only with team | |
| memberCount | No | number of members; only with team | |
| shiftCycles | No | shift calendar: the periods in which a calendar other than the assigned one applies. The OWN cycles of the object, complete and not cut to the queried period - what rillsoft_resource_pool_resource_update writes back. Do not confuse this with the display switch view.calendarCycle of rillsoft_view_state_apply, which only shows the shift bars | |
| employedFrom | No | employed from DD.MM.YYYY; only with employee | |
| productivity | No | productivity of the team; only with team | |
| contactPerson | No | contact person; only with project_customer | |
| machineRoleId | No | machine role; only with machine and only when set | |
| costExceptions | No | time-dependent cost factors | |
| shiftCyclesEffective | No | the shift calendar as the scheduling applies it: the own cycles plus the ones inherited from the team, resolved day by day. Where both carry the same day, the calendar of the team wins. Only with employee; a team has nothing to inherit from, so there shiftCycles is already the effective list |