6.0.0 • Published 5 years ago

@datafire/circuitsandbox v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/circuitsandbox

Client library for REST API Version 2

Installation and Usage

npm install --save @datafire/circuitsandbox
let circuitsandbox = require('@datafire/circuitsandbox').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Circuit REST API to interact with the Circuit system.

Learn more about the Circuit Development Community

Actions

getConversations

Gets a list of conversations and communities the authenticated user participates in. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getConversations({}, context)

Input

  • input object
    • modTime string: The modification time of the conversation in UTC format. During the query the conversations before (default) or after this timestamp are returned. In case no timestamp is specified the current server time in UTC is used, i.e. the last 25 modified conversations are returned
    • direction string (values: BEFORE, AFTER): The direction of the search based on the modification time. Valid values are either BEFORE (default) or AFTER
    • results number: The maximum number of returned results (default 25). The maximum allowed value is 100.

Output

getCommunityConversations

Gets a list of communities. This endpoint can be used to explore the communities the authenticated user could join. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getCommunityConversations({}, context)

Input

  • input object
    • sort string (values: ALPHABETICALLY, RECENT_ACTIVITY, POPULARITY): Defines the type of sorting for the community conversations (default is alphabetical)
    • order string (values: ASCENDING, DESCENDING): Defines the ordering of the conversations (default is ascending)
    • includeOwn boolean: If set to false only conversations are returned where the user is no member of, otherwise all community conversations are returned
    • startIndex number: The index of the conversation that is the first one that has to be returned. E.g. if a request starts with startIndex 40 and results 20 the conversations 40 to 60 are returned
    • results number: The maximum number of returned results (default 25). The maximum allowed value is 100.

Output

createCommunityConversation

Creates a community. Communities are open conversations that anyone in a Circuit domain (tenant) can join without having to be added by another user. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.createCommunityConversation({
  "topic": ""
}, context)

Input

  • input object
    • participants array: list of participants that will be part of this conversation, specified by the Circuit user ID or the unique email address. At least one participant needs to be added
    • description string: An optional description for the community conversation
    • topic required string: An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)

Output

updateConversationCommunity

Updates the information of the given community. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.updateConversationCommunity({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which should be updated
    • description string: An optional description for the community conversation
    • topic string: An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)

Output

joinCommunityConversation

Adds the authenticated user to the given community (i.e., allows the user to join this community). Contrary to the operation of adding a new participant, this operation can only be performed by a user who is not yet a member of the community. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.joinCommunityConversation({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which the user will join

Output

removeParticipantCommunity

Removes one or more participants from the given community. The last participant of a community cannot be removed. This operation can only be performed by a user who is already a member of the community. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.removeParticipantCommunity({
  "convId": "",
  "participants": []
}, context)

Input

  • input object
    • convId required string: The ID of the conversation from which the participant have to be removed
    • participants required array: The IDs or the unique email addresses of the Circuit users that have to be removed

Output

addParticipantCommunity

Adds one or more participants to the given community. This operation can only be performed by a user who is already a member of the community. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.addParticipantCommunity({
  "convId": "",
  "participants": []
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the participant has to be added.
    • participants required array: The IDs or the unique email addresses of the Circuit users that should to be added.

Output

getDirectConversation

Checks if a 1-to-1 conversation between the authenticated user and the user with the provided userId exists. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getDirectConversation({
  "participant": ""
}, context)

Input

  • input object
    • participant required string: The participant that will be part of this conversation together with the creator, specified by the Circuit user ID or the unique email address

Output

createDirectConversation

Creates a 1-to-1 conversation between the authenticated user and the user with the provided userId. In case there is already an existing 1-to-1 conversation between these users, the endpoint returns the existing conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.createDirectConversation({
  "participant": ""
}, context)

Input

  • input object
    • participant required string: The participant that will be part of this conversation together with the creator, specified by the Circuit user ID or the unique email address

Output

getFavoriteConversations

Gets the conversationIds which are marked as favorites. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getFavoriteConversations(null, context)

Input

This action has no parameters

Output

createGroupConversation

Creates a group conversation between three or more users. The authenticated user is directly added to this conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.createGroupConversation({
  "participants": []
}, context)

Input

  • input object
    • participants required array: A list of participants that will be part of this conversation, specified by the Circuit user ID or the unique email address. At least one participant needs to be added
    • topic string: An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)

Output

updateConversationGroup

Updates the information of the given group conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.updateConversationGroup({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which should be updated
    • topic string: An optional topic of the conversation. If not set the Circuit client will render the names of the participants as topic of the conversation (the first 4 names will be used)

Output

removeParticipantGroup

Removes one or more participants from the given group conversation. The last participant of a group conversation cannot be removed. This operation can only be performed on behalf of a user who is already a member of the conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.removeParticipantGroup({
  "convId": "",
  "participants": []
}, context)

Input

  • input object
    • convId required string: The ID of the conversation from which the participant have to be removed
    • participants required array: The IDs or the unique email addresses of the Circuit users that have to be removed

Output

addParticipantGroup

Adds one or more participants to the given group conversation. This operation can only be performed by a user who is already a member of the conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.addParticipantGroup({
  "convId": "",
  "participants": []
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the participant has to be added.
    • participants required array: The IDs or the unique email addresses of the Circuit users that should to be added.

Output

getConversationsByLabel

Returns conversations with matching labels and paginated OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getConversationsByLabel({
  "labelId": ""
}, context)

Input

  • input object
    • labelId required string: Id of the label to look for
    • nextPagePointer string: Pointer to the next page of conversations if there are any
    • pageSize number: Numbers of max conversations per page

Output

getFlagItemConv

Gets a list of all the messages the authenticated user has flagged. This endpoint should be used carefully in case where the authenticated user has a lot of flagged messages. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getFlagItemConv(null, context)

Input

This action has no parameters

Output

getSingleConversationtem

Returns a text item for a given item id OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getSingleConversationtem({
  "itemId": ""
}, context)

Input

  • input object
    • itemId required string: The ID of the item that will be returned

Output

moderateConversation

Set a conversation in moderatd mode. Moderators can be added and removed OauthScopes: ALL, WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS

circuitsandbox.moderateConversation({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which will be set to moderated state

Output

Output schema unknown

resolveInvitationToken

Resolves an invite token to a conversation OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.resolveInvitationToken({
  "token": ""
}, context)

Input

  • input object
    • token required string: The invite token to resolve

Output

searchConversations

Performs a search for conversation content. A maximum of 100 conversations is returned. If you hit this limit you should refine the search term. OauthScopes: ALL, WRITE_CONVERSATIONS

circuitsandbox.searchConversations({
  "term": ""
}, context)

Input

  • input object
    • term required string: The search term
    • includeItemIds boolean: Optional parameter to specify if a deep or normal search is executed. In a deep search all matching item IDs inside every conversation are returned (up to a maximum of 100). For a normal search only the conversation IDs are returned. Default is a normal search (without item IDs).

Output

unmoderateConversation

Set a conversation to unmoderatd mode OauthScopes: ALL, WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS

circuitsandbox.unmoderateConversation({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which will be set to unmoderated state

Output

Output schema unknown

getConversationbyId

Gets a conversation based on the given ID. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getConversationbyId({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which should be updated

Output

getJoinDetails

Gets the conference details of the given conversation. Conference details include the URL, which is used to join the conference through a web or mobile application, as well as the dial-in phone numbers and conference PIN, which are used to join the conference by phone. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getJoinDetails({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation for which the join details should be returned

Output

deleteFavorite

Removes a conversation from favorites. Favorites can be displayed in a separate side tab inside of the Circuit client to have a better overview of important conversations. OauthScopes: ALL, WRITE_CONVERSATIONS

circuitsandbox.deleteFavorite({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which will be unmarked as favorite

Output

Output schema unknown

addFavorite

Adds a conversation to the favorites. Favorites can be displayed in a separate side tab inside of the Circuit client to have a better overview of important conversations. OauthScopes: ALL, WRITE_CONVERSATIONS

circuitsandbox.addFavorite({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation which will be marked as favorite

Output

Output schema unknown

getConversationItems

Gets a list of conversation items. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getConversationItems({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the items belong
    • modTime string: The modification time of the item in UTC format. During the query the items before (default) or after this timestamps are returned. In case no timestamp is specified the current server time in UTC is used, i.e. the last 25 modified items are returned
    • direction string (values: BEFORE, AFTER): The direction of the search based on the modification time. Valid values are either BEFORE (default) or AFTER
    • results number: The maximum number of returned results (default 25). The maximum allowed value is 100.

Output

assignLabel

Adds a label to a conversation, you can search and organize your conversations based on these labels OauthScopes: ALL, WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS

circuitsandbox.assignLabel({
  "convId": "",
  "label": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the label is added
    • label required string: The actual label

Output

unassignLabel

Removes a label from a conversation, you can search and organize your conversations based on these labels OauthScopes: ALL, WRITE_CONVERSATIONS

circuitsandbox.unassignLabel({
  "convId": "",
  "labelId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation from which the label is removed
    • labelId required string: The actual label

Output

addTextItem

Adds a message to the given conversation. This operation can be only performed on behalf of a user who is already a member of the conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, CREATE_CONVERSATIONS_CONTENT

circuitsandbox.addTextItem({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the new item has to be added
    • content string: The actual content of the item, is mandatory unless an attachment is added
    • attachments array: A comma separated list of attachment IDs from the file API.
    • subject string: The subject (headline) of the new text item
    • formMetaData string: The form meta data of the new text item

Output

getFlagItem

Gets a list of all the flagged messages in the given conversation. OauthScopes: ALL, READ_CONVERSATIONS, ORGANIZE_CONVERSATIONS

circuitsandbox.getFlagItem({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the item belongs

Output

deleteTextItem

Marks a message in the given conversation as deleted. Deleted messages are still part of the conversation, but their content is no more visible. This operation can only be performed on behalf of the message's creator. OauthScopes: ALL, WRITE_CONVERSATIONS, DELETE_CONVERSATIONS_CONTENT

circuitsandbox.deleteTextItem({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the item belongs
    • itemId required string: The ID of the item that will be deleted

Output

addTextItemWithParent

Adds a message to the existing item. The added message will be a child item of the message with the given itemId. OauthScopes: ALL, WRITE_CONVERSATIONS

circuitsandbox.addTextItemWithParent({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the new item has to be added
    • itemId required string: The ID of the item to which the new one has to be added as child
    • content string: The actual content of the item
    • attachments array: A comma separated list of attachment IDs from the file API.
    • subject string: The subject (headline) of the new text item
    • formMetaData string: The form meta data of the new text item

Output

updateTextItem

Updates the content or subject of the existing message. Only the creator of the message is allowed to perform this operation. OauthScopes: ALL, WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT

circuitsandbox.updateTextItem({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the item belongs
    • itemId required string: The ID of the item to update
    • content string: The actual content of the item
    • attachments array: A comma separated list of attachment IDs from the file API.
    • subject string: The subject (headline) of the new text item
    • formMetaData string: The form meta data of the new text item

Output

unFlagItem

Removes the flag from a given message that is posted to the given conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS

circuitsandbox.unFlagItem({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the item belongs
    • itemId required string: The ID of the item that will be flagged

Output

Output schema unknown

flagItem

Adds a flag to the given message in the given conversation. OauthScopes: ALL, WRITE_CONVERSATIONS, ORGANIZE_CONVERSATIONS

circuitsandbox.flagItem({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the item belongs
    • itemId required string: The ID of the item that will be flagged
    • itemCreationTime string: The time when the item was created
    • parentId string: The ID of the item's parent

Output

Output schema unknown

unlikeItem

Removes a "like" from the given message in the given conversation OauthScopes: ALL, WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT

circuitsandbox.unlikeItem({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the item belongs
    • itemId required string: The ID of the item that will be unliked

Output

Output schema unknown

likeItem

Adds a "like" to the given message in the given conversation OauthScopes: ALL, WRITE_CONVERSATIONS, UPDATE_CONVERSATION_CONTENT

circuitsandbox.likeItem({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the item belongs
    • itemId required string: The ID of the item that will be liked

Output

Output schema unknown

removeModerators

Removes a list of moderators from a conversation OauthScopes: ALL, WRITE_CONVERSATIONS, MODERATE_CONVERSATIONS

circuitsandbox.removeModerators({
  "convId": "",
  "moderators": []
}, context)

Input

  • input object
    • convId required string: The ID of the conversation where the moderators are removed
    • moderators required array: The list of moderator ids to remove

Output

Output schema unknown

addModerators

Adds a list of moderators to a conversation OauthScopes: ALL, WRITE_CONVERSATIONS, MANAGE_CONVERSATIONS

circuitsandbox.addModerators({
  "convId": "",
  "moderators": []
}, context)

Input

  • input object
    • convId required string: The ID of the conversation to which the moderators are added
    • moderators required array: The list of moderator ids to add

Output

Output schema unknown

getParticipantsByConvId

Performs a search for participants. The max number of participants is configurable. If more participants are available a search pointer is returned for consecutive calls. OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getParticipantsByConvId({
  "convId": "",
  "pageSize": 0
}, context)

Input

  • input object
    • convId required string: The id of the conversation the participants are searched for.
    • pageSize required number: The page size of the hit list
    • name string: Part of name to filter the results
    • type string (values: REGULAR, MODERATOR, GUEST, FORMER, BOT): Type of participant to filter the results
    • searchPointer string: Pointer for paged output. Add to consecutive request to get next page

Output

getPinnedConversations

Returns pinned topics of a conversation OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.getPinnedConversations({
  "convId": ""
}, context)

Input

  • input object
    • convId required string: ID of the conversation

Output

unPinAConversation

Unpins a topic of a conversation OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.unPinAConversation({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation
    • itemId required string: The ID of the topic

Output

pinAConversation

Pins a topic of a conversation OauthScopes: ALL, READ_CONVERSATIONS

circuitsandbox.pinAConversation({
  "convId": "",
  "itemId": ""
}, context)

Input

  • input object
    • convId required string: The ID of the conversation
    • itemId required string: The ID of the topic

Output

getActiveSessions

Gets a list of active RTCsessions OauthScopes: ALL, CALLS

circuitsandbox.getActiveSessions(null, context)

Input

This action has no parameters

Output

getSpaces

Get the spaces OauthScopes: ALL

circuitsandbox.getSpaces({}, context)

Input

  • input object
    • timestamp string: a beautiful timestamp
    • numberOfResults number: the number of results you want

Output

createSpace

Create a space OauthScopes: ALL

circuitsandbox.createSpace({
  "name": "",
  "accessModeType": "",
  "status": "",
  "role": "",
  "type": ""
}, context)

Input

  • input object
    • name required string: name of the space
    • description string: description of the space
    • tags array: tags of the space
    • accessModeType required string (values: INTERNAL_ONLY, INTERNAL_EXTERNAL): Access mode
    • status required string (values: ENABLED, DISABLED): status
    • role required string (values: MODERATOR, AUTHOR, PARTICIPANT, READER): role
    • type required string (values: OPEN, CLOSED, SECRET): type
    • largePictureBase64 string: large picture
    • smallPictureBase64 string: small picture

Output

getDirectory

Get the directory by a search query in ordered way OauthScopes: ALL

circuitsandbox.getDirectory({
  "sortBy": "",
  "sortOrder": "",
  "filter": ""
}, context)

Input

  • input object
    • sortBy required string (values: LAST_CONTENT, NAME, NUMBER_OF_USERS, CREATION_DATE): sort the spaces by LAST_CONTENT, NAME, NUMBER_OF_USERS or CREATION_DATE
    • sortOrder required string (values: ASCENDING, DESCENDING): ascending or descending
    • filter required string (values: NONE, JOINED, REQUESTED, OPEN, CLOSED, NOT_JOINED_REQUESTED): filter for spaces (JOINED, REQUESTED, OPEN, CLOSED or NOT_JOINED_REQUESTED)
    • query string: some sort of query
    • pagePointer string: page pointer, start with nothing and for next query use returned pointer
    • numberOfResults number: number of results to return, 25 by default.

Output

existsSpaceName

Find out if a space name already exists for non-secret spaces. OauthScopes: ALL

circuitsandbox.existsSpaceName({
  "name": ""
}, context)

Input

  • input object
    • name required string: The name to check for existence.

Output

Output schema unknown

flagSpaceItem

flag a space item OauthScopes: ALL

circuitsandbox.flagSpaceItem({
  "itemId": ""
}, context)

Input

  • input object
    • itemId required string: the id of the item you want to flag

Output

Output schema unknown

getFlaggedItems

Get flagged items OauthScopes: ALL

circuitsandbox.getFlaggedItems({
  "searchDirection": "",
  "timestamp": ""
}, context)

Input

  • input object
    • searchDirection required string (values: BEFORE, AFTER): before or after the time stamp
    • timestamp required string: The timestamp according to which you want to retrieve the flagged items
    • searchPointer string: The searchpointer for the search (initially not set).
    • numberOfResults number: The number of results you want to retrieve.

Output

getSpacesByIds

Get the spaces by their ids OauthScopes: ALL

circuitsandbox.getSpacesByIds({
  "ids": []
}, context)

Input

  • input object
    • ids required array: an array of ids

Output

deleteSpaceItem

deletes a space item OauthScopes: ALL

circuitsandbox.deleteSpaceItem({
  "itemId": ""
}, context)

Input

  • input object
    • itemId required string: the id of the spaceItem

Output

Output schema unknown

likeSpaceItem

Like a space item OauthScopes: ALL

circuitsandbox.likeSpaceItem({
  "itemId": ""
}, context)

Input

  • input object
    • itemId required string: The id of the item you want to like

Output

Output schema unknown

getLikes

Get the likes of an item OauthScopes: ALL

circuitsandbox.getLikes({
  "itemId": ""
}, context)

Input

  • input object
    • itemId required string: The id of the item to retrieve the likes from
    • searchPointer string: The searchpointer for the search (initially not set).
    • numberOfResults number: The number of results you want to retrieve.

Output

addRecentSpaceSearch

Add recent search of a client to search controller. OauthScopes: ALL

circuitsandbox.addRecentSpaceSearch({
  "scope": "",
  "searchTerm": ""
}, context)

Input

  • input object
    • scope required string (values: ALL, SPACES, TOPICBY, FILES, TAGS, LABELS, DATE): The scope of the search.
    • searchTerm required string: The term to search for.
    • startTime string: The start time.
    • endTime string: The end time.

Output

Output schema unknown

cancelSpaceSearch

Cancels a space search of a client. OauthScopes: ALL

circuitsandbox.cancelSpaceSearch({
  "searchId": ""
}, context)

Input

  • input object
    • searchId required string: The id of the search to cancel

Output

Output schema unknown

getRecentSearches

Retrieve recent space searches for a user. OauthScopes: ALL

circuitsandbox.getRecentSearches(null, context)

Input

This action has no parameters

Output

startBasicSpacesSearch

starts a basic search in spaces OauthScopes: ALL

circuitsandbox.startBasicSpacesSearch({
  "scope": "",
  "searchTerm": ""
}, context)

Input

  • input object
    • scope required string (values: ALL, SPACES, TOPICBY, FILES, TAGS, LABELS, DATE): the scope of the search
    • searchTerm required string: the term to search for
    • startTime string: the starttime
    • endTime string: the end time
    • prioritySpaces array: list of prioritized spaces

Output

startDetailedSpaceSearch

starts a detailed search in a space OauthScopes: ALL

circuitsandbox.startDetailedSpaceSearch({
  "scope": "",
  "searchTerm": "",
  "spaceId": ""
}, context)

Input

  • input object
    • scope required string (values: ALL, SPACES, TOPICBY, FILES, TAGS, LABELS, DATE): the scope of the search
    • searchTerm required string: the term to search for
    • startTime string: the starttime
    • endTime string: the end time
    • spaceId required string: missing documentation
    • searchId string: missing documentation

Output

unflagSpaceItem

Unflag a space item OauthScopes: ALL

circuitsandbox.unflagSpaceItem({
  "itemId": ""
}, context)

Input

  • input object
    • itemId required string: the id of the item you want to unflag

Output

Output schema unknown

unlikeSpaceItem

Unlike a space item OauthScopes: ALL

circuitsandbox.unlikeSpaceItem({
  "itemId": ""
}, context)

Input

  • input object
    • itemId required string: The id of the item you want to unlike

Output

Output schema unknown

deleteSpace

Delete a space OauthScopes: ALL

circuitsandbox.deleteSpace({
  "id": ""
}, context)

Input

  • input object
    • id required string: id of the space

Output

Output schema unknown

updateSpace

Update a space OauthScopes: ALL

circuitsandbox.updateSpace({
  "id": ""
}, context)

Input

  • input object
    • id required string: id of the space
    • name string: name of the space
    • description string: description of the space
    • tags array: tags of the space
    • ownerId string: ownerid of the space
    • accessModeType string (values: INTERNAL_ONLY, INTERNAL_EXTERNAL, NO_CHANGE): Access mode
    • status string (values: ENABLED, DISABLED): status
    • role string (values: MODERATOR, AUTHOR, PARTICIPANT, READER, NO_CHANGE): role
    • type string (values: OPEN, CLOSED, SECRET, NO_CHANGE): type
    • largePictureBase64 string: large picture
    • smallPictureBase64 string: small picture

Output

joinSpace

Join a space OauthScopes: ALL

circuitsandbox.joinSpace({
  "id": ""
}, context)

Input

  • input object
    • id required string: The id of the space

Output

leaveSpace

Leave a space OauthScopes: ALL

circuitsandbox.leaveSpace({
  "id": ""
}, context)

Input

  • input object
    • id required string: The id of the space

Output

Output schema unknown

addParticipantsToSpace

Add a participant to a space OauthScopes: ALL

circuitsandbox.addParticipantsToSpace({
  "id": "",
  "userId": [],
  "role": ""
}, context)

Input

  • input object
    • id required string: The id of the space
    • userId required array: The user id of the participant
    • role required string (values: DEFAULT, MODERATOR, AUTHOR, PARTICIPANT, READER): The name of the role of the participant

Output

v2RemoveParticipantsFromSpace

removes Participants from a space OauthScopes: ALL

circuitsandbox.v2RemoveParticipantsFromSpace({
  "id": "",
  "userIds": []
}, context)

Input

  • input object
    • id required string: The id of the space
    • userIds required array: The ids of the participants to remove

Output

Output schema unknown

getSpaceParticipants

Get the participants of a space OauthScopes: ALL

circuitsandbox.getSpaceParticipants({
  "id": "",
  "sortBy": "",
  "sortOrder": "",
  "filterType": ""
}, context)

Input

  • input object
    • id required string: The id of the space.
    • sortBy required string (values: DISPLAY_NAME, NAME, FIRST_NAME): sort the spaces by LAST_CONTENT, NAME, NUMBER_OF_USERS or CREATION_DATE
    • sortOrder required string (values: ASCENDING, DESCENDING): ascending or descending
    • filterType required string (values: NONE, ACCESS_TYPE, ROLE, STATE): filtertype for participants (ACCESS_TYPE, ROLE or STATE)
    • filterValue string: value for the filter
    • query string: some sort of query
    • searchPointer string: The search pointer (leave empty initially).
    • numberOfResults number: number of results to return, 25 by default.

Output

getPendingParticipants

Get the pending participants of a space OauthScopes: ALL

circuitsandbox.getPendingParticipants({
  "id": ""
}, context)

Input

  • input object
    • id required string: The id of the space.
    • searchPointer string: The search pointer (leave empty initially).
    • numberOfResults number: number of results to return, 25 by default.

Output

getPinnedTopics

Retrieve pinned topics of a space OauthScopes: ALL

circuitsandbox.getPinnedTopics({
  "id": ""
}, context)

Input

  • input object
    • id required string: The id of the space.

Output

searchParticipantsToAdd

Finds participants to add to a space OauthScopes: ALL

circuitsandbox.searchParticipantsToAdd({
  "id": "",
  "query": ""
}, context)

Input

  • input object
    • id required string: The id of the space
    • query required string: The query

Output

searchSpaceParticipants

Get the participants of a space OauthScopes: ALL

circuitsandbox.searchSpaceParticipants({
  "id": "",
  "query": ""
}, context)

Input

  • input object
    • id required string: The id of the space.
    • query required string: The query to search with. If searchpointer/hasMotre is returned, refine query.

Output

updateReadTimestamp

Update read timestamp OauthScopes: ALL

circuitsandbox.updateReadTimestamp({
  "id": "",
  "timestamp": ""
}, context)

Input

  • input object
    • id required string: Id of a space
    • timestamp required string: The new timestamp

Output

Output schema unknown

updateParticipantInSpace

missing documentation OauthScopes: ALL

circuitsandbox.updateParticipantInSpace({
  "spaceId": "",
  "userId": "",
  "role": ""
}, context)

Input

  • input object
    • spaceId required string: missing documentation
    • userId required string: missing documentation
    • role required string (values: MODERATOR, AUTHOR, PARTICIPANT, READER): missing documentation

Output

Output schema unknown

getParticipantsImportData

missing documentation OauthScopes: ALL

circuitsandbox.getParticipantsImportData({
  "spaceId": ""
}, context)

Input

  • input object
    • spaceId required string: missing documentation

Output

requestSpaceAcces

request access for a space OauthScopes: ALL

circuitsandbox.requestSpaceAcces({
  "spaceId": ""
}, context)

Input

  • input object
    • spaceId required string: Id of the space
    • reason string: Reason why the Access has been requested

Output

Output schema unknown

denySpaceAcces

Deny access for a space OauthScopes: ALL

circuitsandbox.denySpaceAcces({
  "spaceId": "",
  "participantId": ""
}, context)

Input

  • input object
    • spaceId required string: Id of the space
    • participantId required string: Id of the participant
    • reason string: Reason why the request has been denied

Output

Output schema unknown

grantSpaceAcces

grant access for a space OauthScopes: ALL

circuitsandbox.grantSpaceAcces({
  "spaceId": "",
  "participantId": ""
}, context)

Input

  • input object
    • spaceId required string: Id of the space
    • participantId required string: Id of the participant

Output

Output schema unknown

createSpaceTopic

creates a new space topic OauthScopes: ALL

circuitsandbox.createSpaceTopic({
  "spaceId": "",
  "subject": ""
}, context)

Input

  • input object
    • spaceId required string: The ID of the space
    • subject required string: The subject of the topic
    • content string: The content of this topic
    • complex boolean: complex or not
    • mentionedUser string: A list of mentioned users
    • formMetaData string: The formMetaData
    • attachments array: the attached files

Output

v2GetTopicWithReplies

Gets a number of Space replies with a matching topic OauthScopes: ALL

circuitsandbox.v2GetTopicWithReplies({
  "spaceId": "",
  "topicId": ""
}, context)

Input

  • input object
    • spaceId required string: Id of the topic
    • topicId required string: ID of the topic
    • numberOfReplies number: The number of replies

Output

updateSpaceTopic

Updates a topic OauthScopes: ALL

circuitsandbox.updateSpaceTopic({
  "spaceId": "",
  "topicId": ""
}, context)

Input

  • input object
    • spaceId required string: ID of the space
    • topicId required string: Id of the topic to update
    • subject string: the subject of the topic
    • content string: content of the topic
    • formMetaData string: formMetaData to update
    • mentionedUsers array: the updated mentioned users
    • complex boolean: complex or not
    • attachments array: the attached files

Output

getSpaceReplies

Gets a number of Space replies OauthScopes: ALL

circuitsandbox.getSpaceReplies({
  "spaceId": "",
  "topicId": "",
  "searchDirection": ""
}, context)

Input

  • input object
    • spaceId required string: Id of the containing space
    • topicId required string: Id of the topic
    • searchDirection required string (values: BEFORE, AFTER): Search before or after a certain timestamp
    • timestamp string: Timestamp to start the search from
    • numberOfResults number: The number of results that should be returned

Output

createReply

creates a reply to a topic OauthScopes: ALL

circuitsandbox.createReply({
  "spaceId": "",
  "topicId": ""
}, context)

Input

  • input object
    • spaceId required string: ID of the space
    • topicId required string: ID of the topic
    • content string: Content of the reply
    • complex boolean: complex or not
    • mentionedUser string: the user mentioned in the reply
    • formMetaData string: formMetaData used in the reply
    • attachments array: the attached files

Output

updateSpaceReply

Updates a space reply OauthScopes: ALL

circuitsandbox.updateSpaceReply({
  "spaceId": "",
  "topicId": "",
  "replyId": ""
}, context)

Input

  • input object
    • spaceId required string: ID of the space
    • topicId required string: ID of the topic
    • replyId required string: id of the reply
    • content string: the content of the reply
    • complex boolean: complex or not
    • formMetaData string: formMetaData of the reply
    • mentionedUsers array: the mentioned users in the reply
    • attachments array: the attached files

Output

getSpaceTopics

Gets a number of Space topics OauthScopes: ALL

circuitsandbox.getSpaceTopics({
  "spaceId": "",
  "searchDirection": ""
}, context)

Input

  • input object
    • spaceId required string: Id of the space
    • searchDirection required string (values: BEFORE, AFTER): Search before or after a certain timestamp
    • timestamp string: Timestamp to start the search from
    • numberOfResults number: The number of results that should be returned

Output

pinTopic

Pin a topic OauthScopes: ALL

circuitsandbox.pinTopic({
  "topicId": "",
  "position": 0
}, context)

Input

  • input object
    • topicId required string: The id of the topic
    • position required number: The position to pin to

Output

Output schema unknown

unpinTopic

Unpin a topic OauthScopes: ALL

circuitsandbox.unpinTopic({
  "topicId": ""
}, context)

Input

  • input object
    • topicId required string: The id of the topic to unpin

Output

Output schema unknown

searchUser

Search for users based on an email address or username OauthScopes: ALL, READ_USER

circuitsandbox.searchUser({
  "name": ""
}, context)

Input

  • input object
    • name required string: Search for a user by name

Output

  • output array

getLabel

Returns all labels of the user that were defined either explicit or implicit via assignment to conversations. OauthScopes: ALL, READ_USER_PROFILE, ORGANIZE_CONVERSATIONS

circuitsandbox.getLabel(null, context)

Input

This action has no parameters

Output

addLabel

Add a label to the list of user labels OauthScopes: ALL, WRITE_USER_PROFILE, ORGANIZE_CONVERSATIONS

circuitsandbox.addLabel({
  "label": ""
}, context)

Input

  • input object
    • label required string: The label value to add

Output

removeLabel

Remove a label from the list of user labels OauthScopes: ALL, WRITE_USER_PROFILE, ORGANIZE_CONVERSATIONS

circuitsandbox.removeLabel({
  "labelId": ""
}, context)

Input

  • input object
    • labelId required string: The label value to remove, either the unique ID or the label value

Output

searchUsersList

Search multiple users given by id or email address. OauthScopes: ALL, READ_USER

circuitsandbox.searchUsersList({
  "name": []
}, context)

Input

  • input object
    • name required array: Multiple email addresses or UUIDs.

Output

  • output array

getPresence

Gets the presence status of the users whose IDs or email addresses are given. OauthScopes: ALL, READ_USER

circuitsandbox.getPresence({
  "userIds": []
}, context)

Input

  • input object
    • userIds required array: A list of unique user IDs or email addresses of the users you want to query the presence state for

Output

setUserPresence

Updates the presence status of the authenticated user. OauthScopes: ALL, WRITE_USER_PROFILE, MANAGE_PRESENCE

circuitsandbox.setUserPresence({
  "state": ""
}, context)

Input

  • input object
    • state required string: The user's presence.
    • dndUntil string: Timestamp until the DND state of the user is active. This field is mandatory when the state is set to DND.
    • clearDND boolean: Clear the DND of the user.
    • statusMessage string: An optional status message that is displayed instead of the location

Output

getProfile

Gets the authenticated user's profile information. OauthScopes: ALL, READ_USER_PROFILE

circuitsandbox.getProfile(null, context)

Input

This action has no parameters

Output

updateProfile

Updates the user profile of the authenticated user OauthScopes: ALL, WRITE_USER_PROFILE

circuitsandbox.updateProfile({}, context)

Input

  • input object
    • firstname string: The new firstname of the user
    • lastname string: The new lastname of the user
    • jobTitle string: The new job title of the user
    • locale string (values: EN_US, DE_DE, EN_GB, ES_ES, FR_FR, IT_IT, RU_RU, ZH_HANS_CN): The new locale of the user. One of EN_US, DE_DE, EN_GB, ES_ES, FR_FR, IT_IT, RU_RU, ZH_HANS_CN.

Output

getUserById

Gets the profile information of the user with the given ID. OauthScopes: ALL, READ_USER

circuitsandbox.getUserById({
  "id": ""
}, context)

Input

  • input object
    • id required string: The unique ID or the email address of the user to fetch

Output

getUserPresence

Gets the presence status of the users whose ID or email address is given. OauthScopes: ALL, READ_USER

circuitsandbox.getUserPresence({
  "id": ""
}, context)

Input

  • input object
    • id required string: The unique ID or the email address of the user to fetch.

Output

removeWebHooks

Unregisters all webHooks of the authenticated user OauthScopes: ALL, READ_CONVERSATIONS, READ_USER

circuitsandbox.removeWebHooks(null, context)

Input

This action has no parameters

Output

Output schema unknown

getWebHook

Gets the list of webHooks registered for this user or API. OauthScopes: ALL, READ_CONVERSATIONS, READ_USER

circuitsandbox.getWebHook(null, context)

Input

This action has no parameters

Output

addWebHook

Registers the webHook with the given filter and callback URL. OauthScopes: ALL, READ_CONVERSATIONS, READ_USER

circuitsandbox.addWebHook({
  "url": "",
  "filter": []
}, context)

Input

  • input object
    • url required string: WebHook callback URL. Currently only HTTP is supported
    • filter required array: A filter for WebHooks that checks for a list of configured events. This filter will use a regular expression to determine if it is interested in the events or not. The event itself is converted into a string of format AREA.EVENT. Examples: CONVERSATION.CREATE / USER.UPDATE

Output

createIncomingWebhook

Create a new webhook. Conversation must exist and creater has to be participant. OauthScopes: ALL, MANAGE_CONVERSATIONS

circuitsandbox.createIncomingWebhook({
  "conversationId": ""
}, context)

Input

  • input object
    • conversationId required string: The id of the conversation.
    • name string: The name of the webhook
    • userId string: The id of the user of the webhook
    • description string: A short description of the webhook

Output

getIncomingWebhookByUser

Get all webhooks of a special user. OauthScopes: ALL, MANAGE_CONVERSATIONS

circuitsandbox.getIncomingWebhookByUser({
  "userId": ""
}, context)

Input

  • input object
    • userId required string: The id of the user.
    • pagesize number: Max number of hooks per request. Default is 25
    • searchpointer string: Start of search if consequtive call.

Output

deleteIncomingWebhook

Delete a new webhook. Webhook must exist OauthScopes: ALL, MANAGE_CONVERSATIONS

circuitsandbox.deleteIncomingWebhook({
  "webhookId": ""
}, context)

Input

  • input object
    • webhookId required string: The id of the webhook

Output

Output schema unknown

postWebhookAsSlackMessage

Post text items to conversations via slack apps.

circuitsandbox.postWebhookAsSlackMessage({
  "webhookId": "",
  "content": null
}, context)

Input

Output

Output schema unknown

addPresenceWebHook

Registers a webHook that has a presence filter with the given URL and userIds. There is a maximum number of userIds allowed OauthScopes: ALL, READ_USER

circuitsandbox.addPresenceWebHook({
  "url": "",
  "userIds": []
}, context)

Input

  • input object
    • url required string: WebHook callback URL. Currently only HTTP is supported
    • userIds required array: The IDs of the users to subscribe for their presence

Output

updatePresenceWebHook

Updates a registration of a webHook that has a presence filter. The update can be performed either on the URL and/or the userIds. The new userIds, if any, will override any existing userIds. OauthScopes: ALL, READ_USER

circuitsandbox.updatePresenceWebHook({
  "id": ""
}, context)

Input

  • input object
    • id required string: The unique ID of the webHook to update
    • url string: WebHook callback URL. Currently only HTTP is supported
    • userIds array: The IDs of the users to subscribe for their presence

Output

removeWebHook

Unregisters the webHook with the given ID. OauthScopes: ALL, READ_CONVERSATIONS, READ_USER

circuitsandbox.removeWebHook({
  "id": ""
}, context)

Input

  • input object
    • id required string: The unique ID of the webHook to remove

Output

Output schema unknown

getWebHookById

Gets the registered webHook with the given ID. OauthScopes: ALL, READ_CONVERSATIONS, READ_USER

circuitsandbox.getWebHookById({
  "id": ""
}, context)

Input

  • input object
    • id required string: The unique ID of the webHook to fetch

Output

updateWebHook

Updates a webHook registration with the given filter and callback URL. OauthScopes: ALL, READ_CONVERSATIONS, READ_USER

circuitsandbox.updateWebHook({
  "id": ""
}, context)

Input

  • input object
    • id required string: The unique ID of the webHook to update
    • url string: WebHook callback URL. Currently only HTTP is supported
    • filter array: A filter for WebHooks that checks for a list of configured events. This filter will use a regular expression to determine if it is interested in the events or not. The event itself is converted into a string of format AREA.EVENT. Examples: CONVERSATION.CREATE / USER.UPDATE

Output

Definitions

AddParticipantsSearchResult

  • AddParticipantsSearchResult object
    • department string: The department of the participant
    • firstName string: The first name of the participant
    • isMember boolean: is the participant a member, true or false
    • jobTitle string: The job title of the participant
    • lastName string: The last name of the participant
    • smallImageUri string: The uri of the small picture of the participant
    • tenantId string: the tenant id of the participant
    • userId string: The id of the participant

Attachment

  • Attachment object
    • creationTime number: The creation time of the attachment.
    • creatorId string: The id of the creator of the attachment.
    • deleteUrl string: The delete URL of the attachment.
    • fileId string: The id of the attachment file.
    • fileName string: The name of the attachment file.
    • itemId string: The item id to which the attachment is attached.
    • mimeType string: The mime type of the attachment file.
    • modificationTime number: The modification time of the attachment.
    • size number: The size of the attachment file.
    • url string: The URL of the attachment.

BasicSearchResult

  • BasicSearchResult object
    • spaces array: List of spaces
    • status string: The status of the search (NORESULT, ERROR, TIMEOUT, MORERESULT)

BridgeNumber

  • BridgeNumber object
    • bridgeNumber string: The number that has to be called to join the real time session of a conversation
    • country string: The country where the bridge is hosted
    • isMostUsed boolean: Is most used
    • locale string: The locale of the bridge
    • name string: The name / identifier of the bridge
    • type string: Information of the billing for the call, i.e. if the caller has to pay or not for the call

Conversation

  • Conversation object
    • avatar string: The URL of the small avatar image of the conversation
    • avatarLarge string: The URL of the large avatar image of the conversation
    • convId string: The ID of the conversation
    • creationTime number: UTC timestamp when the conversation was created
    • creatorId string: The ID of the user who created the conversation
    • creatorTenantId string: The ID of the Circuit domain (tenant) where the creator of the conversation belongs to
    • description string: The description of the conversation. This field is available only for conversations with type COMMUNITY
    • isGuestAccessDisabled boolean: Indicates whether guest access to the conversation is disabled or not
    • isModerated boolean: Indicates whether the conversation is moderated or not. In a moderated conversation only participants who have been assigned the role of a moderator are allowed to add or remove participants into the conversation
    • modificationTime number: UTC timestamp when the conversation was modified. A conversation is modified when any of the conversation object fields change but not when conversation items are added or edited
    • participants array: Array of active participants
      • items string
    • topic string: The title of the conversation. Conversations of type DIRECT cannot have a title
    • topicPlaceholder string: The title of the conversation. Conversations of type DIRECT cannot have a title
    • type string: The type of the conversation. It can be one of the following: DIRECT, GROUP, COMMUNITY or LARGE

ConversationDetails

  • ConversationDetails object
    • bridgeNumbers array: A list of bridge numbers which can be used to dial in to the real time session via phone
    • conversationCreatorId string: The user ID of the conversation creator
    • isModerationAllowed boolean: Indicates if the conversation is allowed to be moderated
    • isRecordingAllowed boolean: Indicates if the conversation is allowed to be recorded
    • link string: A link that can be used in a browser to join the session
    • pin string: The PIN to join a real time session via phone

ConversationItem

  • ConversationItem object
    • attachments array: Array of files attached to the item
    • convId string: The ID of the conversation the item belongs to
    • creationTime number: UTC timestamp when the item was created
    • creatorId string: The ID of the user who created the conversation item
    • includeInUnreadCount boolean: Indicates whether the item is included in the unread message count
    • itemId string: The ID of the item
    • modificationTime number: UTC timestamp when the conversation was modified
    • rtc RtcItem
    • system SystemItem
    • text ConversationTextItem
    • type string: The type of the conversation item. It can be one of the following TEXT, SYSTEM or RTC

ConversationParticipant

  • ConversationParticipant object
    • displayName string: The display name of the participant.
    • firstName string: The first name of the participant.
    • isDeleted boolean: If the participant is deleted.
    • largeImageUri string: The large image uri of the participant.
    • lastName string: The last name of the participant.
    • smallImageUri string: The small image uri of the participant;
    • type string: The type of the participant
    • userId string: The unique user id of the participant.

ConversationParticipantsList

  • ConversationParticipantsList object
    • hasMore boolean: are more results available, then start another search with finer query
    • participantList array: list of participants
    • searchPointer string: pointer for stored search

ConversationSearchResult

  • ConversationSearchResult object

ConversationSearchResultItem

  • ConversationSearchResultItem object
    • convId string: The ID of the conversation to which the matching items belong.
    • itemIds array: The conversation items which contain the search result. The list maybe empty in case a hit was found for the conversation related data like topic or participants.
      • items string

ConversationTextItem

  • ConversationTextItem object
    • content string: The content of the text item
    • contentType string: The type of the text item. It can be one of the following: RICH (with HTML content) or PLAIN (only text)
    • formMetaData string: The meta data form
    • isWebhookMessage boolean: Is this a webhook message?
    • likedUserIds array: Array of IDs of the users who liked the item
      • items string
    • parentId string: The ID of the parent item of the text item. This field is optional and can be used for thread views
    • preview Preview
    • state string: The state of the text item. It can be one of the following: CREATED (which denotes that it was not modified since its creation), EDITED (which denotes that the creator of this item modified the item) or DELETED (which denotes that the item itself exists but its content was removed)
    • subject string: TThe subject of the text item. This field is optional and maybe filled when creating the text item

ConversationsPage

  • ConversationsPage object
    • conversationList array: List of conversations
    • nextPagePointer string: Pointer to the next set page of conversations

DirectoryResult

  • DirectoryResult object
    • hasMore boolean: are more results available, than start another search
    • searchPointer string: pointer for stored search
    • spaces array: list of spaces

FlaggedItem

FlaggedItemsResult

  • FlaggedItemsResult object
    • flaggedItems array: A list of flagged items
    • hasMore boolean: More results available (true-use searchpointer for next search/false)
    • searchPointer string: The searchpointer

GetSpacesResult

  • GetSpacesResult object

IncomingWebhook

  • IncomingWebhook object
    • conversationId string: The conversation where the posts go to
    • creationTime number: Milliseconds since 1.1.1900 when the hook was created
    • creatorId string: Th e user who created the webhook
    • description string: A short plain text to describe the webhook
    • modificationTime number: Milliseconds since 1.1.1900 when the hook was modified
    • name string: A name to identify the webhook
    • status string: Status may be ENABLED or DISABLED. A disabled hook cannot be used
    • tenantId string: The tenant where the conversation and users belong to
    • url string: The url where the webhokk can be used
    • userId string: The user who will occur as author of the posts
    • webhookId string: Unique id of the webhook

IncomingWebhookSlackMessage

  • IncomingWebhookSlackMessage object
    • mrkdwn boolean: Optional field. If false, textitem will not be formatted. Default is true.
    • text string: The text which will occur in the conversation. May contain formats like bold or italic

Label

  • Label object
    • labelId string: The unique ID of the label
    • value string: The clear text value

Participant

  • Participant object
    • creationTime number: Time when the participant was added to the space
    • labelIds array: The list of label IDs of all the labels assigned to the space.
      • items string
    • lastContentCreationTime number: Time stamp when user last created content in the space.
    • lastReadTimestamp number: Last time stamp when the user read content in this space.
    • modificationTime number: Time when the participant was changed last.
    • numberOfReplies number: Number of replies in the space created by this participant.
    • numberOfTopics number: Number of topics in the space created by this participant.
    • role string: The name of the role of the participant.
    • spaceId string: The unique ID of the space to which the participant.
    • state string: The name of the state of the participant;
    • tenantId string: The unique tenant id of the participant.
    • userId string: The unique user id of the participant.

ParticipantAddResult

  • ParticipantAddResult object

ParticipantSearchResult

  • ParticipantSearchResult object
    • creationTime number: Time when the participant was added to the space
    • firstName string: The first name of the participant
    • lastName string: The last name of the participant
    • modificationTime number: Time when the participant was changed last.
    • numberOfReplies number: Number of replies in the space created by this participant.
    • numberOfTopics number: Number of topics in the space created by this participant.
    • role string: The name of the role of the participant
    • smallImageUri string: The uri of the small picture of the participant
    • state string: The name of the state of the participant
    • tenantId string: the tenant id of the participant
    • userId string: The id of the participant

datafire
@infinitebrahmanuniverse/nolb-_datafire_c@everything-registry/sub-chunk-221
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.0

8 years ago