Reference

Report

The report object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this report
BusinessId: Id required
Folder: string required
Name: string required
ReportType: Nexudus.Coworking.Core.Enums.eReportType optional
ReportXml: string optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this report
SystemId: string optional api-only
User defined data about this report. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Folder": "Name",
  "Name": "Name",
  "ReportType": 1,
  "ReportXml": "ReportXml",
  "UniqueId": "331323dd-5f3a-4275-98c5-a773d45a1499",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a Report

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

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

πŸ”’ Requires role "Report-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 report records based on their different properties.
Id number
?Id=12345678
Report_Business Business
?Report_Business=...
Report_Folder string
?Report_Folder=...
Report_Name string
?Report_Name=...
Report_ReportType Nexudus.Coworking.Core.Enums.eReportType
?Report_ReportType=...
Report_ReportXml string
?Report_ReportXml=...

Range search querystring parameters
Lets you search report records based on a range of date or numeric values.
To_Report_CreatedOn date
?To_Report_CreatedOn=2010-01-01T20:32
From_Report_CreatedOn date
?From_Report_CreatedOn=2010-01-01T20:32
To_Report_UpdatedOn date
?To_Report_UpdatedOn=2010-01-01T20:32
From_Report_UpdatedOn date
?From_Report_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Folder": "Name",
        "ReportType": 1,
        "ReportXml": "ReportXml",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "68cb4a7c-511c-45ab-b42a-d0b6a0d7b273",
        "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 Reports by IDs

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

πŸ”’ Requires role "Report-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Folder": "Name",
        "ReportType": 1,
        "ReportXml": "ReportXml",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "3d4087bf-9756-4277-9758-e9137a93ccb4",
        "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 Report by Id

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

πŸ”’ Requires role "Report-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Folder": "Name",
  "Name": "Name",
  "ReportType": 1,
  "ReportXml": "ReportXml",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "b8fe1b2a-7b31-4d3b-98d6-5d0e3bddee6e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new Report

Creates a new report.
POST https://spaces.nexudus.com/api/sys/reports

πŸ”’ Requires role "Report-Create"

Body parameters
BusinessId: number required
Name: string required
Folder: string required
ReportType: Nexudus.Coworking.Core.Enums.eReportType optional
ReportXml: string optional

Example request

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

{
    "BusinessId": 12345678,
    "Name": "Name",
    "Folder": "Name",
    "ReportType": 1, //(check Enumerated values section below)
    "ReportXml": "ReportXml",
}


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 Report

Updates an existing report.
PUT https://spaces.nexudus.com/api/sys/reports

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

πŸ”’ Requires role "Report-Edit"

Body parameters
Id: number required
The unique Id of the report to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Folder: string cleared if missing
ReportType: Nexudus.Coworking.Core.Enums.eReportType cleared if missing
ReportXml: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "Folder": "Name",
    "ReportType": 1, //(check Enumerated values section below)
    "ReportXml": "ReportXml",
}


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 Report

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

πŸ”’ Requires role "Report-Delete"

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

Example request

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

Example request

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

Example request

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

ReportType

GET /api/utils/enums?name=eReportType

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.