Interface DataKioskApiModelQuery

Detailed information about the query.

Export

Query

interface DataKioskApiModelQuery {
    createdTime: string;
    dataDocumentId?: string;
    errorDocumentId?: string;
    pagination?: DataKioskApiModelQueryPagination;
    processingEndTime?: string;
    processingStartTime?: string;
    processingStatus:
        | "CANCELLED"
        | DataKioskApiModelQueryProcessingStatusEnum
        | "DONE"
        | "FATAL"
        | "IN_PROGRESS"
        | "IN_QUEUE";
    query: string;
    queryId: string;
}

Properties

createdTime dataDocumentId? errorDocumentId? pagination? processingEndTime? processingStartTime? processingStatus query queryId

Properties

createdTime

createdTime: string

The date and time when the query was created, in ISO 8601 date time format.

Memberof

Query

OptionaldataDocumentId

dataDocumentId?: string

The data document identifier. This identifier is only present when there is data available as a result of the query. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the getDocument operation to get the information required to retrieve the data document's contents.

Memberof

Query

OptionalerrorDocumentId

errorDocumentId?: string

The error document identifier. This identifier is only present when an error occurs during query processing. This identifier is unique only in combination with a selling partner account ID. Pass this identifier into the getDocument operation to get the information required to retrieve the error document's contents.

Memberof

Query

Optionalpagination

pagination?: DataKioskApiModelQueryPagination

Memberof

Query

OptionalprocessingEndTime

processingEndTime?: string

The date and time when the query processing completed, in ISO 8601 date time format.

Memberof

Query

OptionalprocessingStartTime

processingStartTime?: string

The date and time when the query processing started, in ISO 8601 date time format.

Memberof

Query

processingStatus

processingStatus:
    | "CANCELLED"
    | DataKioskApiModelQueryProcessingStatusEnum
    | "DONE"
    | "FATAL"
    | "IN_PROGRESS"
    | "IN_QUEUE"

The processing status of the query.

Memberof

Query

query

query: string

The submitted query.

Memberof

Query

queryId

queryId: string

The query identifier. This identifier is unique only in combination with a selling partner account ID.

Memberof

Query

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR