invantive documentation
Invantive Support ForumsLog In / Sign Up

Materials: Robaws Materials

insert update delete REST

  • Catalog: Robaws
  • Schema: Materials
  • Primary Keys: id
  • Label: Materials

Search

Can retrieve data and change data using insert, update and delete.

API Source

  • Endpoint: /api/v2/materials
  • Operation: get /api/v2/materials

Performance Characteristics

Characteristic Value
Average access latency (ms) 86
Full scan rows per minute 35,098
Point query rows per minute 1,132
Write rows per minute 539

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
articleId ``
clientId ``
employeeId ``
endClientId ``
installation `` Deprecated. Please use the types parameter to specify which types of materials you want to retrieve. For backwards compatibility, this filter parameter is retained with default value false, so when you do not specify the types parameter, you will only retrieve the materials (no installations).
projectId ``
searchText ``
serialNumber ``
sort ``
subcontractorId ``
updatedFrom ``
withArchived ``

Table Columns

The columns of the table Materials 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
address_addressLine1 varchar2 Address Line 1 filters on the platform, writable, address.addressLine1
address_addressLine2 varchar2 Address Line 2 filters on the platform, writable, address.addressLine2
address_city varchar2 City filters on the platform, writable, address.city
address_country varchar2 Country filters on the platform, writable, address.country
address_latitude double Address Latitude filters on the platform, writable, address.latitude
address_longitude double Address Longitude filters on the platform, writable, address.longitude
address_postalCode varchar2 Address Postal Code filters on the platform, writable, address.postalCode
archivedAt datetime Archived at filters on the platform, writable, archivedAt
articleId varchar2 Article ID filters on the platform, writable, articleId
assignedClientId varchar2 Assigned Client ID filters on the platform, writable, assignedClientId
assignedEmployeeId varchar2 Assigned Employee ID filters on the platform, writable, assignedEmployeeId
assignedEndClientId varchar2 Assigned End Client ID filters on the platform, writable, assignedEndClientId
assignedProjectId varchar2 Assigned Project ID filters on the platform, writable, assignedProjectId
assignedSubcontractorId varchar2 Assigned Subcontractor ID filters on the platform, writable, assignedSubcontractorId
brand varchar2 Brand filters on the platform, writable, brand
companyId varchar2 Company ID filters on the platform, writable, companyId
createdAt datetime Created at filters on the platform, writable, createdAt
deletedAt datetime Deleted at filters on the platform, writable, deletedAt
extraFields varchar2 Extra Fields writable The JSON text of the nested object.
id varchar2 ID filters on the platform, writable, id
installation char Installation filters on the platform, writable, installation
location varchar2 Location filters on the platform, writable, location
lockedAt datetime Locked at filters on the platform, writable, lockedAt
name varchar2 Name filters on the platform, writable, name
planningGroup varchar2 Planning Group filters on the platform, writable, planningGroup
serialNumber varchar2 Serial Number filters on the platform, writable, serialNumber
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
stockLocationId varchar2 Stock Location ID filters on the platform, writable, stockLocationId
supplierId varchar2 Supplier ID filters on the platform, writable, supplierId
updatedAt datetime Updated at filters on the platform, writable, updatedAt

Keys

Key Column Refers to Kind Description
Materials_assignedClientId_fk assignedClientId Clients.id Key
Materials_assignedEmployeeId_fk assignedEmployeeId Employees.id Key
Materials_assignedProjectId_txt assignedProjectId Projects.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.
Materials_assignedSubcontractorId_fk assignedSubcontractorId Suppliers.id Key
Materials_companyId_fk companyId Companies.id Key
Materials_stockLocationId_fk stockLocationId StockLocations.id Key
Materials_supplierId_fk supplierId Suppliers.id Key

Referenced By

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: