The version of the object for optimistic locking. You can use it to detect simultaneous modifications by different users.
It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|204|Success. Response doesn't have a body.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AppSettingsErrorEnvelopeError|Failed. The input is invalid. | Failed. Forbidden. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.|\n\n\nA list of fields to be included to the response. The provided set of fields extends the default set.
Specify the required top-level fields, separated by commas (for example, summary,value).
Supported fields: objectId, version, summary, searchSummary, schemaId, schemaVersion, modificationInfo, resourceContext, value.
Default fields: objectId, version.
|\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.
The first page is always returned if you don't specify the page-key query parameter.
When the page-key is set to obtain subsequent pages, you must omit all other query parameters.
|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of settings objects in a single response payload.
The maximal allowed page size is 500.
If not set, 100 is used.
|\n|config.schemaIds|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A list of comma-separated schema IDs to which the requested objects belong.
To load the first page, when the nextPageKey is not set, this parameter is required.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[AppSettingsObjectsList](#appsettingsobjectslist)|200|Success. Accessible objects returned. \n\n Even if a response returns a successful response code it is possible that the result is incomplete due to an internal error. \n\n In this case an 'error' property with information about the problem is added. The caller may decide to work with the incomplete result or do a retry of the operation.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AppSettingsErrorEnvelopeError|Failed. The input is invalid. | Failed. Forbidden. | Failed. The specified schema was not found.|\n\n\nA list of fields to be included to the response. The provided set of fields extends the default set.
Specify the required top-level fields, separated by commas (for example, summary,schemaId).
Supported fields: summary, searchSummary, schemaId, schemaVersion, modificationInfo, value.
Default fields: value.
|\n|config.pageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cursor for the next page of results. You can find it in the nextPageKey field of the previous response.
The first page is always returned if you don't specify the page-key query parameter.
When the page-key is set to obtain subsequent pages, you must omit all other query parameters.
|\n|config.pageSize|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The amount of settings objects in a single response payload.
The maximal allowed page size is 500.
If not set, 100 is used.
|\n|config.schemaIds|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A list of comma-separated schema IDs to which the requested objects belong.
Only considered on load of the first page, when the nextPageKey is not set.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|[EffectiveAppSettingsValuesList](#effectiveappsettingsvalueslist)|200|Success \n\n Even if a response returns a successful response code it is possible that the result is incomplete due to an internal error. \n\n In this case an 'error' property with information about the problem is added. The caller may decide to work with the incomplete result or do a retry of the operation.|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AppSettingsErrorEnvelopeError|Failed. The input is invalid. | Failed. The specified schema is not found.|\n\n\ntrue, the request runs only validation of the submitted settings objects, without saving them. |\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success. No validation errors.|\n|[AppSettingsObjectResponse](#appsettingsobjectresponse)|201|Created|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AppSettingsErrorEnvelopeError|Failed. The input is invalid. | Failed. Forbidden. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.|\n\n\nThe version of the object for optimistic locking. You can use it to detect simultaneous modifications by different users.
It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|\n\n\n\n\n#### Returns\n\n| Return type | Status code | Description |\n|---|---|---|\n|void|200|Success|\n\n\n#### Throws\n\n| Error Type | Error Message |\n|---|---|\n|AppSettingsErrorEnvelopeError|Failed. The input is invalid. | Failed. Forbidden. | Failed. The requested resource doesn't exist. | Failed. Conflicting resource.|\n\n\nThe value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
|\n|version*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the object for optimistic locking. You can use it to detect simultaneous modifications by different users.
It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|\n\n### AppSettingsObjectCreate\n\nConfiguration of a new settings object.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|insertAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The position of the new object. The new object will be added after the specified one.
If null, the new object will be placed in the last position.
If set to empty string, the new object will be placed in the first position.
Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).
The value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
|\n\n### AppSettingsObjectResponse\n\nThe response to a creation request.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|objectId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the created settings object. |\n|version*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the object for optimistic locking. You can use it to detect simultaneous modifications by different users.
It is generated upon retrieval (GET requests). If set on update (PUT request) or deletion, the update/deletion will be allowed only if there wasn't any change between the retrieval and the update.
|\n\n### AppSettingsObjectUpdate\n\nAn update of a settings object.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|insertAfter|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The position of the updated object. The new object will be moved behind the specified one.
insertAfter and insertBefore are evaluated together and only one of both can be set.
If null and insertBefore 'null', the existing object keeps the current position.
If set to empty string, the updated object will be placed in the first position.
Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).
The position of the updated object. The new object will be moved in front of the specified one.
insertAfter and insertBefore are evaluated together and only one of both can be set.
If null and insertAfter 'null', the existing object keeps the current position.
If set to empty string, the updated object will be placed in the last position.
Only applicable for objects based on schemas with ordered objects (schema's ordered parameter is set to true).
The value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
|\n\n### AppSettingsObjectsList\n\nA list of settings objects.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|error|AppSettingsErrorIncomplete|Error object for an incomplete response |\n|items*required|Array<AppSettingsObject>|A list of settings objects. |\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cursor for the next page of results. Has the value of null on the last page.
Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
|\n|pageSize*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |\n|totalCount*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |\n\n### ConstraintViolation\n\nA list of constraint violations\n\n| Name | Type |\n| --- | --- |\n|location|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| \n|message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| \n|parameterLocation|\"HEADER\" | \"PATH\" | \"PAYLOAD_BODY\" | \"QUERY\"| \n|path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### EffectiveAppSettingsValue\n\nAn effective settings value.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|modificationInfo|AppSettingsModificationInfo|Modification information about the app setting. |\n|schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |\n|schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |\n|searchSummary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A searchable summary string of the setting value. Plain text without Markdown. |\n|summary|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|A short summary of settings. This can contain Markdown and will be escaped accordingly. |\n|value|AppSettingsValue|The value of the setting.
It defines the actual values of settings' parameters.
The actual content depends on the object's schema.
|\n\n### EffectiveAppSettingsValuesList\n\nA list of effective settings values.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|error|AppSettingsErrorIncomplete|Error object for an incomplete response |\n|items*required|Array<EffectiveAppSettingsValue>|A list of effective settings values. |\n|nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The cursor for the next page of results. Has the value of null on the last page.
Use it in the nextPageKey query parameter to obtain subsequent pages of the result.
|\n|pageSize*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |\n|totalCount*required|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The total number of entries in the result. |\n\n### EffectivePermission\n\n| Name | Type |\n| --- | --- |\n|context|PermissionContext| \n|granted*required|\"true\" | \"false\" | \"condition\"| \n|permission*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### EffectivePermissions\n\n**type**: Array<EffectivePermission>\n\n### Modifications\n\nThe additional modification details for this settings object.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|first|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If non-moveable settings object is in the first group of non-moveable settings, or in the last (start or end of list). |\n|modifiablePaths*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Property paths which are modifiable, regardless if thewrite operation is allowed. |\n|movable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If settings object can be moved/reordered. Only applicable for ordered list schema. |\n|nonModifiablePaths*required|Array<[string](https://developer.mozilla.org/en-US/docs/Glossary/String)>|Property paths which are not modifiable, even if the write operation is allowed. |\n\n### PermissionContext\n\n| Name | Type |\n| --- | --- |\n|schemaId*required|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|\n\n### ResolutionRequest\n\n| Name | Type |\n| --- | --- |\n|permissions*required|Array<SinglePermissionRequest>|\n\n### ResourceContext\n\nThe resource context, which contains additional permission information about the object.\n\n| Name | Type | Description |\n| --- | --- | --- |\n|modifications*required|Modifications|The additional modification details for this settings object. |\n|operations*required|Array<\"read\" | \"write\" | \"delete\">|The allowed operations on this settings object. |\n\n### SinglePermissionRequest\n\noptional generic set of context data\n\n| Name | Type |\n| --- | --- |\n|context|PermissionContext| \n|permission*required|\"app-settings:objects:read\" | \"app-settings:objects:write\"|\n\n## Enums\n\n\n### ~~ConstraintViolationParameterLocation~~\n\n> ⚠️ **Deprecated**\n> Use literal values.\n\n