Connection-based API Import Job Parameters

Jobs for importing data from external APIs using a configured system connection.

Optional fields

CertificatePath (string | null)
Path to the certificate used for API authentication.

MaxPartHours (integer | null)
Maximum number of hours processed in one import part.

Client (string | null)
Client or integration identifier.

ClientId (string | null)
Client identifier used by the external API.

Url (string | null)
External API URL. Used in some integrations instead of BaseUrl.

Protocol

Communication protocol. Example: "HTTPS".

Base URL of the external API.

Access token used for API authentication.

API request timeout in milliseconds.

TypeInt

Determines whether successful import execution should be reported.

AccessToken, TimeOut and MaxPartHours fields control API authentication and import performance behavior.

Access token authentication

Useful for integrations using token-based API authentication.

{ "AccessToken": "<token>" }

Longer API timeout

Useful when importing large amounts of data from slower external APIs.

{ "TimeOut": 120000 }

Split import into smaller time parts

Useful for large imports or APIs with request size or processing limitations.

{ "MaxPartHours": 8 }