API System Settings

API system settings define how the API functions for the tenant.

NOTE: The value in the Tenant Editable column indicates whether or not the system setting can be edited by a user.

  • Yes — A user (with the appropriate role and security authorities) can edit the system setting value in the Admin application, as well as return it to the default value. Refer to Edit System Settings.

  • No — The system setting can only be edited by a Gotransverse representative. Contact Gotransverse Technical Support before editing the system setting to ensure the change will not cause issues within the tenant.

API System Settings
Name Description Data Type Possible Values Default Value Tenant Editable
Allow the API to return deep query results

Allow the API to return all child objects of a queried object. False will only allow shallow results, which return only the EIDS of the child objects of the queried object.

Boolean

TRUE

FALSE

TRUE

Yes
API Version Validation

Enable validation of API requests against a specific version. Version is set in Tenant API Version system setting.

Boolean

TRUE

FALSE

TRUE

No
Default API Query Scope

The default value for the API queryScope attribute for this tenant.

List

Shallow

Deep

Shallow

Yes
Enable Transactional API batch optimization

When set to true, API batches are attempted in transactional mode first. Upon failure, an automatic retry is initiated using individual transactions.

Boolean

TRUE

FALSE

FALSE

Yes
Max Number of API Requests

Maximum number of API requests to be processed per batch in an API batch request.

Integer

NULL

50

No
Max Number of API Entities Returned in Query Response

Maximum number of top level entities allowed in an API query response.

Integer

NULL

50

No
Maximum number of API retries

Maximum number of retries the API will make before failing a request.

Integer

NULL

2

No
Tenant API Version

Specifies the API version used by this tenant.

List

1.17

1.19

1.21

1.22

1.24

1.25

1.26

1.27

1.28

1.29

1.29

No