API Members Portal Email Support Request a Demo
Submit a request
  1. Nexudus
  2. API
  3. Sys

Reference

Businessredirection

The businessredirection object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this businessredirection
Active: bool optional
ActiveFrom: DateTime? optional
ActiveTo: DateTime? optional
BusinessId: Id required
DestinationURL: string required
SourceURL: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this businessredirection
SystemId: string optional api-only
User defined data about this businessredirection. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "Active": false,
  "ActiveFrom": ,
  "ActiveTo": ,
  "BusinessId": 12345678,
  "DestinationURL": "Joe",
  "SourceURL": "Joe",
  "UniqueId": "82703afb-2595-46da-878e-5dbdb33cb7d3",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a BusinessRedirection

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

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

🔒 Requires role "BusinessRedirection-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 businessredirection records based on their different properties.
Id number
?Id=12345678
BusinessRedirection_Active bool
?BusinessRedirection_Active=...
BusinessRedirection_ActiveFrom DateTime?
?BusinessRedirection_ActiveFrom=...
BusinessRedirection_ActiveTo DateTime?
?BusinessRedirection_ActiveTo=...
BusinessRedirection_Business Business
?BusinessRedirection_Business=...
BusinessRedirection_DestinationURL string
?BusinessRedirection_DestinationURL=...
BusinessRedirection_SourceURL string
?BusinessRedirection_SourceURL=...

Range search querystring parameters
Lets you search businessredirection records based on a range of date or numeric values.
To_BusinessRedirection_CreatedOn date
?To_BusinessRedirection_CreatedOn=2010-01-01T20:32
From_BusinessRedirection_CreatedOn date
?From_BusinessRedirection_CreatedOn=2010-01-01T20:32
To_BusinessRedirection_UpdatedOn date
?To_BusinessRedirection_UpdatedOn=2010-01-01T20:32
From_BusinessRedirection_UpdatedOn date
?From_BusinessRedirection_UpdatedOn=2010-01-01T20:32
To_BusinessRedirection_ActiveFrom date
?To_BusinessRedirection_ActiveFrom=2010-01-01T20:32
From_BusinessRedirection_ActiveFrom date
?From_BusinessRedirection_ActiveFrom=2010-01-01T20:32
To_BusinessRedirection_ActiveTo date
?To_BusinessRedirection_ActiveTo=2010-01-01T20:32
From_BusinessRedirection_ActiveTo date
?From_BusinessRedirection_ActiveTo=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "SourceURL": "Joe",
        "DestinationURL": "Joe",
        "Active": false,
        "ActiveFrom": ,
        "ActiveTo": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "3e379b60-47fb-43c4-988c-afee522f10ae",
        "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 BusinessRedirections by IDs

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

🔒 Requires role "BusinessRedirection-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "SourceURL": "Joe",
        "DestinationURL": "Joe",
        "Active": false,
        "ActiveFrom": ,
        "ActiveTo": ,
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "355e7985-0934-48a5-a325-6e3ce2eb3a0f",
        "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 BusinessRedirection by Id

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

🔒 Requires role "BusinessRedirection-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "Active": false,
  "ActiveFrom": ,
  "ActiveTo": ,
  "BusinessId": 12345678,
  "DestinationURL": "Joe",
  "SourceURL": "Joe",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "e2ba0b1c-b2c4-4ba8-bf8b-1f8592643e30",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new BusinessRedirection

Creates a new businessredirection. 
POST https://spaces.nexudus.com/api/sys/businessredirections

🔒 Requires role "BusinessRedirection-Create"

Body parameters
BusinessId: number required
SourceURL: string required
DestinationURL: string required
Active: bool optional
ActiveFrom: DateTime? optional
ActiveTo: DateTime? optional

Example request

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


{
    "BusinessId": 12345678,
    "SourceURL": "Joe",
    "DestinationURL": "Joe",
    "Active": false,
    "ActiveFrom": ,
    "ActiveTo": ,
}

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 BusinessRedirection

Updates an existing businessredirection. 
PUT https://spaces.nexudus.com/api/sys/businessredirections

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

🔒 Requires role "BusinessRedirection-Edit"

Body parameters
Id: number required
The unique Id of the businessredirection to update.
BusinessId: number cleared if missing
SourceURL: string cleared if missing
DestinationURL: string cleared if missing
Active: bool cleared if missing
ActiveFrom: DateTime? cleared if missing
ActiveTo: DateTime? cleared if missing

Example request

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


{
    "Id": 12345678,
    "BusinessId": 12345678,
    "SourceURL": "Joe",
    "DestinationURL": "Joe",
    "Active": false,
    "ActiveFrom": ,
    "ActiveTo": ,
}

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 BusinessRedirection

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

🔒 Requires role "BusinessRedirection-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/sys/businessredirections/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 businessredirection record IDs. 
POST https://spaces.nexudus.com/api/sys/businessredirections/runacommand
🔒 Requires role "BusinessRedirection-Edit"

Example request

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