Get a list of UDC containers

Prev Next
Get
/v{version}/UdcDataImporters/Containers

Containers are implicitly filtered by the user's read permission.

Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Query parameters
includeLatestImportResult
boolean

If true, the latest import results are loaded. Default: false.

Responses
200

OK

Array of object
object

UDC container

DataSourceKey
string

Data source key of the UDC container

DisplayType
string

Display types of the UDC plugin

Valid values[ "Product", "News", "Wheather", "Roommanager", "Immo", "Specific" ]
Guid
string (uuid)

Unique GUID of the UDC container

Id
integer (int32)

Unique ID of the UDC container

LatestImportResult
object (V1.Models.Udc.Container.ImportResult)

Import result of an UDC container

DeletedElementCount
integer (int32)

Amount of the deleted UDC elements of the import result

Duration
integer (int32)

Duration of the import in milliseconds

FeedId
integer (int32)

Unique ID of the feed of the import result

Id
integer (int32)

Unique ID of the import result

InsertedElementCount
integer (int32)

Amount of inserted UDC elements of the import result

StartTime
string (date-time)

Start time of the import result in UTC

Status
string

Import status of UDC container

Valid values[ "InProgress", "Canceled", "Failed", "Success" ]
UpdatedElementCount
integer (int32)

Amount of the updated UDC elements of the import result

Name
string

Name of the UDC container

Permissions
object

Permissions of the UDC container

Read
boolean
Write
boolean
PluginGuid
string (uuid)

Unique ID of the UDC plugin

ShortName
string

Short name of the UDC container

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401

Unauthorized

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403

Forbidden

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties