ROBAWS API Data Model

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Print Topic
Send Mail Feedback
Share This Topic
Save Permalink URL

Navigation: Schema: Articles > Tables

Articles

Contents Previous Home Next More

https://cloud.invantive.com/robaws/Sql

Catalog: Robaws

Schema: Articles

Select: true

Insert: true

Update: true

Delete: true

Select Service URL (OData-specific): /api/v1/articles

Insert Service URL (OData-specific): /api/v1/articles

Update Service URL (OData-specific): /api/v1/articles

Delete Service URL (OData-specific): /api/v1/articles

Field Selection Method (OData-specific): NotRequired

Base Path (OData-specific): content[*]

Select Operation (Swagger-specific): get /api/v1/articles

Insert Operation (Swagger-specific): post /api/v1/articles

Update Operation (Swagger-specific): put /api/v1/articles/{id}

Delete Operation (Swagger-specific): delete /api/v1/articles/{id}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function Articles. 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 treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `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	Documentation
articleGroupId	int64	☐	articleGroupId
articleNr	string	☐	articleNr
barcode	string	☐	barcode
calc	boolean	☐	calc
chapter	string	☐	chapter
employeeRoleId	int64	☐	employeeRoleId
hasCompositeArticleId	int64	☐	hasCompositeArticleId
name	string	☐	name
offset	int64	☐
paged	boolean	☐
pageNumber	int32	☐
postProjectId	int64	☐	postProjectId
postSubArticleId	int64	☐	postSubArticleId
sort.sorted	boolean	☐
sort.unsorted	boolean	☐
supplierId	int64	☐	supplierId
text	string	☐	text
timeOperation	boolean	☐	timeOperation
unpaged	boolean	☐

Table Columns

The columns of the table Articles 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 or update.

Name	Data Type	Label	Required
accountancyCode_code	string		☐
accountancyCode_externalId	string		☐
accountancyCode_id	int64		☐
accountancyCode_name	string	Accountancy Code Name	☐
accountancyCode_version	int64	Accountancy Code Version	☐
accountancyCodePurchase_code	string		☐
accountancyCodePurchase_externalId	string		☐
accountancyCodePurchase_id	int64		☐
accountancyCodePurchase_name	string		☐
accountancyCodePurchase_version	int64		☐
activity	string	Activity	☐
agreementType	string	Agreement Type	☐
articleGroup_contextPath	string		☐
articleGroup_id	int64	Article Group ID	☐
articleGroup_name	string	Article Group Name	☐
articleGroup_photo_availableForWappy	boolean		☐
articleGroup_photo_directory	boolean		☐
articleGroup_photo_documentDate	datetime		☐
articleGroup_photo_expirationDate	datetime		☐
articleGroup_photo_filename	string		☐
articleGroup_photo_fileSize	int64		☐
articleGroup_photo_id	int64		☐
articleGroup_photo_mimeType	string		☐
articleGroup_photo_objectRef_objectId	int64		☐
articleGroup_photo_objectRef_objectType	string		☐
articleGroup_photo_parentId	int64		☐
articleGroup_photo_path	string		☐
articleGroup_photo_uuid	string		☐
articleGroup_photo_version	int64		☐
articleGroup_photo_wappy	boolean		☐
articleGroup_version	int64	Article Group Version	☐
articleNumber	string	Article Number	☐
articleType	string	Article Type	☐
barcode	string	Bar Code	☐
brand	string	Brand	☐
calc	boolean	Calc	☐
calcDescription	string	Calc Description	☐
calculationType	string	Calculation Type	☐
chapter	string	Chapter	☐
costPrice	double	Cost Price	☐
costPriceStrategy	string		☐
currencySymbol	string	Currency Symbol	☐
description	string	Description	☐
deviantSalesName	string	Deviating Sales Name	☐
headerLevel	string	Header Level	☐
id	int64	ID	☐
indirectCostFactor	double	Indirect Cost Factor	☐
internalPhoto	boolean	Internal Photograph	☐
lineType	string	Line Type	☐
margin	double	Margin	☐
materialInstallation	boolean	Material Installation	☐
minimumSaleAmount	double	Minimum Sales Amount	☐
minimumStockAmount	double	Minimum Stock Amount	☐
name	string	Name	☐
newPage	boolean	New Page	☐
photo_availableForWappy	boolean		☐
photo_directory	boolean	Photo Directory	☐
photo_documentDate	datetime	Photo Document Date	☐
photo_expirationDate	datetime	Photo Expiration Date	☐
photo_filename	string	Photo File Name	☐
photo_fileSize	int64	Photo File Size	☐
photo_id	int64	Photo ID	☐
photo_mimeType	string	Photo MIME Type	☐
photo_objectRef_objectId	int64		☐
photo_objectRef_objectType	string		☐
photo_parentId	int64		☐
photo_path	string		☐
photo_uuid	string	Photo UUID	☐
photo_version	int64	Photo Version	☐
photo_wappy	boolean		☐
saleName	string		☐
salePrice	double	Sales Price	☐
salePriceStrategy	string		☐
stockAmount	double	Stock Amount	☐
stockChanges	string	Stock Changes	☐
stockLocation	string	Stock Location	☐
supplierNames	string	Supplier Names	☐
timeOperation	boolean	Time Operation	☐
unitType	string	Unit Type	☐
vatTarif	string	VAT Code	☐
version	int64	Version	☐

17-11-2020 16:0920.1.279-BETA+2990

Please enable JavaScript to view this site.

ROBAWS API Data Model

Articles

Table Function Parameters

Table Columns