Initialize the search query of UDC elements of an existing UDC container

Prev Next
Post
/v{version}/UdcDataImporters/Containers/{containerId}/Elements/search/init

You can retrieve the query result cached in the system with the returned GUID.

Security
API Key: api_key
Header parameter nameX-ApiKey

Api Key

API Key: session_id
Header parameter nameX-Session-Id

Session Id

Path parameters
containerId
integer (int32) Required

Unique ID of the UDC container

version
stringRequired

The requested API version

Body parameters

Filter containing settings for querying the UDC elements of the UDC container

Expand All
object
CategoryIds
Array of integer
integer (int32)
ElementExternalIds
Array of string
string
ElementGuids
Array of string
string (uuid)
IncludeDetails
boolean
OrderBy
object (V1.Models.Udc.InitFilter.SortCriteria)
Direction
string
Valid values[ "Asc", "Desc" ]
SortField
string
SearchText
string
Responses
200

OK

Expand All
object
Count
object
Guid
string (uuid)
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

Access denied

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

Not Found

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