invantive documentation
Invantive Support ForumsLog In / Sign Up

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
clientId ``
logicId ``
purchaseInvoiceId ``
salesInvoiceId ``
searchText ``
sort ``
subscriptionId ``
supplierId ``
supplyOrderId ``
updatedFrom ``
withArchived ``

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
archivedAt datetime Archived at filters on the platform, writable, archivedAt
checkInAtWork varchar2 Check-In at Work filters on the platform, writable, checkInAtWork
clientContactId varchar2 Client Contact ID filters on the platform, writable, clientContactId
clientId varchar2 Client ID filters on the platform, writable, clientId
clientReference varchar2 Customer Reference filters on the platform, writable, clientReference
companyId varchar2 Company ID filters on the platform, writable, companyId
createdAt datetime Created at filters on the platform, writable, createdAt
date datetime Date filters on the platform, writable, date
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
distance int32 Distance filters on the platform, writable, distance
endClientContactId varchar2 End Client Contact ID filters on the platform, writable, endClientContactId
endClientId varchar2 End Client ID filters on the platform, writable, endClientId
executorId varchar2 Executor ID filters on the platform, writable, executorId
extraFields 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
lockedAt datetime Locked at filters on the platform, writable, lockedAt
logicId varchar2 Logical ID filters on the platform, writable, logicId
marginArticleCost double Margin Article Cost filters on the platform, writable, marginArticleCost
marginMaterialCost double Margin Material Cost filters on the platform, writable, marginMaterialCost
marginSubcontractorCost double Margin Subcontractor Cost filters on the platform, writable, marginSubcontractorCost
marginWorkCost double Margin Work Cost filters on the platform, writable, marginWorkCost
nssoDeclarationOfWorks varchar2 NSSO Declaration of Works filters on the platform, writable, nssoDeclarationOfWorks
planningGroup varchar2 Planning Group filters on the platform, writable, planningGroup
planningName varchar2 Planning Name filters on the platform, writable, planningName
priceGroupId varchar2 Price Group ID filters on the platform, writable, priceGroupId
renderedWorkOrderInfo varchar2 Rendered Work Order Info filters on the platform, writable, renderedWorkOrderInfo When reading, only present if requested via 'include' query parameter, otherwise null.
siteAddress_addressLine1 varchar2 Site Address Line 1 filters on the platform, writable, siteAddress.addressLine1
siteAddress_addressLine2 varchar2 Site Address Line 2 filters on the platform, writable, siteAddress.addressLine2
siteAddress_city varchar2 Site Address City filters on the platform, writable, siteAddress.city
siteAddress_country varchar2 Site Address Country filters on the platform, writable, siteAddress.country
siteAddress_latitude double Site Address Latitude filters on the platform, writable, siteAddress.latitude
siteAddress_longitude double Site Address Longitude filters on the platform, writable, siteAddress.longitude
siteAddress_postalCode varchar2 Site Address Postal Code filters on the platform, writable, siteAddress.postalCode
siteManagerId varchar2 Site Manager ID filters on the platform, writable, siteManagerId
siteNssoIdNumber varchar2 Site NSSO ID Number filters on the platform, writable, siteNssoIdNumber
statistics_claimStateGrandTotal decimal Statistics Claim State Grand Total filters on the platform, writable, statistics.claimStateGrandTotal
statistics_internalSupplyOrderTotalCostPrice decimal Statistics Internal Supply Order Total Cost Price filters on the platform, writable, statistics.internalSupplyOrderTotalCostPrice
statistics_offerGrandTotal decimal Statistics Offer Grand Total filters on the platform, writable, statistics.offerGrandTotal
statistics_offerTotalCostPrice decimal Statistics Offer Total Cost Price filters on the platform, writable, statistics.offerTotalCostPrice
statistics_offerTotalIndirectCosts decimal Statistics Offer Total Indirect Costs filters on the platform, writable, statistics.offerTotalIndirectCosts
statistics_purchaseInvoiceGrandTotal decimal Statistics Purchase Invoice Grand Total filters on the platform, writable, statistics.purchaseInvoiceGrandTotal
statistics_realisedIndirectCosts decimal Statistics Realised Indirect Costs filters on the platform, writable, statistics.realisedIndirectCosts
statistics_salesInvoiceGrandTotal decimal Statistics Sales Invoice Grand Total filters on the platform, writable, statistics.salesInvoiceGrandTotal
statistics_settlementGrandTotal decimal Statistics Settlement Grand Total filters on the platform, writable, statistics.settlementGrandTotal
statistics_settlementTotalCostPrice decimal Statistics Settlement Total Cost Price filters on the platform, writable, statistics.settlementTotalCostPrice
statistics_settlementTotalIndirectCosts decimal Statistics Settlement Total Indirect Costs filters on the platform, writable, statistics.settlementTotalIndirectCosts
statistics_totalBudgetedCosts decimal Statistics Total Budgeted Costs filters on the platform, writable, statistics.totalBudgetedCosts
statistics_totalBudgetedHours decimal Statistics Total Budgeted Hours filters on the platform, writable, statistics.totalBudgetedHours
statistics_totalBudgetedIncome decimal Statistics Total Budgeted Income filters on the platform, writable, statistics.totalBudgetedIncome
statistics_totalForecastedCosts decimal Statistics Total Forecasted Costs filters on the platform, writable, statistics.totalForecastedCosts
statistics_totalForecastedIncome decimal Statistics Total Forecasted Income filters on the platform, writable, statistics.totalForecastedIncome
statistics_totalForecastedIndirectCosts decimal Statistics Total Forecasted Indirect Costs filters on the platform, writable, statistics.totalForecastedIndirectCosts
statistics_totalRealisedCosts decimal Statistics Total Realised Costs filters on the platform, writable, statistics.totalRealisedCosts
statistics_totalRealisedIncome decimal Statistics Total Realised Income filters on the platform, writable, statistics.totalRealisedIncome
statistics_workOrderTotalCostPrice decimal Statistics Work Order Total Cost Price filters on the platform, writable, statistics.workOrderTotalCostPrice
statistics_workOrderTotalHours decimal Statistics Work Order Total Hours filters on the platform, writable, statistics.workOrderTotalHours
status varchar2 Status filters on the platform, writable, status
statusDetails_color varchar2 Status Details Color filters on the platform, writable, statusDetails.color
statusDetails_name varchar2 Status Details Name filters on the platform, writable, statusDetails.name
updatedAt datetime Updated at filters on the platform, writable, updatedAt
workOrderInfo varchar2 Work Order Information filters on the platform, writable, workOrderInfo 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 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. When writing, omit it or send null to keep the current text; send an empty string to clear it.

Keys

Key Column Refers to Kind Description
Projects_clientContactId_txt clientContactId 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_clientId_txt clientId 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_companyId_fk companyId Companies.id Key
Projects_endClientContactId_fk endClientContactId Contacts.id Key
Projects_endClientId_txt endClientId 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_siteManagerId_txt siteManagerId 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

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: