Sign in

v1

latestOpenAPI 3.0.02026-07-136452257.6 KB

Get import source by ID

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

get/importsource/{id}

Response

Import source found

idstring uuid

Import source ID

collectionIdstring uuid

Collection (object schema) ID

namestring

Import source name

createdstring date-time

Timestamp when the import source was created

updatedstring date-time

Timestamp when the import source was last updated

descriptionstring nullable

Import source description

objectSchemaIdstring uuid

Object schema ID

importSourceModuleKey'rlabs-import-type-csv' | 'rlabs-import-type-json' | 'rlabs-import-type-external' | 'insight-discovery-import' | 'rlabs-import-type-dm-csv'

Import module type. CSV: rlabs-import-type-csv, JSON: rlabs-import-type-json, External: rlabs-import-type-external, Discovery: insight-discovery-import, DataManager: rlabs-import-type-dm-csv

defaultConcatenatorstring

Default concatenator for multi-value attributes

defaultHandleEmptyValuesstring

How to handle empty values

defaultHandleUnknownValuesstring

How to handle unknown values

dateFormatstring

Date format pattern

dateTimeFormatstring

Date-time format pattern

importSpecificConfigurationstring

Import-specific configuration as JSON string

tokenGeneratedboolean nullable

Whether a token has been generated for this import source

urlstring uri nullable

Import source URL (if applicable)

integratedImportTypeIdinteger nullable

Integrated import type ID

integratedImportTypeExtensionIdstring nullable

Integrated import type extension ID

defaultHandleComputeIssueValuesstring nullable

How to handle computed issue values (DataManager config)

defaultHandleNullValuesstring nullable

How to handle null values (DataManager config)

defaultHandleNotMappedValuesstring nullable

How to handle not mapped values (DataManager config)

isImportSourceSchedulingEnabledboolean nullable

Whether scheduled import is enabled for this source

importExecutionTypestring nullable

Type of import execution

Example response

{
  "id": "b9f5f167-a7e1-4b3a-9e4f-2c3d4e5f6a7c",
  "collectionId": "c7d8e9f0-1234-5678-9abc-def012345678",
  "name": "Daily Server Import",
  "created": "2024-01-10T10:30:00Z",
  "updated": "2024-01-12T14:45:00Z",
  "description": "Automated import of server data",
  "objectSchemaId": "c7d8e9f0-1234-5678-9abc-def012345678",
  "importSourceModuleKey": "rlabs-import-type-csv",
  "defaultConcatenator": ",",
  "defaultHandleEmptyValues": "IGNORE",
  "defaultHandleUnknownValues": "IGNORE",
  "dateFormat": "yyyy-MM-dd",
  "dateTimeFormat": "yyyy-MM-dd'T'HH:mm:ss'Z'",
  "importSpecificConfiguration": "{}",
  "tokenGenerated": true,
  "isImportSourceSchedulingEnabled": true,
  "scheduledImportDetails": {
    "importScheduleId": "a8f5f167-a7e1-4b3a-9e4f-2c3d4e5f6a7b",
    "startTime": "2024-01-15T02:00:00Z",
    "runFrequency": "DAILY",
    "nextScheduledTime": "2024-01-16T02:00:00Z",
    "createdAt": "2024-01-10T10:30:00Z"
  }
}