ConfigurationModel

The ConfigurationModel structure defines the global settings of the Content Library Service.


Properties

Required Property Name Type Description
optional automatic_sync_enabled boolean

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 SubscriptionInfo.automatic-sync-enabled flag turned on will be synchronized every hour between ConfigurationModel.automatic-sync-start-hour and ConfigurationModel.automatic-sync-stop-hour.

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

optional automatic_sync_start_hour integer

The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

optional automatic_sync_stop_hour integer

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. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.

optional maximum_concurrent_item_syncs integer

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.

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

JSON Example

{
    "automatic_sync_enabled": false,
    "automatic_sync_start_hour": 0,
    "automatic_sync_stop_hour": 0,
    "maximum_concurrent_item_syncs": 0
}
Feedback

Was this page helpful?