connector_document

Boomi AtomSphere API: Connector Document Object

boomi_cicd.util.connector_document.get_connector_document(generic_connector_record_id, /, *, request_interval_sec=10, max_wait_sec=300)[source]

Download and view the connector document data for a Generic Connector Record. The Connector Document operation allows you to download the raw, document data for a specific Generic Connector Record. The data is equivalent to viewing and downloading document data through the Process Reporting page.

Parameters:

  • generic_connector_record_id (str) – The ID of the GenericConnectorRecord.

  • request_interval_sec (int, optional) – The time to wait between retries in seconds. Default is 10 seconds.

  • max_wait_sec (int, optional) – The maximum wait time in seconds. Default is 300 seconds (5 minutes).

Returns:

The payload of the connector document.

Return type:

str

Raises:

  • TimeoutError – If the connector document is not available after the maximum wait time.

  • requests.RequestException – If the request fails.