Reference

Communitythreadfollow

The communitythreadfollow object

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

Json Structure Example


{
  "Id": 1234567,
  "ThreadId": 12345678,
  "UserId": 12345678,
  "UniqueId": "517dcb45-9c1c-4ff5-b62e-237a45538c25",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a CommunityThreadFollow

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

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

πŸ”’ Requires role "CommunityThreadFollow-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 communitythreadfollow records based on their different properties.
Id number
?Id=12345678
CommunityThreadFollow_Thread CommunityThread
?CommunityThreadFollow_Thread=...
CommunityThreadFollow_User User
?CommunityThreadFollow_User=...

Range search querystring parameters
Lets you search communitythreadfollow records based on a range of date or numeric values.
To_CommunityThreadFollow_CreatedOn date
?To_CommunityThreadFollow_CreatedOn=2010-01-01T20:32
From_CommunityThreadFollow_CreatedOn date
?From_CommunityThreadFollow_CreatedOn=2010-01-01T20:32
To_CommunityThreadFollow_UpdatedOn date
?To_CommunityThreadFollow_UpdatedOn=2010-01-01T20:32
From_CommunityThreadFollow_UpdatedOn date
?From_CommunityThreadFollow_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Thread": ,
        "User": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "cfcc9fee-da5d-497f-ac61-9b951576708d",
        "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 CommunityThreadFollows by IDs

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

πŸ”’ Requires role "CommunityThreadFollow-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Thread": ,
        "User": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b9b53cb8-ba22-42ad-afb0-ace9e4613d0b",
        "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 CommunityThreadFollow by Id

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

πŸ”’ Requires role "CommunityThreadFollow-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "ThreadId": 12345678,
  "UserId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "826eb5e2-4d76-43c6-8902-434a7c76ad93",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new CommunityThreadFollow

Creates a new communitythreadfollow.
POST https://spaces.nexudus.com/api/community/communitythreadfollows

πŸ”’ Requires role "CommunityThreadFollow-Create"

Body parameters
ThreadId: number required
UserId: number required

Example request

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

{
    "ThreadId": 12345678,
    "UserId": 12345678,
}


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 CommunityThreadFollow

Updates an existing communitythreadfollow.
PUT https://spaces.nexudus.com/api/community/communitythreadfollows

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

πŸ”’ Requires role "CommunityThreadFollow-Edit"

Body parameters
Id: number required
The unique Id of the communitythreadfollow to update.
ThreadId: number cleared if missing
UserId: number cleared if missing

Example request

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

{
    "Id": 12345678,
    "ThreadId": 12345678,
    "UserId": 12345678,
}


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 CommunityThreadFollow

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

πŸ”’ Requires role "CommunityThreadFollow-Delete"

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

Example request

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

Example request

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

Example request

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