Interface EventsApiEventsListRequest

Request parameters for eventsList operation in EventsApi.

Export

EventsApiEventsListRequest

interface EventsApiEventsListRequest {
    action?: "download";
    filename?: string;
    from?: string;
    jobId?: number;
    orgId?: number;
    projectId?: number;
    queryId?: string;
    taskId?: number;
    to?: string;
    userId?: number;
}

Properties

action? filename? from? jobId? orgId? projectId? queryId? taskId? to? userId?

Properties

Optional Readonlyaction

action?: "download"

Used to start downloading process after annotation file had been created

Memberof

EventsApiEventsList

Optional Readonlyfilename

filename?: string

Desired output file name

Memberof

EventsApiEventsList

Optional Readonlyfrom

from?: string

Filter events after the datetime. If no 'from' or 'to' parameters are passed, the last 30 days will be set.

Memberof

EventsApiEventsList

Optional ReadonlyjobId

jobId?: number

Filter events by job ID

Memberof

EventsApiEventsList

Optional ReadonlyorgId

orgId?: number

Filter events by organization ID

Memberof

EventsApiEventsList

Optional ReadonlyprojectId

projectId?: number

Filter events by project ID

Memberof

EventsApiEventsList

Optional ReadonlyqueryId

queryId?: string

ID of query request that need to check or download

Memberof

EventsApiEventsList

Optional ReadonlytaskId

taskId?: number

Filter events by task ID

Memberof

EventsApiEventsList

Optional Readonlyto

to?: string

Filter events before the datetime. If no 'from' or 'to' parameters are passed, the last 30 days will be set.

Memberof

EventsApiEventsList

Optional ReadonlyuserId

userId?: number

Filter events by user ID

Memberof

EventsApiEventsList

Settings

Member Visibility

On This Page

Properties