# PlanningItems: ROBAWS Planning Items Search - Catalog: `Robaws` - Schema: `PlanningItems` - Primary Keys: `id` - Label: Planning Items Can retrieve data and change data using insert, update and delete. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `PlanningItems`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `employeeId` | `` | ☐ | | | | `fromDate` | `` | ☐ | | | | `inWaitingRoom` | `` | ☐ | | | | `materialId` | `` | ☐ | | | | `orderId` | `` | ☐ | | | | `projectId` | `` | ☐ | | | | `salesOrderId` | `` | ☐ | | | | `searchText` | `` | ☐ | | | | `sort` | `` | ☐ | | | | `toDate` | `` | ☐ | | | | `updatedFrom` | `` | ☐ | | | | `withArchived` | `` | ☐ | | | ## Columns of Table Function The columns of the table function `PlanningItems` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `address_addressLine1` | `varchar2` | Address Line 1 | ☐ | | | `address_addressLine2` | `varchar2` | Address Line 2 | ☐ | | | `address_city` | `varchar2` | City | ☐ | | | `address_country` | `varchar2` | Country | ☐ | | | `address_latitude` | `double` | | ☐ | | | `address_longitude` | `double` | | ☐ | | | `address_postalCode` | `varchar2` | | ☐ | | | `archivedAt` | `datetime` | Archived at | ☐ | | | `basePlanningItemId` | `varchar2` | Base Planning Item ID | ☐ | | | `clientId` | `varchar2` | Client ID | ☐ | | | `clientReference` | `varchar2` | Customer Reference | ☐ | | | `companyId` | `varchar2` | Company ID | ☐ | | | `contactId` | `varchar2` | Contact ID | ☐ | | | `createdAt` | `datetime` | Created at | ☐ | | | `deletedAt` | `datetime` | Deleted at | ☐ | | | `description` | `varchar2` | Description | ☐ | HTML content. Embedded images are resolved to URLs based on the 'x-robaws-html-image-mode' request header: TEMPORARY_URL (default) returns time-limited presigned URLs that require no authentication; PERMANENT_URL returns stable URLs that require an authenticated session; NONE returns the stored HTML, where each image is an <img> with a data-robaws-id and an empty src — keep that tag and its data-robaws-id when writing the HTML back, or the image is lost. Any other value (e.g. BASE64_INLINE) returns 400 Bad Request. | | `endClientContactId` | `varchar2` | End Client Contact ID | ☐ | | | `endClientId` | `varchar2` | End Client ID | ☐ | | | `endDate` | `datetime` | End Date | ☐ | An item is in the waiting room, and not on the day planning, while its start date or its end date is empty. To get the waiting room, filter on either date being empty (an OR of both). An item is on the day planning of a period when it overlaps it: startDate on or before the period's last day and endDate on or after its first day; filtering startDate alone misses items that started before the period. | | `executionPhaseDetail` | `varchar2` | Execution Phase Detail | ☐ | | | `executionPhaseId` | `varchar2` | Execution Phase ID | ☐ | | | `externalId` | `varchar2` | External ID | ☐ | | | `extraFields` | `varchar2` | Extra Fields | ☐ | The JSON text of the nested object. | | `hourTypeId` | `varchar2` | | ☐ | | | `id` | `varchar2` | ID | ☐ | | | `lockedAt` | `datetime` | Locked at | ☐ | | | `numberOfWorkOrders` | `int32` | Number of Work Orders | ☐ | When reading, only present if requested via 'include' query parameter, otherwise null. | | `phaseId` | `varchar2` | Phase ID | ☐ | | | `planningTypeId` | `varchar2` | Planning Type ID | ☐ | | | `projectId` | `varchar2` | Project ID | ☐ | | | `recurrenceEndDate` | `datetime` | Recurrence End Date | ☐ | | | `recurrenceRule` | `varchar2` | Recurrence Rule | ☐ | | | `recurringMode` | `varchar2` | Recurring Mode | ☐ | Deprecated, use recurrenceRule instead. | | `recurring` | `char` | Recurring | ☐ | | | `salesOrderId` | `varchar2` | Sales Order ID | ☐ | | | `startDate` | `datetime` | Start Date | ☐ | An item is in the waiting room, and not on the day planning, while its start date or its end date is empty. To get the waiting room, filter on either date being empty (an OR of both). An item is on the day planning of a period when it overlaps it: startDate on or before the period's last day and endDate on or after its first day; filtering startDate alone misses items that started before the period. | | `summary` | `varchar2` | Summary | ☐ | | | `timeAndMaterial` | `char` | Time and Material | ☐ | | | `timeOffCategoryId` | `varchar2` | | ☐ | | | `transportId` | `varchar2` | Transport ID | ☐ | | | `unavailableReasonDetails_color` | `varchar2` | | ☐ | | | `unavailableReasonDetails_name` | `varchar2` | | ☐ | | | `unavailableReason` | `varchar2` | Unavailable Reason | ☐ | Deprecated, use timeOffCategory instead. | | `updatedAt` | `datetime` | Updated at | ☐ | | ## Foreign Keys The values of these columns refer to a row of another table. | Columns | Referenced Table | Referenced Columns | Guarantee | |---|---|---|---| | `basePlanningItemId` | [[PlanningItems-PlanningItems\|PlanningItems.PlanningItems]] | `id` | Declared by the connector, not enforced by the platform | | `clientId` | [[Clients-Clients\|Clients.Clients]] | `id` | Declared by the connector, not enforced by the platform | | `companyId` | [[Companies-Companies\|Companies.Companies]] | `id` | Declared by the connector, not enforced by the platform | | `contactId` | [[Contacts-Contacts\|Contacts.Contacts]] | `id` | Declared by the connector, not enforced by the platform | | `endClientContactId` | [[Contacts-Contacts\|Contacts.Contacts]] | `id` | Declared by the connector, not enforced by the platform | | `endClientId` | [[Clients-Clients\|Clients.Clients]] | `id` | Declared by the connector, not enforced by the platform | | `executionPhaseId` | [[ExecutionPhases-ExecutionPhases\|ExecutionPhases.ExecutionPhases]] | `id` | Declared by the connector, not enforced by the platform | | `planningTypeId` | [[PlanningTypes-PlanningTypes\|PlanningTypes.PlanningTypes]] | `id` | Declared by the connector, not enforced by the platform | | `salesOrderId` | [[SalesOrders-SalesOrders\|SalesOrders.SalesOrders]] | `id` | Declared by the connector, not enforced by the platform | ## Referenced By The columns of these tables refer to a row of this table. | Table | Columns | Guarantee | |---|---|---| | [[Absences-Absences\|Absences.Absences]] | `planningItemId` | Declared by the connector, not enforced by the platform | | [[PlanningItems-PlanningItems\|PlanningItems.PlanningItems]] | `basePlanningItemId` | Declared by the connector, not enforced by the platform |