About objects
Objects in GraphQL represent the resources you can access. An object can contain a list of fields, which are specifically typed.
For example, the Repository object has a field called name, which is a String.
For more information, see Introduction to GraphQL.
Comment
A comment to a piece of content that supports commenting.
Comment implements
Fields for Comment
| Name | Description |
|---|---|
id (ID!) | The unique identifier for the comment. |
author (Actor) | The author of the comment or NULL if it was placed anonymously. |
bodyHtml (Html!) | The message of the comment as rendered HTML. |
created (DateTime!) | When the comment was created. |
CommentConnection
CommentConnection implements
Fields for CommentConnection
| Name | Description |
|---|---|
edges ([CommentEdge!]!) | |
nodes ([Comment!]!) | |
pageInfo (PageInfo!) |
CommentEdge
CommentEdge implements
Fields for CommentEdge
| Name | Description |
|---|---|
cursor (Cursor!) | |
node (Comment!) |
DateTime
A date and time.
Fields for DateTime
| Name | Description |
|---|---|
timestamp (Timestamp!) | The date and time as UNIX timestamp. |
Event
A type of content on Open Social which allows users to organize, discuss topics, and join activities.
Event implements
Fields for Event
| Name | Description |
|---|---|
id (ID!) | The unique identifier for the event. |
title (String!) | The display title of the event. |
author (Actor) | The author of the event. |
heroImage (Image) | A hero image for the event. |
bodyHtml (Html!) | The message of the event as rendered HTML. |
startDate (DateTime!) | The formatted start date of the event. |
endDate (DateTime) | The formatted end date of the event. When a event is not limited to a specific time period the end date may be NULL. |
location (String) | The location of the event as plain text. |
managers (EventManagerConnection!) | List of event managers. Managers are people who have the rights to edit the event itself. |
comments (CommentConnection!) | List of event comments. |
url (Url!) | The url to the event. |
created (DateTime!) | When the event was created. |
EventConnection
EventConnection implements
Fields for EventConnection
| Name | Description |
|---|---|
edges ([EventEdge!]!) | |
nodes ([Event!]!) | |
pageInfo (PageInfo!) |
EventEdge
EventEdge implements
Fields for EventEdge
| Name | Description |
|---|---|
cursor (Cursor!) | |
node (Event!) |
EventManagerConnection
Pagination info for moderators of a discussion.
EventManagerConnection implements
Fields for EventManagerConnection
| Name | Description |
|---|---|
edges ([EventManagerEdge!]!) | |
nodes ([User!]!) | |
pageInfo (PageInfo!) |
EventManagerEdge
EventManagerEdge implements
Fields for EventManagerEdge
| Name | Description |
|---|---|
cursor (Cursor!) | |
node (User!) |
File
The file, can be used in attachments (txt, pdf, doc, docx, xls, xlsx, ppt, pptx, csv and etc.).
File implements
Fields for File
| Name | Description |
|---|---|
id (ID!) | |
url (Url!) | The url at which the original file can be downloaded. |
filename (String!) | The name of the file. |
filemime (String) | The filemime type of the file. |
filesize (String) | The file size in bytes. |
created (DateTime!) | The timestamp indicating when the file was created. |
FormattedText
A longer string of text that may contain markup.
Fields for FormattedText
| Name | Description |
|---|---|
format (TextFormat!) | The text format used by Open Social to process the input text. A text format provides information about what markup is allowed in the text. |
raw (String!) | The raw string as used by an editor. |
processed (String!) | The string processed according to the text format. For a properly configured text format this string should be save to display to users. |
Image
Image implements
Fields for Image
| Name | Description |
|---|---|
id (ID!) | |
url (Url!) | The url at which the original image can be downloaded. Applications requesting the image for display to users should use one of the dedicated selectors to select a suitable image format instead. |
title (String!) | Image Title |
alt (String!) | Alt-text A description of the image that can be displayed as alternative when the image can't be loaded or to users who are unable to see the image itself. |
PageInfo
Information about the page in a connection.
Fields for PageInfo
| Name | Description |
|---|---|
hasNextPage (Boolean!) | Whether there are more pages in this connection. |
hasPreviousPage (Boolean!) | Whether there are previous pages in this connection. |
startCursor (Cursor) | The cursor for the first element in this page |
endCursor (Cursor) | The cursor for the last element in this page |
Profile
Profile information for an Open Social user.
Unless noted otherwise profile information can be filled out by a user.
Fields for Profile
| Name | Description |
|---|---|
firstName (String) | The first name of the user Can be null if the user has not filled in the field or if the user/application making the request is not allowed to view this field. |
lastName (String) | The last name of the user Can be null if the user has not filled in the field or if the user/application making the request is not allowed to view this field. |
avatar (Image) | Avatar A profile image for the user. |
introduction (FormattedText) | An introduction for the user |
phone (PhoneNumber) | A phone number for the user |
function (String) | The function the user has at their organization. |
organization (String) | The name of the organization a user belongs to. |
TextFormat
An Open Social text format.
Fields for TextFormat
| Name | Description |
|---|---|
name (String!) | The machine name of the text format. |
Topic
A type of content on Open Social which allows users to share information or organise discussions.
A topic can be a piece of news, blog, a document, or another type depending on the platform.
Topic implements
Fields for Topic
| Name | Description |
|---|---|
id (ID!) | The unique identifier for the topic. |
title (String!) | The display title of the topic. |
author (Actor) | The author of the topic. |
heroImage (Image) | A hero image for the topic. |
type (TopicType!) | The type of the topic. Each topic is tagged with a topic type to make it clear what this topic is about.
A topic can be a piece of news, a blogpost, a document, or another type depending on the platform.
To get a list of the available topic types for a platform see |
bodyHtml (Html!) | The message of the topic as rendered HTML. |
comments (CommentConnection!) | List of topic comments. If no limits are specified will limit to 10 results. |
url (Url!) | The url to the topic. |
created (DateTime!) | When the topic was created. |
TopicConnection
TopicConnection implements
Fields for TopicConnection
| Name | Description |
|---|---|
edges ([TopicEdge!]!) | |
nodes ([Topic!]!) | |
pageInfo (PageInfo!) |
TopicEdge
TopicEdge implements
Fields for TopicEdge
| Name | Description |
|---|---|
cursor (Cursor!) | |
node (Topic!) |
TopicType
The type of a topic.
Each topic is tagged with a topic type to make it clear what this topic is about. A topic can be a piece of news, a blogpost, a document, or another type depending on the platform.
Fields for TopicType
| Name | Description |
|---|---|
id (ID!) | The unique identifier for the topic type. |
label (String) | The human readable name of the topic type. |
User
An Open Social user.
User implements
Fields for User
| Name | Description |
|---|---|
id (ID!) | The Universally Unique Identifier for the user. |
displayName (String!) | The display name of the user. The specific format of the display name could depend on permissions of the requesting user or application. |
mail (Email) | The e-mail of the user. Can be null if the user has not filled in an e-mail or if the user/application making the request is not allowed to view this user's e-mail. |
created (Int!) | The timestamp indicating when the user was created. |
updated (Int!) | The timestamp indicating when the user was last updated. |
status (UserStatus!) | The status of the user account. |
roles ([UserRole!]!) | The roles that the user has. |
commentsCreated (Int!) | The number of comments that the user has created on the platform. This only counts comments that still exist on the platform and where the user is set as author. |
eventsCreated (Int!) | The number of events that the user has created on the platform. This only counts events that still exist on the platform and where the user is set as author. |
likes (Int!) | The number of likes that the user has created on the platform. This only counts likes that still exist on the platform and where the user is set as author. |
postsCreated (Int!) | The number of posts that the user has created on the platform. This only counts posts that still exist on the platform and where the user is set as author. |
profile (Profile!) | Profile data for the user. |
topicsCreated (Int!) | The number of topics that the user has created on the platform. This only counts topics that still exist on the platform and where the user is set as author. |
flexibleGroupMembership (Int!) | The number of flexibleGroupMembership that the user has created on the platform. This only counts flexibleGroupMembership that still exist on the platform and where the user is set as author. |
UserConnection
UserConnection implements
Fields for UserConnection
| Name | Description |
|---|---|
edges ([UserEdge!]!) | |
nodes ([User!]!) | |
pageInfo (PageInfo!) |
UserEdge
UserEdge implements
Fields for UserEdge
| Name | Description |
|---|---|
cursor (Cursor!) | |
node (User!) |