Query: flexSearchOrganizations

Queries for Organizations using FlexSearch.

Return Type




Args

NameTypeDescription
afterString

If this is set to the value of the _cursor field of an item, only items after that one will be included in the result. The value of the after of this query must match the one where the _cursor value has been retrieved from.

filterOrganizationFilter

Renamed to postFilter. Use postFilter instead.

firstInt

The number of items to include in the result. If omitted, all remaining items will be included (which can cause performance problems on large collections).

flexSearchFilterOrganizationFlexSearchFilter
orderByOrganizationOrderBy

Specifies the how this collection should be sorted. If omitted, the result order is not specified. If cursor-based pagination is used (i.e., the after is specified or the _cursor is requested), id_ASC will be implicitly added as last sort criterion so that the sort order is deterministic.

postFilterOrganizationFilter

Filters that will be applied in memory after the flexSearchFilter.

This will not use any indices and will only work if applied on less than 10 000 objects.

skipInt

The number of items in the list or collection to skip. Is applied after the after argument if both are specified.


Properties

NameTypeDescription
_cursorString

Provides a value that can be supplied to the after argument for pagination. Depends on the value of the orderBy argument.

_groupsMeta_QueryMeta

All groups / business units belonging to this organization, regardless of whether they're parent or child groups

_revisionID

An identifier that is updated automatically on each update of this root entity (but not on relation changes)

_uniqueTestTypesMeta_QueryMeta

The collection of unique testing tools for this organization (e.g. Finite State Binary Analysis, Snyk Scan, etc.). This is used to determine which tools have been used to scan the Artifacts in this organization.

_usersMeta_QueryMeta

Users belonging to this organization

createdAtDateTime

The instant this object has been created

cvesLastUpdatedDateTime

CVEs last updated.

defaultSwtpOrgIdString

Default legacy organization ID used when creating new groups/business units. This is an internal field related to integrating the Finite State Binary Analysis tool.

groups[Group]

All groups / business units belonging to this organization, regardless of whether they're parent or child groups

iconString

URL pointing to an icon associated with this Organization

idID

An auto-generated string that identifies this root entity uniquely among others of the same type

imageString

URL pointing to an image for this Organization

nameString

Name of the organization

ownerUser

The owner of this organization. This user has permission to invite new users to the organization, set permissions, and assign other Admins.

uniqueTestTypes[TestingTool]

The collection of unique testing tools for this organization (e.g. Finite State Binary Analysis, Snyk Scan, etc.). This is used to determine which tools have been used to scan the Artifacts in this organization.

updatedAtDateTime

The instant this object has been updated the last time (not including relation updates)

users[User]

Users belonging to this organization


This page was generated: 2024-05-17