Data Import

List data import providers

Returns the import providers (e.g. an insurance company or a clearing house file format) the caller's tenant can import from, including disabled ones (enabled: false). Providers restricted to a specific tenant (properties.tenantId) are only returned to that tenant. Each provider describes its sub-providers, the accepted file extensions/name patterns, whether several files may be uploaded at once, and properties such as managerRequired, validityMonthRequired, autoDetectSubProvider and cancelAllowed that drive the params expected by initiateDataImport.

Authorization: requires the data_import:import scope.

get/data-import/providers

Request

  • Base URL
    https://api.surense.com/api/v1
  • URL
    https://api.surense.com/api/v1/data-import/providers
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.surense.com/oauth/token scopes: data_import:import

Response

The providers available to the caller's tenant

idstring uuid
namestring
descriptionstring
propertiesobject
subProvidersDataImportProviderDescriptor[] circular
allowMultipleFilesboolean
acceptedFilesobject
acceptedRegexesstring[]
archiveRegexesstring[]
archiveEntryRegexesstring[]
filesValidatorobject
requiredFilesValidatorobject
groupKeyExtractorobject
enabledboolean
taskDefinitionstring

Changes

No recorded changes to this operation across all 1 revision of this API.