CHchift
Datalayer

Enable the datalayer sync for a connection

Changed on

Enables the datalayer sync for the consumer's connection so it refreshes on schedule. Requires the datalayer to be configured for the connection's vertical.

post/consumers/{consumer_id}/connections/{connection_id}/enable_datalayer

Request

Path parameters

consumer_idstring uuid required
connection_idstring uuid required

Request body

from_datestring date nullable

Date from which the data is synced. Defaults to one year ago when omitted.

fiscal_years_backinteger nullable

Sync from the start of the book year this many fiscal years back (accounting only). 0 syncs from the start of the current fiscal year.

full_historyboolean

Sync the whole history, without a lower date bound. Mirrors the 'infinite' automatic-activation policy.

entity_filterobject nullable

Restrict the datalayer to specific entities of the connection instead of every one the end-user selected, keyed by entity kind applicable to the connection's vertical (e.g. folder_ids, location_ids). The ids are validated against the ones available on the connection when the sync runs. Omit to sync every selected entity.

Response

Successful Response

unknown required

Changes

  • 020884969534Revision changes
    • info

      added the new optional request property /

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status