| Info |
|---|
Version 2 of APIs are available in release 5.1 and later. Use version 5.1.4 and later for Swagger. |
...
Version 2 of API to access information supports json. Use 2 for version. Documentation is available using swagger. Please refer to:
...
Attribute | Values | Usage | ||
|---|---|---|---|---|
settings-id | string | Name of the setting. Is used to connect users in api-permissions with export settings. | ||
max-items | int | Limit on number of root elements | ||
specifications | string, true or false | List of specifications defined by code. Each listed specification will be included in the api resposes. true will make all specifications to be included. false will make API remove all specifications. | ||
excluded-specifications | string | List of specifications defined by code. Each listed specification will be excluded in the api resposes. | ||
result-set | true/false | True will make API return a list of objects also when list contains only one object. This is default. False will make API return only the object if result is only one and a list otherwise. | ||
permissions | true/false | Will permissions be included in API response. | ||
permissions-disabled | string | List of permissions. Do not consider permissions in permissions-disabled list.
| ||
filters | true/false | Will filters be included in API response. | ||
filters-disabled | string | List of filters. Do not consider filters in filters-disabled list.
| ||
translations | ||||
href | true/false | Include href to information objects. | ||
value-separator | character | |||
<propertyname> | true/false | Determines if property is to be included in API response or not. Eg filters=”false” will ensure filters are not included in API responses. |
...
Settings for connecting systems
...
An API user is assigned permissions by the <Permissions> tag and connected to an export setting by the <> tag.
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?>
<ApiPermissionConfiguration xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd=http://www.w3.org/2001/XMLSchema>
<Enabled>true</Enabled>
<PermissionList>
<ApiPermission>
<Enabled>true</Enabled>
<Username>admin</Username>
<Passsword>admin</Passsword>
<Roles>WebSynchronizerApi,WebPublisherApi,PublisherApi, Api ,WebApiAdmin, ApiUpload</Roles>
<Permissions>EMEA</Permissions>
<AllowAnonymous>false</AllowAnonymous>
</ApiPermission>
</PermissionList>
</ApiPermissionConfiguration> |