API ReferenceAdmin

Create an integration

Create an integration

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
integration_vendorenumRequired
The integration vendor associated with the data diff
credentialsobjectRequired
JSON encoded credentials for accessing the integration vendor API
namestringRequired
The name of the integration
sync_frequencyintegerOptional>=1Defaults to 12

The interval of the scheduled sync frequency. (e.g. “12” in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.

sync_cadenceenumOptionalDefaults to HOUR

The cadence of the scheduled sync frequency. (e.g. “HOUR” in the following: Sync every 12 HOURs). This value will be used if the use_custom_schedule is set to false.

max_request_cadenceenumOptionalDefaults to SECOND

The cadence at which to limit the max request frequency. (e.g. “SECOND” in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute

max_request_frequencydoubleOptional>=1Defaults to 1

The maximum number of requests sent to the PMS API per cadence unit. (e.g. “2” in the following: 1 request per 2 SECONDs). Requests cannot be made less frequently than once per minute

max_job_concurrencyintegerOptional>=1<=100Defaults to 1

Maximum number of jobs that can be run at once for the integration. (e.g. “1” in the following: 1 request per 2 SECONDs)

activebooleanOptionalDefaults to false
The active state of the integration
new_properties_are_enabledbooleanOptionalDefaults to false
Whether or not properties need to be approved before by you ingesting data for them.
based_on_integration_idstringOptional

A reference integration_id to base the creation of an integration on. This includes copying job scheduling frequency and similar configuration. Credentials are not copied and must still be provided.

custom_sync_scheduleobjectOptional

A custom sync schedule configuration object which will be respected if use_custom_schedule is set to true

use_custom_sync_schedulebooleanOptionalDefaults to false

Opt-in to use the configured custom_sync_schedule

systemenumOptionalDeprecated

Deprecated: Do not use

Allowed values:
base_urlstringOptionalDeprecated
DEPRECATED. See specific PMS credentials for usage.
allow_manual_syncsbooleanOptionalDefaults to falseDeprecated

Deprecated: This is no longer configurable and will always be true

Response

Successful response
resultobject

Errors