Skip to main content

Function: RolesApiFactory

clients/platform-client/src.RolesApiFactory

RolesApiFactory(configuration?, basePath?, axios?): object

RolesApi - factory interface

Parameters​

▪ configuration?: Configuration

▪ basePath?: string

▪ axios?: AxiosInstance

Returns​

object

rolesControllerCreate​

Parameters​

▪ CreateUserRole: CreateUserRole

▪ options?: any

Override http request option.

Returns​

AxiosPromise<CustomUserRoleWithoutPermissionsDto>

Throws​

rolesControllerFindAll​

Parameters​

▪ page?: number

Page number to retrieve.If you provide invalid value the default page number will applied <p> <b>Example: </b> 1 </p> <p> <b>Default Value: </b> 1 </p>

▪ limit?: number

Number of records per page. <p> <b>Example: </b> 20 </p> <p> <b>Default Value: </b> 50 </p> <p> <b>Max Value: </b> 100 </p> If provided value is greater than max value, max value will be applied.

▪ filter_id?: string[]

Filter by id query param. <p> <b>Format: </b> filter.id={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.id=$not:$like:John Doe&filter.id=like:John </p> <h4>Available Operations</h4><ul><li>$eq</li> <li>$in</li></ul>

▪ filter_name?: string[]

Filter by name query param. <p> <b>Format: </b> filter.name={$not}:OPERATION:VALUE </p> <p> <b>Example: </b> filter.name=$not:$like:John Doe&filter.name=like:John </p> <h4>Available Operations</h4><ul><li>$contains</li></ul>

▪ sortBy?: string[]

Parameter to sort by. <p>To sort by multiple fields, just provide query param multiple types. The order in url defines an order of sorting</p> <p> <b>Format: </b> fieldName:DIRECTION </p> <p> <b>Example: </b> sortBy=id:DESC&sortBy=createdAt:ASC </p> <p> <b>Default Value: </b> createdAt:DESC,id:DESC </p> <h4>Available Fields</h4><ul><li>id</li> <li>name</li> <li>createdAt</li> <li>updatedAt</li></ul>

▪ search?: string

Search term to filter result values <p> <b>Example: </b> John </p> <p> <b>Default Value: </b> No default value </p>

▪ searchBy?: string

List of fields to search by term to filter result values <p> <b>Example: </b> name,roleType </p> <p> <b>Default Value: </b> By default all fields mentioned below will be used to search by term </p> <h4>Available Fields</h4><ul><li>name</li> <li>roleType</li></ul>

▪ select?: string

List of fields to select. <p> <b>Example: </b> id,name,createdAt,updatedAt,roleType </p> <p> <b>Default Value: </b> By default all fields returns. If you want to select only some fields, provide them in query param </p>

▪ options?: any

Override http request option.

Returns​

AxiosPromise<RolesControllerFindAll200Response>

Throws​

rolesControllerFindOne​

Parameters​

▪ id: string

Entity id, uuid v4 format

▪ options?: any

Override http request option.

Returns​

AxiosPromise<CustomUserRoleWithoutPermissionsDto>

Throws​

rolesControllerSoftDelete​

Parameters​

▪ id: string

Entity id, uuid v4 format

▪ version: number

Version number of entity that you want to delete

▪ options?: any

Override http request option.

Returns​

AxiosPromise<boolean>

Throws​

rolesControllerTestProxy​

Parameters​

▪ options?: any

Override http request option.

Returns​

AxiosPromise<object>

Throws​

rolesControllerUpdateOne​

Parameters​

▪ id: string

Entity id, uuid v4 format

▪ UpdateUserRole: UpdateUserRole

▪ options?: any

Override http request option.

Returns​

AxiosPromise<CustomUserRoleWithoutPermissionsDto>

Throws​

Export​

Source​

libs/clients/platform-client/src/lib/generated/api.ts:1723

Generated using typedoc-plugin-markdown and TypeDoc