...
| Code Block |
|---|
https://{vcf_mr_domain}/verba/restapi/v1/{resource_plural}/{id}?{query_parameters} |
The different resources like users and storage targets can be reached by dedicated endpoints. These endpoints allow to list entities of a resource. To reach a specific entity of the resource the ID must be placed in the URL too.
In some scenarios, the request requires to add additional query parameters to modify the response.
The resource endpoints usually have options endpoints too. These endpoints list dynamic values that are relevant to the usage of the specific resource endpoint. The URL structure of the option endpoints is the following:
| Code Block |
|---|
https://{vcf_mr_domain}/verba/restapi/v1/{resource_singular}Options/{option_method} |
URL parameter | Description | Example |
|---|---|---|
vcf_mr_domain | Domain or the IP address of the VFC MR or Combo server installation, where the VFC Web Application can be reached | “localhost” |
resource_plural | Name of the resource type in plural form | For the user resource: “users” |
resource_singular | Name of the resource type in singular form | For the user resource: “user” |
id | The uni |
HTTP Method
On the same resource, different actions can be achieved with different HTTP methods if applicable. The actions are collected in the following table.
...
| Panel | ||||||
|---|---|---|---|---|---|---|
| ||||||
In the case of a multitenant system, the generated access token is only valid for a certain tenant. By default, the token is valid only for the authenticated user’s tenant. But if the client user is in the reference tenant, then they can specify another tenant during the token generation with the “targetEid” property. In this case, the “eid” property should be left out of the requestmust be “0000”. |
Access token generation with credential
...
The supported properties for filtering can be retrieved from a specific endpoint. Every resource type has its own “options” endpoints. The naming convention of that endpoints follows the structure: /v1/{resource_singular}Options/getAllowedFilters
...
The supported properties for sorting can be retrieved from a specific endpoint. Every resource type has its own “options” endpoints. The naming convention of that endpoints follows the structure: /v1/{resource_singular}Options/getSortableFields
...