ApprovalRequests: Robaws Approval Requests
read only REST
- Catalog:
Robaws - Schema:
ApprovalRequests - Label: Approval Requests
Search
Can only retrieve data.
API Source
- Endpoint:
/api/v2/approval-requests - Operation:
get /api/v2/approval-requests
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 61 |
| Full scan rows per minute | 16,530 |
| Point query rows per minute | 1,114 |
| Write rows per minute | 539 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
open |
`` | Filter by open/closed status. True returns open approval requests, false returns closed approval requests, null returns all approval requests. | ||
search |
`` | |||
sort |
`` | |||
updated |
`` | |||
userId |
`` | Ignored: the list always holds the approval requests of the user making the call. | ||
with |
`` |
Table Columns
The columns of the table ApprovalRequests 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 |
||
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 |
||
expire |
datetime |
Expiry Date | filters on the platform, writable, expire |
||
extra |
varchar2 |
Extra Fields | writable | The JSON text of the nested object. | |
id |
varchar2 |
ID | filters on the platform, writable, id |
||
invoice |
varchar2 |
Invoice Number | filters on the platform, writable, invoice |
||
locked |
datetime |
Locked at | filters on the platform, writable, locked |
||
logic |
varchar2 |
Logical ID | filters on the platform, writable, logic |
||
project |
varchar2 |
Project Information | filters on the platform, writable, project |
||
resource |
varchar2 |
Resource Under Approval Reference | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Archived At | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Assigned User ID | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Company ID | filters on the platform, writable, resource |
||
resource |
char |
Resource Under Approval Completed | filters on the platform, writable, resource |
||
resource |
decimal |
Resource Under Approval Completion Percentage | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Created At | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Date | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Deleted At | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Delivery Address | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Expected Delivery Date | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Extra Fields | writable | The JSON text of the nested object. | |
resource |
varchar2 |
Resource Under Approval Footer Text | filters on the platform, writable, resource |
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 |
|
resource |
varchar2 |
Resource Under Approval ID | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Intro Text | filters on the platform, writable, resource |
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 |
|
resource |
datetime |
Resource Under Approval Latest Delivery Date | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Locked At | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Logic ID | filters on the platform, writable, resource |
||
resource |
decimal |
Resource Under Approval Open Invoice Amount | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Reference | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Remark | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Sent via Webshop | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Status | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Supplier Contact ID | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Supplier ID | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval to Location ID | filters on the platform, writable, resource |
||
resource |
decimal |
Resource Under Approval Total Amount Invoiced | filters on the platform, writable, resource |
||
resource |
decimal |
Resource Under Approval Total Excluding VAT | filters on the platform, writable, resource |
||
resource |
decimal |
Resource Under Approval Total Including VAT | filters on the platform, writable, resource |
||
resource |
varchar2 |
Resource Under Approval Type | filters on the platform, writable, resource |
||
resource |
datetime |
Resource Under Approval Updated At | filters on the platform, writable, resource |
||
supplier |
varchar2 |
Supplier ID | filters on the platform, writable, supplier |
||
total |
decimal |
Total Excluding VAT | filters on the platform, writable, total |
||
total |
decimal |
Total Including VAT | filters on the platform, writable, total |
||
updated |
datetime |
Updated at | filters on the platform, writable, updated |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: