Query: flexSearchGroups

Queries for Groups 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.

filterGroupFilter

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).

flexSearchFilterGroupFlexSearchFilter
orderByGroupOrderBy

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.

postFilterGroupFilter

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
_allInnerChildrenMeta_QueryMeta

A flattened list of children and current business unit (returns a maximum of 9 layers deep).

_assetsMeta_QueryMeta

Assets belonging to the Group

_childrenMeta_QueryMeta

Child groups of this group

_cursorString

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

_productsMeta_QueryMeta

Products belonging to the Group

_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 group (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 group.

_usersMeta_QueryMeta

Users belonging to this group

allInnerChildren[Group]

A flattened list of children and current business unit (returns a maximum of 9 layers deep).

assets[Asset]

Assets belonging to the Group

children[Group]

Child groups of this group

createdAtDateTime

The instant this object has been created

createdByUser

The user who created this group

ctxEntityCtx

Context contains fields that are accesible to the permissions profile. This is an internal field related to user permissions.

deletedAtDateTime

Timestamp of when this group was deleted

idID

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

logicBombBoolean

This flag is to determine whether or not that BU should have logic bomb enabled

nameString

Name of the group

newStpPipelineBoolean

This flag is to determine whether or not that BU should have new STP pipeline enabled

organizationOrganization

The organization this Group belongs to

ownerUser

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

parentGroup

Parent group of this group

products[Product]

Products belonging to the Group

swtpOrgIdString

The base64 encoded ID of the Finit State Legacy platform organization. This is an internal field related to Finite State Binary Analysis pipeline.

uniqueTestTypes[TestingTool]

The collection of unique testing tools for this group (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 group.

updatedAtDateTime

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

users[User]

Users belonging to this group


This page was generated: 2024-05-17