GetEntityPlainArgs

data class GetEntityPlainArgs(val filter: String? = null, val groupName: String? = null, val search: String? = null, val select: String? = null, val skip: Int? = null, val skiptoken: String? = null, val top: Int? = null, val view: String? = null) : ConvertibleToJava<GetEntityPlainArgs>

Constructors

Link copied to clipboard
constructor(filter: String? = null, groupName: String? = null, search: String? = null, select: String? = null, skip: Int? = null, skiptoken: String? = null, top: Int? = null, view: String? = null)

Properties

Link copied to clipboard
val filter: String? = null

The filter parameter allows you to filter on the the name or display name fields. You can check for equality on the name field (e.g. name eq '{entityName}') and you can check for substrings on either the name or display name fields(e.g. contains(name, '{substringToSearch}'), contains(displayName, '{substringToSearch')). Note that the '{entityName}' and '{substringToSearch}' fields are checked case insensitively.

Link copied to clipboard
val groupName: String? = null

A filter which allows the get entities call to focus on a particular group (i.e. "$filter=name eq 'groupName'")

Link copied to clipboard
val search: String? = null

The $search parameter is used in conjunction with the $filter parameter to return three different outputs depending on the parameter passed in. With $search=AllowedParents the API will return the entity info of all groups that the requested entity will be able to reparent to as determined by the user's permissions. With $search=AllowedChildren the API will return the entity info of all entities that can be added as children of the requested entity. With $search=ParentAndFirstLevelChildren the API will return the parent and first level of children that the user has either direct access to or indirect access via one of their descendants. With $search=ParentOnly the API will return only the group if the user has access to at least one of the descendants of the group. With $search=ChildrenOnly the API will return only the first level of children of the group entity info specified in $filter. The user must have direct access to the children entities or one of it's descendants for it to show up in the results.

Link copied to clipboard
val select: String? = null

This parameter specifies the fields to include in the response. Can include any combination of Name,DisplayName,Type,ParentDisplayNameChain,ParentChain, e.g. '$select=Name,DisplayName,Type,ParentDisplayNameChain,ParentNameChain'. When specified the $select parameter can override select in $skipToken.

Link copied to clipboard
val skip: Int? = null

Number of entities to skip over when retrieving results. Passing this in will override $skipToken.

Link copied to clipboard
val skiptoken: String? = null

Page continuation token is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a token parameter that specifies a starting point to use for subsequent calls.

Link copied to clipboard
val top: Int? = null

Number of elements to return when retrieving results. Passing this in will override $skipToken.

Link copied to clipboard
val view: String? = null

The view parameter allows clients to filter the type of data that is returned by the getEntities call.

Functions

Link copied to clipboard
open override fun toJava(): GetEntityPlainArgs