Function: getImportSource()

function getImportSource(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  collectionId?: string;
  created?: Date;
  dateFormat?: string;
  dateTimeFormat?: string;
  defaultConcatenator?: string;
  defaultHandleComputeIssueValues?: string | null;
  defaultHandleEmptyValues?: string;
  defaultHandleNotMappedValues?: string | null;
  defaultHandleNullValues?: string | null;
  defaultHandleUnknownValues?: string;
  description?: string | null;
  id?: string;
  importExecutionType?: string | null;
  importSourceModuleKey?:   | string & object
     | "rlabs-import-type-csv"
     | "rlabs-import-type-json"
     | "rlabs-import-type-external"
     | "insight-discovery-import"
     | "rlabs-import-type-dm-csv";
  importSourceOTEntries?: object[] | null;
  importSpecificConfiguration?: string;
  importStatus?:   | {
   [key: string]: unknown;
     configurationAuiLozenge?: string;
     configurationStatusType?: string & object | "ENABLED" | "DISABLED" | null;
     name?: string;
     reasonForInvalidity?: Record<string, any> | null;
     validation?: string;
     validationAuiLozenge?: string;
     validationStatusType?:   | string & object
        | "VALID"
        | "INVALID_CONFIGURATION"
        | "MODULE_UNINSTALLED"
        | null;
   }
     | null;
  integratedImportTypeExtensionId?: string | null;
  integratedImportTypeId?: number | null;
  isImportSourceSchedulingEnabled?: boolean | null;
  name?: string;
  objectSchemaId?: string;
  scheduledImportDetails?:   | {
   [key: string]: unknown;
     createdAt?: Date;
     importScheduleId?: string;
     nextScheduledTime?: Date;
     runFrequency?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY";
     startTime?: Date;
   }
     | null;
  tokenGenerated?: boolean | null;
  updated?: Date;
  url?: string | null;
}>;

Defined in: src/assets/api/importSources.ts:30

Retrieves a specific import source configuration by its ID. If scheduled imports are enabled, the response includes scheduling information.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ id: string; }	-
parameters.id	string	The unique identifier of the import source
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; collectionId?: string; created?: Date; dateFormat?: string; dateTimeFormat?: string; defaultConcatenator?: string; defaultHandleComputeIssueValues?: string | null; defaultHandleEmptyValues?: string; defaultHandleNotMappedValues?: string | null; defaultHandleNullValues?: string | null; defaultHandleUnknownValues?: string; description?: string | null; id?: string; importExecutionType?: string | null; importSourceModuleKey?: | string & object | "rlabs-import-type-csv" | "rlabs-import-type-json" | "rlabs-import-type-external" | "insight-discovery-import" | "rlabs-import-type-dm-csv"; importSourceOTEntries?: object[] | null; importSpecificConfiguration?: string; importStatus?: | { [key: string]: unknown; configurationAuiLozenge?: string; configurationStatusType?: string & object | "ENABLED" | "DISABLED" | null; name?: string; reasonForInvalidity?: Record<string, any> | null; validation?: string; validationAuiLozenge?: string; validationStatusType?: | string & object | "VALID" | "INVALID_CONFIGURATION" | "MODULE_UNINSTALLED" | null; } | null; integratedImportTypeExtensionId?: string | null; integratedImportTypeId?: number | null; isImportSourceSchedulingEnabled?: boolean | null; name?: string; objectSchemaId?: string; scheduledImportDetails?: | { [key: string]: unknown; createdAt?: Date; importScheduleId?: string; nextScheduledTime?: Date; runFrequency?: string & object | "ONCE" | "DAILY" | "WEEKLY" | "MONTHLY"; startTime?: Date; } | null; tokenGenerated?: boolean | null; updated?: Date; url?: string | null; }>