Interface OrganizationsApiOrganizationsListRequest

Request parameters for organizationsList operation in OrganizationsApi.

Export

OrganizationsApiOrganizationsListRequest

interface OrganizationsApiOrganizationsListRequest {
    filter?: string;
    name?: string;
    owner?: string;
    page?: number;
    pageSize?: number;
    search?: string;
    slug?: string;
    sort?: string;
}

Index

Properties

filter? name? owner? page? pageSize? search? slug? sort?

Properties

`Optional` `Readonly`filter

filter?: string

JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {"and":[{"==":[{"var":"owner"},"<user>"]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: ['name', 'owner', 'slug', 'id'].

Memberof

OrganizationsApiOrganizationsList

`Optional` `Readonly`name

name?: string

A simple equality filter for the name field

Memberof

OrganizationsApiOrganizationsList

`Optional` `Readonly`owner

owner?: string

A simple equality filter for the owner field

Memberof

OrganizationsApiOrganizationsList

`Optional` `Readonly`page

page?: number

A page number within the paginated result set.

Memberof

OrganizationsApiOrganizationsList

`Optional` `Readonly`pageSize

pageSize?: number

Number of results to return per page.

Memberof

OrganizationsApiOrganizationsList

`Optional` `Readonly`search

search?: string

A search term. Available search_fields: ('name', 'owner', 'slug')

Memberof

OrganizationsApiOrganizationsList

`Optional` `Readonly`slug

slug?: string

A simple equality filter for the slug field

Memberof

OrganizationsApiOrganizationsList

`Optional` `Readonly`sort

sort?: string

Which field to use when ordering the results. Available ordering_fields: ['name', 'owner', 'slug', 'id']

Memberof

OrganizationsApiOrganizationsList