Get a range of Countries - ScreenId=CS20400SPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.If requested page size is greater than allowed max page size, request will be limited to max page size
Catalog: VismaNet
Schema: Country
Label: Countries
The data in this table is partitioned per value of the COMPANY_CODE column.
This is a read-only table function. The Visma.net API may not support changing the data or the Invantive SQL driver for Visma.net does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Visma.net API.
Select Visma.net API URL: /controller/api/v1/country
Insert Visma.net API URL: /controller/api/v1/country
Update Visma.net API URL: /controller/api/v1/country
Delete Visma.net API URL: /controller/api/v1/country
Field Selection Method: NotRequired
Select Visma.net API Operation: get /controller/api/v1/country
Table Function Parameters
The following parameters can be used to control the behaviour of the table function Countries. 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 |
Default Value |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string |
☐ |
|
Partition to retrieve data from. |
pageNumber |
int32 |
☐ |
|
Pagination parameter. Page number. |
pageSize |
int32 |
☐ |
|
Pagination parameter. Number of items to be collected. |
Table Function Columns
The columns of the table function Countries are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
COMPANY_CODE |
string(30) |
Company Code |
☑ |
Partition code, segmenting the data. |
COMPANY_NAME |
string(240) |
Company Name |
☑ |
Name of the partition. |
errorInfo |
string |
Error Message |
☐ |
|
id |
string |
ID |
☐ |
Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166. |
metadata_maxPageSize |
int64 |
|
☐ |
|
metadata_totalCount |
int64 |
Total Count |
☐ |
|
name |
string |
Name |
☐ |
Mandatory field: Country name* > The complete name of the country. |
12-12-2020 18:42 Version 20.1.301-BETA+3023
