Reference

Communitythread

The communitythread object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this communitythread
BusinessId: Id required
CommunityGroupId: Id optional
IncludeZoomInvite: bool optional
InstantDelivery: bool optional
LastMessageDate: DateTime? optional read-only
Message: string required
Private: bool optional
Subject: string required
Tags: string optional
UserId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this communitythread
SystemId: string optional api-only
User defined data about this communitythread. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CommunityGroupId": 12345678,
  "IncludeZoomInvite": false,
  "InstantDelivery": false,
  "LastMessageDate": ,
  "Message": "Message",
  "Private": false,
  "Subject": "00001",
  "Tags": "00001",
  "UserId": 12345678,
  "UniqueId": "93e4108e-a3c8-49dc-8e18-882314ad4d85",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CommunityThread

This endpoint allows you to GET a list of communitythreads based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/community/communitythreads?...

πŸ”’ Requires role "CommunityThread-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search communitythread records based on their different properties.
Id number
?Id=12345678
CommunityThread_Business Business
?CommunityThread_Business=...
CommunityThread_CommunityGroup CommunityGroup
?CommunityThread_CommunityGroup=...
CommunityThread_IncludeZoomInvite bool
?CommunityThread_IncludeZoomInvite=...
CommunityThread_InstantDelivery bool
?CommunityThread_InstantDelivery=...
CommunityThread_LastMessageDate DateTime?
?CommunityThread_LastMessageDate=...
CommunityThread_Message string
?CommunityThread_Message=...
CommunityThread_Private bool
?CommunityThread_Private=...
CommunityThread_Subject string
?CommunityThread_Subject=...
CommunityThread_Tags string
?CommunityThread_Tags=...
CommunityThread_User User
?CommunityThread_User=...
CommunityThread_Guests List of User
?CommunityThread_Guests=...

Range search querystring parameters
Lets you search communitythread records based on a range of date or numeric values.
To_CommunityThread_CreatedOn date
?To_CommunityThread_CreatedOn=2010-01-01T20:32
From_CommunityThread_CreatedOn date
?From_CommunityThread_CreatedOn=2010-01-01T20:32
To_CommunityThread_UpdatedOn date
?To_CommunityThread_UpdatedOn=2010-01-01T20:32
From_CommunityThread_UpdatedOn date
?From_CommunityThread_UpdatedOn=2010-01-01T20:32
To_CommunityThread_LastMessageDate date
?To_CommunityThread_LastMessageDate=2010-01-01T20:32
From_CommunityThread_LastMessageDate date
?From_CommunityThread_LastMessageDate=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/community/communitythreads?CommunityThread_Subject=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "CommunityGroup": ,
        "User": ,
        "Subject": "00001",
        "Message": "Message",
        "InstantDelivery": false,
        "Tags": "00001",
        "Private": false,
        "LastMessageDate": ,
        "IncludeZoomInvite": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "895f517e-aefe-4de4-bfe6-f205b15e602b",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find CommunityThreads by IDs

Gets one or more communitythread records based on their Id.
GET https://spaces.nexudus.com/api/community/communitythreads?CommunityThread_Id=[:id1,:id2,...]

πŸ”’ Requires role "CommunityThread-List"

Querystring parameters
CommunityThread_Id: array requried
?CommunityThread_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/community/communitythreads?CommunityThread_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "CommunityGroup": ,
        "User": ,
        "Subject": "00001",
        "Message": "Message",
        "InstantDelivery": false,
        "Tags": "00001",
        "Private": false,
        "LastMessageDate": ,
        "IncludeZoomInvite": false,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c20facb0-132b-489a-8bd3-efbbd6392831",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single CommunityThread by Id

Gets one communitythread record by its Id.
GET https://spaces.nexudus.com/api/community/communitythreads/:Id

πŸ”’ Requires role "CommunityThread-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/community/communitythreads/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "CommunityGroupId": 12345678,
  "IncludeZoomInvite": false,
  "InstantDelivery": false,
  "LastMessageDate": ,
  "Message": "Message",
  "Private": false,
  "Subject": "00001",
  "Tags": "00001",
  "UserId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "0317d073-8125-49a2-a958-ffcf2e1ead90",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CommunityThread

Creates a new communitythread.
POST https://spaces.nexudus.com/api/community/communitythreads

πŸ”’ Requires role "CommunityThread-Create"

Body parameters
BusinessId: number required
CommunityGroupId: number optional
UserId: number required
Subject: string required
Message: string required
InstantDelivery: bool optional
Tags: string optional
Private: bool optional
IncludeZoomInvite: bool optional

Example request

POST https://spaces.nexudus.com/api/community/communitythreads
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "CommunityGroupId": 12345678,
    "UserId": 12345678,
    "Subject": "00001",
    "Message": "Message",
    "InstantDelivery": false,
    "Tags": "00001",
    "Private": false,
    "Guests": [12345678, 87654321],
    "IncludeZoomInvite": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update CommunityThread

Updates an existing communitythread.
PUT https://spaces.nexudus.com/api/community/communitythreads

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "CommunityThread-Edit"

Body parameters
Id: number required
The unique Id of the communitythread to update.
BusinessId: number cleared if missing
CommunityGroupId: number cleared if missing
UserId: number cleared if missing
Subject: string cleared if missing
Message: string cleared if missing
InstantDelivery: bool cleared if missing
Tags: string cleared if missing
Private: bool cleared if missing
IncludeZoomInvite: bool cleared if missing

Example request

PUT https://spaces.nexudus.com/api/community/communitythreads
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "CommunityGroupId": 12345678,
    "UserId": 12345678,
    "Subject": "00001",
    "Message": "Message",
    "InstantDelivery": false,
    "Tags": "00001",
    "Private": false,
    "Guests": [12345678, 87654321],
    "IncludeZoomInvite": false,
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete CommunityThread

Deletes an existing communitythread by its Id.
DELETE https://spaces.nexudus.com/api/community/communitythreads/:Id

πŸ”’ Requires role "CommunityThread-Delete"

URL parameters
Id: number required
The unique Id of the communitythread to update.

Example request

DELETE https://spaces.nexudus.com/api/community/communitythreads/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more communitythread records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for communitythread records.
GET https://spaces.nexudus.com/api/community/communitythreads/commands

Example request

GET https://spaces.nexudus.com/api/community/communitythreads/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more communitythread record IDs.
POST https://spaces.nexudus.com/api/community/communitythreads/runacommand
πŸ”’ Requires role "CommunityThread-Edit"

Example request

POST https://spaces.nexudus.com/api/community/communitythreads/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.