Reference

Resource

The resource object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this resource
AirConditioning: bool optional
Allocation: int? optional
AllowMultipleBookings: bool optional
Archived: bool optional
BookInAdvanceLimit: int? optional
BusinessId: Id required
Catering: bool optional
CCTV: bool optional
ConferencePhone: bool optional
Description: string optional
DisplayOrder: int required
Drinks: bool optional
EmailConfirmationContent: string optional
GroupName: string optional
Heating: bool optional
HideInCalendar: bool optional
Internet: bool optional
IntervalLimit: int? optional
LargeDisplay: bool optional
LastCleanedAt: DateTime? optional
LateBookingLimit: int? optional
LateCancellationLimit: int? optional
Latitude: decimal? optional
Longitude: decimal? optional
MaxBookingLength: int? optional
MinBookingLength: int? optional
Name: string required
NaturalLight: bool optional
NoReturnPolicy: int? optional
NoReturnPolicyAllResources: int? optional
NoReturnPolicyAllUsers: int? optional
Projector: bool optional
RequiresConfirmation: bool optional
ResourceTypeId: Id required
SecurityLock: bool optional
Shifts: string optional
StandardPhone: bool optional
TeaAndCoffee: bool optional
UseSharedZoomAccount: bool optional
Visible: bool optional
VoiceRecorder: bool optional
WhiteBoard: bool optional
ZoomUserId: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this resource
SystemId: string optional api-only
User defined data about this resource. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "AirConditioning": false,
  "Allocation": ,
  "AllowMultipleBookings": false,
  "Archived": false,
  "BookInAdvanceLimit": ,
  "BusinessId": 12345678,
  "Catering": false,
  "CCTV": false,
  "ConferencePhone": false,
  "Description": "Descripción",
  "DisplayOrder": ,
  "Drinks": false,
  "EmailConfirmationContent": "Descripción",
  "GroupName": "GroupName",
  "Heating": false,
  "HideInCalendar": false,
  "Internet": false,
  "IntervalLimit": ,
  "LargeDisplay": false,
  "LastCleanedAt": ,
  "LateBookingLimit": ,
  "LateCancellationLimit": ,
  "Latitude": ,
  "Longitude": ,
  "MaxBookingLength": ,
  "MinBookingLength": ,
  "Name": "Name",
  "NaturalLight": false,
  "NoReturnPolicy": ,
  "NoReturnPolicyAllResources": ,
  "NoReturnPolicyAllUsers": ,
  "Projector": false,
  "RequiresConfirmation": false,
  "ResourceTypeId": 12345678,
  "SecurityLock": false,
  "Shifts": "null",
  "StandardPhone": false,
  "TeaAndCoffee": false,
  "UseSharedZoomAccount": false,
  "Visible": false,
  "VoiceRecorder": false,
  "WhiteBoard": false,
  "ZoomUserId": "Abc123456",
  "UniqueId": "c6852873-cb96-4f4f-a89c-33d8dc5f5b29",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a Resource

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

GET https://spaces.nexudus.com/api/spaces/resources?...

🔒 Requires role "Resource-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=Name
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 resource records based on their different properties.
Id number
?Id=12345678
Resource_AirConditioning bool
?Resource_AirConditioning=...
Resource_Allocation int?
?Resource_Allocation=...
Resource_AllowMultipleBookings bool
?Resource_AllowMultipleBookings=...
Resource_Archived bool
?Resource_Archived=...
Resource_BookInAdvanceLimit int?
?Resource_BookInAdvanceLimit=...
Resource_Business Business
?Resource_Business=...
Resource_Catering bool
?Resource_Catering=...
Resource_CCTV bool
?Resource_CCTV=...
Resource_ConferencePhone bool
?Resource_ConferencePhone=...
Resource_Description string
?Resource_Description=...
Resource_DisplayOrder int
?Resource_DisplayOrder=...
Resource_Drinks bool
?Resource_Drinks=...
Resource_EmailConfirmationContent string
?Resource_EmailConfirmationContent=...
Resource_GroupName string
?Resource_GroupName=...
Resource_Heating bool
?Resource_Heating=...
Resource_HideInCalendar bool
?Resource_HideInCalendar=...
Resource_Internet bool
?Resource_Internet=...
Resource_IntervalLimit int?
?Resource_IntervalLimit=...
Resource_LargeDisplay bool
?Resource_LargeDisplay=...
Resource_LastCleanedAt DateTime?
?Resource_LastCleanedAt=...
Resource_LateBookingLimit int?
?Resource_LateBookingLimit=...
Resource_LateCancellationLimit int?
?Resource_LateCancellationLimit=...
Resource_Latitude decimal?
?Resource_Latitude=...
Resource_Longitude decimal?
?Resource_Longitude=...
Resource_MaxBookingLength int?
?Resource_MaxBookingLength=...
Resource_MinBookingLength int?
?Resource_MinBookingLength=...
Resource_Name string
?Resource_Name=...
Resource_NaturalLight bool
?Resource_NaturalLight=...
Resource_NoReturnPolicy int?
?Resource_NoReturnPolicy=...
Resource_NoReturnPolicyAllResources int?
?Resource_NoReturnPolicyAllResources=...
Resource_NoReturnPolicyAllUsers int?
?Resource_NoReturnPolicyAllUsers=...
Resource_Projector bool
?Resource_Projector=...
Resource_RequiresConfirmation bool
?Resource_RequiresConfirmation=...
Resource_ResourceType ResourceType
?Resource_ResourceType=...
Resource_SecurityLock bool
?Resource_SecurityLock=...
Resource_Shifts string
?Resource_Shifts=...
Resource_StandardPhone bool
?Resource_StandardPhone=...
Resource_TeaAndCoffee bool
?Resource_TeaAndCoffee=...
Resource_UseSharedZoomAccount bool
?Resource_UseSharedZoomAccount=...
Resource_Visible bool
?Resource_Visible=...
Resource_VoiceRecorder bool
?Resource_VoiceRecorder=...
Resource_WhiteBoard bool
?Resource_WhiteBoard=...
Resource_ZoomUserId string
?Resource_ZoomUserId=...
Resource_ResourceTypeName string
?Resource_ResourceTypeName=...
Resource_Tariffs List of Tariff
?Resource_Tariffs=...
Resource_LinkedResources List of Resource
?Resource_LinkedResources=...

Range search querystring parameters
Lets you search resource records based on a range of date or numeric values.
To_Resource_CreatedOn date
?To_Resource_CreatedOn=2010-01-01T20:32
From_Resource_CreatedOn date
?From_Resource_CreatedOn=2010-01-01T20:32
To_Resource_UpdatedOn date
?To_Resource_UpdatedOn=2010-01-01T20:32
From_Resource_UpdatedOn date
?From_Resource_UpdatedOn=2010-01-01T20:32
To_Resource_DisplayOrder number
?To_Resource_DisplayOrder=0
From_Resource_DisplayOrder number
?From_Resource_DisplayOrder=10
To_Resource_Allocation number
?To_Resource_Allocation=0
From_Resource_Allocation number
?From_Resource_Allocation=10
To_Resource_BookInAdvanceLimit number
?To_Resource_BookInAdvanceLimit=0
From_Resource_BookInAdvanceLimit number
?From_Resource_BookInAdvanceLimit=10
To_Resource_LateBookingLimit number
?To_Resource_LateBookingLimit=0
From_Resource_LateBookingLimit number
?From_Resource_LateBookingLimit=10
To_Resource_LateCancellationLimit number
?To_Resource_LateCancellationLimit=0
From_Resource_LateCancellationLimit number
?From_Resource_LateCancellationLimit=10
To_Resource_IntervalLimit number
?To_Resource_IntervalLimit=0
From_Resource_IntervalLimit number
?From_Resource_IntervalLimit=10
To_Resource_NoReturnPolicy number
?To_Resource_NoReturnPolicy=0
From_Resource_NoReturnPolicy number
?From_Resource_NoReturnPolicy=10
To_Resource_NoReturnPolicyAllResources number
?To_Resource_NoReturnPolicyAllResources=0
From_Resource_NoReturnPolicyAllResources number
?From_Resource_NoReturnPolicyAllResources=10
To_Resource_NoReturnPolicyAllUsers number
?To_Resource_NoReturnPolicyAllUsers=0
From_Resource_NoReturnPolicyAllUsers number
?From_Resource_NoReturnPolicyAllUsers=10
To_Resource_MaxBookingLength number
?To_Resource_MaxBookingLength=0
From_Resource_MaxBookingLength number
?From_Resource_MaxBookingLength=10
To_Resource_MinBookingLength number
?To_Resource_MinBookingLength=0
From_Resource_MinBookingLength number
?From_Resource_MinBookingLength=10
To_Resource_Longitude number
?To_Resource_Longitude=0
From_Resource_Longitude number
?From_Resource_Longitude=10
To_Resource_Latitude number
?To_Resource_Latitude=0
From_Resource_Latitude number
?From_Resource_Latitude=10
To_Resource_LastCleanedAt date
?To_Resource_LastCleanedAt=2010-01-01T20:32
From_Resource_LastCleanedAt date
?From_Resource_LastCleanedAt=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/spaces/resources?Resource_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "ResourceType": ,
        "Description": "Descripción",
        "EmailConfirmationContent": "Descripción",
        "Visible": false,
        "RequiresConfirmation": false,
        "DisplayOrder": ,
        "GroupName": "GroupName",
        "Projector": false,
        "Internet": false,
        "ConferencePhone": false,
        "StandardPhone": false,
        "WhiteBoard": false,
        "LargeDisplay": false,
        "Catering": false,
        "TeaAndCoffee": false,
        "Drinks": false,
        "SecurityLock": false,
        "CCTV": false,
        "VoiceRecorder": false,
        "AirConditioning": false,
        "Heating": false,
        "NaturalLight": false,
        "AllowMultipleBookings": false,
        "Allocation": ,
        "BookInAdvanceLimit": ,
        "LateBookingLimit": ,
        "LateCancellationLimit": ,
        "IntervalLimit": ,
        "NoReturnPolicy": ,
        "NoReturnPolicyAllResources": ,
        "NoReturnPolicyAllUsers": ,
        "MaxBookingLength": ,
        "MinBookingLength": ,
        "Shifts": "null",
        "Longitude": ,
        "Latitude": ,
        "HideInCalendar": false,
        "Archived": false,
        "UseSharedZoomAccount": false,
        "ZoomUserId": "Abc123456",
        "LastCleanedAt": ,
        "ResourceResourceTypeName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c60c842d-d0f1-432d-a497-5cfde92d03f5",
        "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 Resources by IDs

Gets one or more resource records based on their Id.
GET https://spaces.nexudus.com/api/spaces/resources?Resource_Id=[:id1,:id2,...]

🔒 Requires role "Resource-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "ResourceType": ,
        "Description": "Descripción",
        "EmailConfirmationContent": "Descripción",
        "Visible": false,
        "RequiresConfirmation": false,
        "DisplayOrder": ,
        "GroupName": "GroupName",
        "Projector": false,
        "Internet": false,
        "ConferencePhone": false,
        "StandardPhone": false,
        "WhiteBoard": false,
        "LargeDisplay": false,
        "Catering": false,
        "TeaAndCoffee": false,
        "Drinks": false,
        "SecurityLock": false,
        "CCTV": false,
        "VoiceRecorder": false,
        "AirConditioning": false,
        "Heating": false,
        "NaturalLight": false,
        "AllowMultipleBookings": false,
        "Allocation": ,
        "BookInAdvanceLimit": ,
        "LateBookingLimit": ,
        "LateCancellationLimit": ,
        "IntervalLimit": ,
        "NoReturnPolicy": ,
        "NoReturnPolicyAllResources": ,
        "NoReturnPolicyAllUsers": ,
        "MaxBookingLength": ,
        "MinBookingLength": ,
        "Shifts": "null",
        "Longitude": ,
        "Latitude": ,
        "HideInCalendar": false,
        "Archived": false,
        "UseSharedZoomAccount": false,
        "ZoomUserId": "Abc123456",
        "LastCleanedAt": ,
        "ResourceResourceTypeName": "...",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "b65ee523-331a-4a54-aa22-c628ff47146f",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Name",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single Resource by Id

Gets one resource record by its Id.
GET https://spaces.nexudus.com/api/spaces/resources/:Id

🔒 Requires role "Resource-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "AirConditioning": false,
  "Allocation": ,
  "AllowMultipleBookings": false,
  "Archived": false,
  "BookInAdvanceLimit": ,
  "BusinessId": 12345678,
  "Catering": false,
  "CCTV": false,
  "ConferencePhone": false,
  "Description": "Descripción",
  "DisplayOrder": ,
  "Drinks": false,
  "EmailConfirmationContent": "Descripción",
  "GroupName": "GroupName",
  "Heating": false,
  "HideInCalendar": false,
  "Internet": false,
  "IntervalLimit": ,
  "LargeDisplay": false,
  "LastCleanedAt": ,
  "LateBookingLimit": ,
  "LateCancellationLimit": ,
  "Latitude": ,
  "Longitude": ,
  "MaxBookingLength": ,
  "MinBookingLength": ,
  "Name": "Name",
  "NaturalLight": false,
  "NoReturnPolicy": ,
  "NoReturnPolicyAllResources": ,
  "NoReturnPolicyAllUsers": ,
  "Projector": false,
  "RequiresConfirmation": false,
  "ResourceTypeId": 12345678,
  "SecurityLock": false,
  "Shifts": "null",
  "StandardPhone": false,
  "TeaAndCoffee": false,
  "UseSharedZoomAccount": false,
  "Visible": false,
  "VoiceRecorder": false,
  "WhiteBoard": false,
  "ZoomUserId": "Abc123456",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "1f88b78a-0f98-4689-b701-288a9414320e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new Resource

Creates a new resource.
POST https://spaces.nexudus.com/api/spaces/resources

🔒 Requires role "Resource-Create"

Body parameters
BusinessId: number required
Name: string required
ResourceTypeId: number required
Description: string optional
EmailConfirmationContent: string optional
Visible: bool optional
RequiresConfirmation: bool optional
DisplayOrder: int required
GroupName: string optional
Projector: bool optional
Internet: bool optional
ConferencePhone: bool optional
StandardPhone: bool optional
WhiteBoard: bool optional
LargeDisplay: bool optional
Catering: bool optional
TeaAndCoffee: bool optional
Drinks: bool optional
SecurityLock: bool optional
CCTV: bool optional
VoiceRecorder: bool optional
AirConditioning: bool optional
Heating: bool optional
NaturalLight: bool optional
AllowMultipleBookings: bool optional
Allocation: int? optional
BookInAdvanceLimit: int? optional
LateBookingLimit: int? optional
LateCancellationLimit: int? optional
IntervalLimit: int? optional
NoReturnPolicy: int? optional
NoReturnPolicyAllResources: int? optional
NoReturnPolicyAllUsers: int? optional
MaxBookingLength: int? optional
MinBookingLength: int? optional
Shifts: string optional
Longitude: decimal? optional
Latitude: decimal? optional
HideInCalendar: bool optional
Archived: bool optional
UseSharedZoomAccount: bool optional
ZoomUserId: string optional
LastCleanedAt: DateTime? optional

Example request

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

{
    "BusinessId": 12345678,
    "Name": "Name",
    "ResourceTypeId": 12345678,
    "Description": "Descripción",
    "EmailConfirmationContent": "Descripción",
    "Visible": false,
    "RequiresConfirmation": false,
    "DisplayOrder": ,
    "GroupName": "GroupName",
    "Projector": false,
    "Internet": false,
    "ConferencePhone": false,
    "StandardPhone": false,
    "WhiteBoard": false,
    "LargeDisplay": false,
    "Catering": false,
    "TeaAndCoffee": false,
    "Drinks": false,
    "SecurityLock": false,
    "CCTV": false,
    "VoiceRecorder": false,
    "AirConditioning": false,
    "Heating": false,
    "NaturalLight": false,
    "AllowMultipleBookings": false,
    "Allocation": ,
    "BookInAdvanceLimit": ,
    "LateBookingLimit": ,
    "LateCancellationLimit": ,
    "IntervalLimit": ,
    "NoReturnPolicy": ,
    "NoReturnPolicyAllResources": ,
    "NoReturnPolicyAllUsers": ,
    "MaxBookingLength": ,
    "MinBookingLength": ,
    "Tariffs": [12345678, 87654321],
    "Shifts": "null",
    "LinkedResources": [12345678, 87654321],
    "Longitude": ,
    "Latitude": ,
    "HideInCalendar": false,
    "Archived": false,
    "UseSharedZoomAccount": false,
    "ZoomUserId": "Abc123456",
    "LastCleanedAt": ,
}


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 Resource

Updates an existing resource.
PUT https://spaces.nexudus.com/api/spaces/resources

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

🔒 Requires role "Resource-Edit"

Body parameters
Id: number required
The unique Id of the resource to update.
BusinessId: number cleared if missing
Name: string cleared if missing
ResourceTypeId: number cleared if missing
Description: string cleared if missing
EmailConfirmationContent: string cleared if missing
Visible: bool cleared if missing
RequiresConfirmation: bool cleared if missing
DisplayOrder: int cleared if missing
GroupName: string cleared if missing
Projector: bool cleared if missing
Internet: bool cleared if missing
ConferencePhone: bool cleared if missing
StandardPhone: bool cleared if missing
WhiteBoard: bool cleared if missing
LargeDisplay: bool cleared if missing
Catering: bool cleared if missing
TeaAndCoffee: bool cleared if missing
Drinks: bool cleared if missing
SecurityLock: bool cleared if missing
CCTV: bool cleared if missing
VoiceRecorder: bool cleared if missing
AirConditioning: bool cleared if missing
Heating: bool cleared if missing
NaturalLight: bool cleared if missing
AllowMultipleBookings: bool cleared if missing
Allocation: int? cleared if missing
BookInAdvanceLimit: int? cleared if missing
LateBookingLimit: int? cleared if missing
LateCancellationLimit: int? cleared if missing
IntervalLimit: int? cleared if missing
NoReturnPolicy: int? cleared if missing
NoReturnPolicyAllResources: int? cleared if missing
NoReturnPolicyAllUsers: int? cleared if missing
MaxBookingLength: int? cleared if missing
MinBookingLength: int? cleared if missing
Shifts: string cleared if missing
Longitude: decimal? cleared if missing
Latitude: decimal? cleared if missing
HideInCalendar: bool cleared if missing
Archived: bool cleared if missing
UseSharedZoomAccount: bool cleared if missing
ZoomUserId: string cleared if missing
LastCleanedAt: DateTime? cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "ResourceTypeId": 12345678,
    "Description": "Descripción",
    "EmailConfirmationContent": "Descripción",
    "Visible": false,
    "RequiresConfirmation": false,
    "DisplayOrder": ,
    "GroupName": "GroupName",
    "Projector": false,
    "Internet": false,
    "ConferencePhone": false,
    "StandardPhone": false,
    "WhiteBoard": false,
    "LargeDisplay": false,
    "Catering": false,
    "TeaAndCoffee": false,
    "Drinks": false,
    "SecurityLock": false,
    "CCTV": false,
    "VoiceRecorder": false,
    "AirConditioning": false,
    "Heating": false,
    "NaturalLight": false,
    "AllowMultipleBookings": false,
    "Allocation": ,
    "BookInAdvanceLimit": ,
    "LateBookingLimit": ,
    "LateCancellationLimit": ,
    "IntervalLimit": ,
    "NoReturnPolicy": ,
    "NoReturnPolicyAllResources": ,
    "NoReturnPolicyAllUsers": ,
    "MaxBookingLength": ,
    "MinBookingLength": ,
    "Tariffs": [12345678, 87654321],
    "Shifts": "null",
    "LinkedResources": [12345678, 87654321],
    "Longitude": ,
    "Latitude": ,
    "HideInCalendar": false,
    "Archived": false,
    "UseSharedZoomAccount": false,
    "ZoomUserId": "Abc123456",
    "LastCleanedAt": ,
}


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 Resource

Deletes an existing resource by its Id.
DELETE https://spaces.nexudus.com/api/spaces/resources/:Id

🔒 Requires role "Resource-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/spaces/resources/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 resource record IDs.
POST https://spaces.nexudus.com/api/spaces/resources/runacommand
🔒 Requires role "Resource-Edit"

Example request

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


Binary files

The following endpoints return binary data. Check the `ContentType` header to understand the type of file being returned in the response stream.

Picture

GET https://spaces.nexudus.com/api/spaces/resources/getpicture/:id
URL parameters
Id: number required
The id of the Resource to get the picture for.

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.