Projects: Robaws Projects
insert update delete REST
- Catalog:
Robaws - Schema:
Projects - Primary Keys:
id - Label: Projects
Search
Can retrieve data and change data using insert, update and delete.
API Source
- Endpoint:
/api/v2/projects - Operation:
get /api/v2/projects
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 96 |
| Full scan rows per minute | 21,800 |
| Point query rows per minute | 988 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
client |
`` | |||
logic |
`` | |||
purchase |
`` | |||
sales |
`` | |||
search |
`` | |||
sort |
`` | |||
subscription |
`` | |||
supplier |
`` | |||
supply |
`` | |||
updated |
`` | |||
with |
`` |
Table Columns
The columns of the table Projects 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 | Marks | Documentation |
|---|---|---|---|---|---|
archived |
datetime |
Archived at | filters on the platform, writable, archived |
||
check |
varchar2 |
Check-In at Work | filters on the platform, writable, check |
||
client |
varchar2 |
Client Contact ID | filters on the platform, writable, client |
||
client |
varchar2 |
Client ID | filters on the platform, writable, client |
||
client |
varchar2 |
Customer Reference | filters on the platform, writable, client |
||
company |
varchar2 |
Company ID | filters on the platform, writable, company |
||
created |
datetime |
Created at | filters on the platform, writable, created |
||
date |
datetime |
Date | filters on the platform, writable, date |
||
deleted |
datetime |
Deleted at | filters on the platform, writable, deleted |
||
distance |
int32 |
Distance | filters on the platform, writable, distance |
||
end |
varchar2 |
End Client Contact ID | filters on the platform, writable, end |
||
end |
varchar2 |
End Client ID | filters on the platform, writable, end |
||
executor |
varchar2 |
Executor ID | filters on the platform, writable, executor |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
geofence |
varchar2 |
Geofence | filters on the platform, writable, geofence |
||
id |
varchar2 |
ID | filters on the platform, writable, id |
||
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
logic |
varchar2 |
Logical ID | filters on the platform, writable, logic |
||
margin |
double |
Margin Article Cost | filters on the platform, writable, margin |
||
margin |
double |
Margin Material Cost | filters on the platform, writable, margin |
||
margin |
double |
Margin Subcontractor Cost | filters on the platform, writable, margin |
||
margin |
double |
Margin Work Cost | filters on the platform, writable, margin |
||
nsso |
varchar2 |
NSSO Declaration of Works | filters on the platform, writable, nsso |
||
planning |
varchar2 |
Planning Group | filters on the platform, writable, planning |
||
planning |
varchar2 |
Planning Name | filters on the platform, writable, planning |
||
price |
varchar2 |
Price Group ID | filters on the platform, writable, price |
||
rendered |
varchar2 |
Rendered Work Order Info | filters on the platform, writable, rendered |
When reading, only present if requested via 'include' query parameter, otherwise null. | |
site |
varchar2 |
Site Address Line 1 | filters on the platform, writable, site |
||
site |
varchar2 |
Site Address Line 2 | filters on the platform, writable, site |
||
site |
varchar2 |
Site Address City | filters on the platform, writable, site |
||
site |
varchar2 |
Site Address Country | filters on the platform, writable, site |
||
site |
double |
Site Address Latitude | filters on the platform, writable, site |
||
site |
double |
Site Address Longitude | filters on the platform, writable, site |
||
site |
varchar2 |
Site Address Postal Code | filters on the platform, writable, site |
||
site |
varchar2 |
Site Manager ID | filters on the platform, writable, site |
||
site |
varchar2 |
Site NSSO ID Number | filters on the platform, writable, site |
||
statistics_ |
decimal |
Statistics Claim State Grand Total | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Internal Supply Order Total Cost Price | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Offer Grand Total | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Offer Total Cost Price | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Offer Total Indirect Costs | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Purchase Invoice Grand Total | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Realised Indirect Costs | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Sales Invoice Grand Total | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Settlement Grand Total | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Settlement Total Cost Price | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Settlement Total Indirect Costs | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Budgeted Costs | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Budgeted Hours | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Budgeted Income | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Forecasted Costs | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Forecasted Income | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Forecasted Indirect Costs | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Realised Costs | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Total Realised Income | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Work Order Total Cost Price | filters on the platform, writable, statistics. |
||
statistics_ |
decimal |
Statistics Work Order Total Hours | filters on the platform, writable, statistics. |
||
status |
varchar2 |
Status | filters on the platform, writable, status |
||
status |
varchar2 |
Status Details Color | filters on the platform, writable, status |
||
status |
varchar2 |
Status Details Name | filters on the platform, writable, status |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
||
work |
varchar2 |
Work Order Information | filters on the platform, writable, work |
When reading, only present if requested via 'include' query parameter, otherwise null. 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 |
Keys
| Key | Column | Refers to | Kind | Description |
|---|---|---|---|---|
Projects_ |
client |
Contacts.id |
Textual | The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it. |
Projects_ |
client |
Clients.id |
Textual | The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it. |
Projects_ |
company |
Companies.id |
Key | |
Projects_ |
end |
Contacts.id |
Key | |
Projects_ |
end |
Clients.id |
Textual | The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it. |
Projects_ |
site |
Users.id |
Textual | The referenced row, for as long as Robaws still lists it: a deleted or purged row is no longer listed, and a document may keep referring to it. |
Referenced By
- DeliveryNotes
projectId(Textual) - Installations
assignedProjectId(Textual) - Materials
assignedProjectId(Textual) - ProjectConstructionPartners
projectId(Key) - SalesInvoiceLineItems
projectId(Textual) - SalesOrders
projectId(Textual) - Settlements
projectId(Textual) - StockReservations
projectId(Textual) - SubscriptionLineItems
projectId(Key) - TimeRegistrations
projectId(Textual)
Sample Queries
select prj.logicId
, prj.date
, prj.siteAddress_city site_city
, cnt.name client_name
from Robaws.Projects.Projects prj
join Robaws.Clients.Clients cnt
on cnt.id = prj.clientId
where prj.archivedAt is null
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: