Interface ModelsListParams

Parameters for the modelsList operation.

interface ModelsListParams {
    headers?: OutgoingHttpHeaders;
    limit?: number;
    projectId?: string;
    search?: string;
    signal?: AbortSignal;
    spaceId?: string;
    start?: string;
    tagValue?: string;
}

Hierarchy

  • DefaultParams
    • ModelsListParams

Properties

headers? limit? projectId? search? signal? spaceId? start? tagValue?

Properties

Optional headers

headers?: OutgoingHttpHeaders

Optional limit

limit?: number

How many resources should be returned. By default limit is 100. Max limit allowed is 200.

Optional projectId

projectId?: string

The project that contains the resource. Either space_id or project_id query parameter has to be given.

Optional search

search?: string

Returns only resources that match this search string. The path to the field must be the complete path to the field, and this field must be one of the indexed fields for this resource type. Note that the search string must be URL encoded.

Optional signal

signal?: AbortSignal

Optional spaceId

spaceId?: string

The space that contains the resource. Either space_id or project_id query parameter has to be given.

Optional start

start?: string

Token required for token-based pagination. This token cannot be determined by end user. It is generated by the service and it is set in the href available in the next field.

Optional tagValue

tagValue?: string

Return only the resources with the given tag values, separated by or or and to support multiple tags.

Settings

Member Visibility

Theme

On This Page

headerslimitprojectIdsearchsignalspaceIdstarttagValue