Reference

Platformchangemessage

The platformchangemessage object

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

Json Structure Example


{
  "Id": 1234567,
  "DescriptionEnglish": "Description",
  "DescriptionSpanish": "Description",
  "Title": "Title",
  "UniqueId": "da17d62f-b801-4a95-9e09-6854890c34b6",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a PlatformChangeMessage

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

GET https://spaces.nexudus.com/api/sys/platformchangemessages?...

πŸ”’ Requires role "PlatformChangeMessage-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=CreatedOn
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Descending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search platformchangemessage records based on their different properties.
Id number
?Id=12345678
PlatformChangeMessage_DescriptionEnglish string
?PlatformChangeMessage_DescriptionEnglish=...
PlatformChangeMessage_DescriptionSpanish string
?PlatformChangeMessage_DescriptionSpanish=...
PlatformChangeMessage_Title string
?PlatformChangeMessage_Title=...

Range search querystring parameters
Lets you search platformchangemessage records based on a range of date or numeric values.
To_PlatformChangeMessage_CreatedOn date
?To_PlatformChangeMessage_CreatedOn=2010-01-01T20:32
From_PlatformChangeMessage_CreatedOn date
?From_PlatformChangeMessage_CreatedOn=2010-01-01T20:32
To_PlatformChangeMessage_UpdatedOn date
?To_PlatformChangeMessage_UpdatedOn=2010-01-01T20:32
From_PlatformChangeMessage_UpdatedOn date
?From_PlatformChangeMessage_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/sys/platformchangemessages?PlatformChangeMessage_Title=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Title": "Title",
        "DescriptionEnglish": "Description",
        "DescriptionSpanish": "Description",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "6f827210-de3e-4489-aa2e-b903fdc0e874",
        "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 PlatformChangeMessages by IDs

Gets one or more platformchangemessage records based on their Id.
GET https://spaces.nexudus.com/api/sys/platformchangemessages?PlatformChangeMessage_Id=[:id1,:id2,...]

πŸ”’ Requires role "PlatformChangeMessage-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Title": "Title",
        "DescriptionEnglish": "Description",
        "DescriptionSpanish": "Description",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e540a27d-2215-4132-84d7-08cd003d36df",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "CreatedOn",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single PlatformChangeMessage by Id

Gets one platformchangemessage record by its Id.
GET https://spaces.nexudus.com/api/sys/platformchangemessages/:Id

πŸ”’ Requires role "PlatformChangeMessage-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "DescriptionEnglish": "Description",
  "DescriptionSpanish": "Description",
  "Title": "Title",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "5a2f8e65-9760-4065-8651-79a05f5d697a",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new PlatformChangeMessage

Creates a new platformchangemessage.
POST https://spaces.nexudus.com/api/sys/platformchangemessages

πŸ”’ Requires role "PlatformChangeMessage-Create"

Body parameters
Title: string required
DescriptionEnglish: string optional
DescriptionSpanish: string optional

Example request

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

{
    "Title": "Title",
    "DescriptionEnglish": "Description",
    "DescriptionSpanish": "Description",
}


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 PlatformChangeMessage

Updates an existing platformchangemessage.
PUT https://spaces.nexudus.com/api/sys/platformchangemessages

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

πŸ”’ Requires role "PlatformChangeMessage-Edit"

Body parameters
Id: number required
The unique Id of the platformchangemessage to update.
Title: string cleared if missing
DescriptionEnglish: string cleared if missing
DescriptionSpanish: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "Title": "Title",
    "DescriptionEnglish": "Description",
    "DescriptionSpanish": "Description",
}


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 PlatformChangeMessage

Deletes an existing platformchangemessage by its Id.
DELETE https://spaces.nexudus.com/api/sys/platformchangemessages/:Id

πŸ”’ Requires role "PlatformChangeMessage-Delete"

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

Example request

DELETE https://spaces.nexudus.com/api/sys/platformchangemessages/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 platformchangemessage 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 platformchangemessage records.
GET https://spaces.nexudus.com/api/sys/platformchangemessages/commands

Example request

GET https://spaces.nexudus.com/api/sys/platformchangemessages/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 platformchangemessage record IDs.
POST https://spaces.nexudus.com/api/sys/platformchangemessages/runacommand
πŸ”’ Requires role "PlatformChangeMessage-Edit"

Example request

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