invantive documentation
Invantive Support ForumsLog In / Sign Up

GroupsByName: Discourse Group by Name

read only REST

  • Catalog: Discourse
  • Schema: Groups
  • Label: Group by Name

Get a specific group.

Can only retrieve data.

Summary

Get a specific group.

API Source

  • Endpoint: /groups/{name}.json
  • Operation: get /groups/{name}.json

Performance Characteristics

Characteristic Value
Average access latency (ms) 243
Write rows per minute 219

The result can be cached on the client.

Parameters

Name Data Type Required Default Documentation
name ``

Table Columns

The columns of the table GroupsByName are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
group_allow_membership_requests char Group Allow Membership Requests filters on the platform, writable, group.allow_membership_requests
group_allow_unknown_sender_topic_replies char Group Allow Unknown Sender Topic Replies filters on the platform, writable, group.allow_unknown_sender_topic_replies
group_automatic char Group Automatic filters on the platform, writable, group.automatic
group_automatic_membership_email_domains varchar2 Group Automatic Membership Email Domains writable The JSON text of the nested object.
group_automatic_membership_retroactive char Group Automatic Membership Retroactive filters on the platform, writable, group.automatic_membership_retroactive
group_bio_cooked varchar2 Group Bio Cooked writable The JSON text of the nested object.
group_bio_raw varchar2 Group Bio Raw writable The JSON text of the nested object.
group_can_admin_group char Group Can Admin Group filters on the platform, writable, group.can_admin_group
group_can_see_members char Group Can See Members filters on the platform, writable, group.can_see_members
group_default_notification_level decimal Group Default Notification Level filters on the platform, writable, group.default_notification_level
group_flair_bg_color varchar2 Group Flair Background Color writable The JSON text of the nested object.
group_flair_color varchar2 Group Flair Color writable The JSON text of the nested object.
group_flair_url varchar2 Group Flair URL writable The JSON text of the nested object.
group_full_name varchar2 Group Full Name filters on the platform, writable, group.full_name
group_grant_trust_level varchar2 Group Grant Trust Level writable The JSON text of the nested object.
group_has_messages char Group Has Messages filters on the platform, writable, group.has_messages
group_id decimal Group ID filters on the platform, writable, group.id
group_imap_mailbox_name varchar2 Group IMAP Mailbox Name filters on the platform, writable, group.imap_mailbox_name
group_incoming_email varchar2 Group Incoming Email writable The JSON text of the nested object.
group_is_group_owner char Group is Group Owner filters on the platform, writable, group.is_group_owner
group_is_group_owner_display char Group Is Group Owner Display filters on the platform, writable, group.is_group_owner_display
group_is_group_user char Group is Group User filters on the platform, writable, group.is_group_user
group_members_visibility_level int32 Group Members Visibility Level filters on the platform, writable, group.members_visibility_level
group_membership_request_template varchar2 Group Membership Request Template writable The JSON text of the nested object.
group_mentionable char Group Mentionable filters on the platform, writable, group.mentionable
group_mentionable_level decimal Group Mentionable Level filters on the platform, writable, group.mentionable_level
group_message_count int32 Group Message Count filters on the platform, writable, group.message_count
group_messageable char Group Messageable filters on the platform, writable, group.messageable
group_messageable_level decimal Group Messageable Level filters on the platform, writable, group.messageable_level
group_name varchar2 Group Name filters on the platform, writable, group.name
group_primary_group char Group Primary Group filters on the platform, writable, group.primary_group
group_public_admission char Group Public Admission filters on the platform, writable, group.public_admission
group_public_exit char Group Public Exit filters on the platform, writable, group.public_exit
group_publish_read_state char Group Publish Read State filters on the platform, writable, group.publish_read_state
group_title varchar2 Group Title writable The JSON text of the nested object.
group_user_count decimal Group User Count filters on the platform, writable, group.user_count
group_visibility_level decimal Group Visibility Level filters on the platform, writable, group.visibility_level

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver:

Changes of This Table, 26.0 to 27.0

  • - group_automatic_membership_retroactive
  • ~ group_default_notification_level (database_data_type: decimal → int64)
  • ~ group_default_notification_level (dotnet_data_type: decimal → int64)
  • ~ group_id (database_data_type: decimal → int64)
  • ~ group_id (dotnet_data_type: decimal → int64)
  • - group_is_group_owner
  • ~ group_members_visibility_level (database_data_type: int32 → int64)
  • ~ group_members_visibility_level (dotnet_data_type: int32 → int64)
  • ~ group_mentionable_level (database_data_type: decimal → int64)
  • ~ group_mentionable_level (dotnet_data_type: decimal → int64)
  • ~ group_message_count (database_data_type: int32 → int64)
  • ~ group_message_count (dotnet_data_type: int32 → int64)
  • ~ group_messageable_level (database_data_type: decimal → int64)
  • ~ group_messageable_level (dotnet_data_type: decimal → int64)
  • ~ group_user_count (database_data_type: decimal → int64)

14 more changes

  • ~ group_user_count (dotnet_data_type: decimal → int64)
  • ~ group_visibility_level (database_data_type: decimal → int64)
  • ~ group_visibility_level (dotnet_data_type: decimal → int64)
  • + group_bio_excerpt (varchar2)
  • + group_can_edit_group (char)
  • + group_email_from_alias (varchar2)
  • + group_email_password (varchar2)
  • + group_email_username (varchar2)
  • + group_smtp_enabled (char)
  • + group_smtp_port (varchar2)
  • + group_smtp_server (varchar2)
  • + group_smtp_ssl_mode (int64)
  • + group_smtp_updated_at (varchar2)
  • + group_smtp_updated_by (varchar2)

All changes of the driver, 26.0 to 27.0