Reference

Communitymessage

The communitymessage object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this communitymessage
CommunityThreadId: Id required
Message: string optional
UserId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this communitymessage
SystemId: string optional api-only
User defined data about this communitymessage. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "CommunityThreadId": 12345678,
  "Message": "Message",
  "UserId": 12345678,
  "UniqueId": "205ce57a-e9c4-43ec-95b7-669cf90b67db",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CommunityMessage

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

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

πŸ”’ Requires role "CommunityMessage-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 communitymessage records based on their different properties.
Id number
?Id=12345678
CommunityMessage_CommunityThread CommunityThread
?CommunityMessage_CommunityThread=...
CommunityMessage_Message string
?CommunityMessage_Message=...
CommunityMessage_User User
?CommunityMessage_User=...

Range search querystring parameters
Lets you search communitymessage records based on a range of date or numeric values.
To_CommunityMessage_CreatedOn date
?To_CommunityMessage_CreatedOn=2010-01-01T20:32
From_CommunityMessage_CreatedOn date
?From_CommunityMessage_CreatedOn=2010-01-01T20:32
To_CommunityMessage_UpdatedOn date
?To_CommunityMessage_UpdatedOn=2010-01-01T20:32
From_CommunityMessage_UpdatedOn date
?From_CommunityMessage_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CommunityThread": ,
        "User": ,
        "Message": "Message",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "7b423108-3a18-4e39-960d-93519354c06b",
        "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 CommunityMessages by IDs

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

πŸ”’ Requires role "CommunityMessage-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "CommunityThread": ,
        "User": ,
        "Message": "Message",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "1b674ba8-1edf-4eb6-8f73-48b1c2c3803b",
        "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 CommunityMessage by Id

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

πŸ”’ Requires role "CommunityMessage-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "CommunityThreadId": 12345678,
  "Message": "Message",
  "UserId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "9b444951-fd70-4769-b3c7-f41c2debdddd",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CommunityMessage

Creates a new communitymessage.
POST https://spaces.nexudus.com/api/community/communitymessages

πŸ”’ Requires role "CommunityMessage-Create"

Body parameters
CommunityThreadId: number required
UserId: number required
Message: string optional

Example request

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

{
    "CommunityThreadId": 12345678,
    "UserId": 12345678,
    "Message": "Message",
}


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 CommunityMessage

Updates an existing communitymessage.
PUT https://spaces.nexudus.com/api/community/communitymessages

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

πŸ”’ Requires role "CommunityMessage-Edit"

Body parameters
Id: number required
The unique Id of the communitymessage to update.
CommunityThreadId: number cleared if missing
UserId: number cleared if missing
Message: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "CommunityThreadId": 12345678,
    "UserId": 12345678,
    "Message": "Message",
}


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 CommunityMessage

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

πŸ”’ Requires role "CommunityMessage-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/community/communitymessages/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 communitymessage 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 communitymessage records.
GET https://spaces.nexudus.com/api/community/communitymessages/commands

Example request

GET https://spaces.nexudus.com/api/community/communitymessages/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 communitymessage record IDs.
POST https://spaces.nexudus.com/api/community/communitymessages/runacommand
πŸ”’ Requires role "CommunityMessage-Edit"

Example request

POST https://spaces.nexudus.com/api/community/communitymessages/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.