Content Configuration update

Content Configuration update

Updates the configuration. The update is incremental. Any property in the Content ConfigurationModel schema that is missing or null will not be modified. Note that this update operation doesn't guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires ContentLibrary.UpdateConfiguration.
Request
URI
PATCH
https://{api_host}/api/content/configuration
COPY
Request Body

The Content ConfigurationModel specifying the settings to update.

Content ConfigurationModel of type(s) application/json
Required 
{
    "automatic_sync_enabled": false,
    "automatic_sync_start_hour": 0,
    "automatic_sync_stop_hour": 0,
    "maximum_concurrent_item_syncs": 0
}
boolean
automatic_sync_enabled
Optional

Whether automatic synchronization is enabled.

When automatic synchronization is enabled, the Content Library Service will automatically synchronize all subscribed libraries on a daily basis. Subscribed libraries with the Content ConfigurationModel.automatic_sync_enabled flag turned on will be synchronized every hour between Content ConfigurationModel.automatic_sync_start_hour and Content ConfigurationModel.automatic_sync_stop_hour.

The default value is true.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.

integer As int64 As int64
automatic_sync_start_hour
Optional

The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive.

The default value is 20.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.

integer As int64 As int64
automatic_sync_stop_hour
Optional

The hour at which the automatic synchronization will stop. Any active synchronization operation will continue to run, however no new synchronization operations will be triggered after the stop hour. This value is between 0 (midnight) and 23 inclusive.

The default value is 7.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.

integer As int64 As int64
maximum_concurrent_item_syncs
Optional

The maximum allowed number of library items to synchronize concurrently from remote libraries. This must be a positive number. The service may not be able to guarantee the requested concurrency if there is no available capacity.

This setting is global across all subscribed libraries. The default value is 5.

This property is not used for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.

Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

if one of the configuration properties is not within the proper range.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Content Operations
GET
Content Configuration get
PATCH
Content Configuration update