Validationrule

The validationrule object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this validationrule
Active: bool optional
BusinessId: Id required
Description: string optional
ErrorMessage: string optional
Formula: string required
Name: string required
RecordType: Nexudus.Coworking.Core.Enums.eValidationRuleEntity optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this validationrule
SystemId: string optional api-only
User defined data about this validationrule. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "Description": "Abc123456",
  "ErrorMessage": "00001",
  "Formula": "Abc123456",
  "Name": "00001",
  "RecordType": 1,
  "UniqueId": "14574b8e-963a-4cce-9115-5e72872d7dce",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a ValidationRule

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

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

πŸ”’ Requires role "ValidationRule-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 validationrule records based on their different properties.
Id number
?Id=12345678
ValidationRule_Active bool
?ValidationRule_Active=...
ValidationRule_Business Business
?ValidationRule_Business=...
ValidationRule_Description string
?ValidationRule_Description=...
ValidationRule_ErrorMessage string
?ValidationRule_ErrorMessage=...
ValidationRule_Formula string
?ValidationRule_Formula=...
ValidationRule_Name string
?ValidationRule_Name=...
ValidationRule_RecordType Nexudus.Coworking.Core.Enums.eValidationRuleEntity
?ValidationRule_RecordType=...

Range search querystring parameters
Lets you search validationrule records based on a range of date or numeric values.
To_ValidationRule_CreatedOn date
?To_ValidationRule_CreatedOn=2010-01-01T20:32
From_ValidationRule_CreatedOn date
?From_ValidationRule_CreatedOn=2010-01-01T20:32
To_ValidationRule_UpdatedOn date
?To_ValidationRule_UpdatedOn=2010-01-01T20:32
From_ValidationRule_UpdatedOn date
?From_ValidationRule_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "RecordType": 1,
        "Active": false,
        "Formula": "Abc123456",
        "Description": "Abc123456",
        "ErrorMessage": "00001",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e1386293-f7e4-41c4-9a3b-b3dcfe88a284",
        "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 ValidationRules by IDs

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

πŸ”’ Requires role "ValidationRule-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "RecordType": 1,
        "Active": false,
        "Formula": "Abc123456",
        "Description": "Abc123456",
        "ErrorMessage": "00001",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e715da77-4380-484f-a628-6f9dbc58483d",
        "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 ValidationRule by Id

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

πŸ”’ Requires role "ValidationRule-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Active": false,
  "BusinessId": 12345678,
  "Description": "Abc123456",
  "ErrorMessage": "00001",
  "Formula": "Abc123456",
  "Name": "00001",
  "RecordType": 1,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "e4303c48-578a-4e5b-89ee-9294d17ccb2e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new ValidationRule

Creates a new validationrule.
POST https://spaces.nexudus.com/api/sys/validationrules

πŸ”’ Requires role "ValidationRule-Create"

Body parameters
BusinessId: number required
Name: string required
RecordType: Nexudus.Coworking.Core.Enums.eValidationRuleEntity optional
Active: bool optional
Formula: string required
Description: string optional
ErrorMessage: string optional

Example request

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

{
    "BusinessId": 12345678,
    "Name": "00001",
    "RecordType": 1, //(check Enumerated values section below)
    "Active": false,
    "Formula": "Abc123456",
    "Description": "Abc123456",
    "ErrorMessage": "00001",
}


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 ValidationRule

Updates an existing validationrule.
PUT https://spaces.nexudus.com/api/sys/validationrules

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

πŸ”’ Requires role "ValidationRule-Edit"

Body parameters
Id: number required
The unique Id of the validationrule to update.
BusinessId: number cleared if missing
Name: string cleared if missing
RecordType: Nexudus.Coworking.Core.Enums.eValidationRuleEntity cleared if missing
Active: bool cleared if missing
Formula: string cleared if missing
Description: string cleared if missing
ErrorMessage: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "00001",
    "RecordType": 1, //(check Enumerated values section below)
    "Active": false,
    "Formula": "Abc123456",
    "Description": "Abc123456",
    "ErrorMessage": "00001",
}


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 ValidationRule

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

πŸ”’ Requires role "ValidationRule-Delete"

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

Example request

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

Example request

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

Example request

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


Enumerated values

RecordType

GET /api/utils/enums?name=eValidationRuleEntity

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.