Please enable JavaScript to view this site.

Discourse Data Model

Navigation: Schema: Admin > Tables

deleteGroupsByGroupIdMembers

Contents Previous Home Next More

Remove user(s) from a groupYou may use one of the following request body params to specify the user(s) to remove.

Catalog: Discourse

Schema: Admin

This is a read-only table function. The Discourse API may not support changing the data or the Invantive SQL driver for Discourse does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Discourse API.

Select Discourse API URL: /groups/{group_id}/members.json

Insert Discourse API URL: /groups/{group_id}/members.json

Update Discourse API URL: /groups/{group_id}/members.json

Delete Discourse API URL: /groups/{group_id}/members.json

Field Selection Method: NotRequired

Base Path: success

Select Discourse API Operation: delete /groups/{group_id}/members.json

Table Function Parameters

The following parameters can be used to control the behaviour of the table function deleteGroupsByGroupIdMembers. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

body

string

 

 

 

Table Function Columns

The columns of the table function deleteGroupsByGroupIdMembers are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

DUMMY

string(1)

Dummy

Default column added since the specification specifies that no data is returned.

 

12-12-2020 18:47 Version 20.1.301-BETA+3023