Reference

Datafile

The datafile object

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

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Description": "Abc123456",
  "Name": "00001",
  "UniqueId": "1a0af250-e6c4-4718-b2ac-c45a413bb1c4",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a DataFile

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

GET https://spaces.nexudus.com/api/content/datafiles?...

πŸ”’ Requires role "DataFile-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 datafile records based on their different properties.
Id number
?Id=12345678
DataFile_Business Business
?DataFile_Business=...
DataFile_Description string
?DataFile_Description=...
DataFile_Name string
?DataFile_Name=...

Range search querystring parameters
Lets you search datafile records based on a range of date or numeric values.
To_DataFile_CreatedOn date
?To_DataFile_CreatedOn=2010-01-01T20:32
From_DataFile_CreatedOn date
?From_DataFile_CreatedOn=2010-01-01T20:32
To_DataFile_UpdatedOn date
?To_DataFile_UpdatedOn=2010-01-01T20:32
From_DataFile_UpdatedOn date
?From_DataFile_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/content/datafiles?DataFile_Name=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "Description": "Abc123456",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "21e80729-3ddf-4a88-a47f-43e735964875",
        "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 DataFiles by IDs

Gets one or more datafile records based on their Id.
GET https://spaces.nexudus.com/api/content/datafiles?DataFile_Id=[:id1,:id2,...]

πŸ”’ Requires role "DataFile-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "00001",
        "Description": "Abc123456",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "6c3a6cff-7e98-4ccb-8362-184666fc0914",
        "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 DataFile by Id

Gets one datafile record by its Id.
GET https://spaces.nexudus.com/api/content/datafiles/:Id

πŸ”’ Requires role "DataFile-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Description": "Abc123456",
  "Name": "00001",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "a68c82d0-95f5-447c-a160-104d63d9d6f9",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new DataFile

Creates a new datafile.
POST https://spaces.nexudus.com/api/content/datafiles

πŸ”’ Requires role "DataFile-Create"

Body parameters
BusinessId: number required
Name: string required
Description: string optional

Example request

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

{
    "BusinessId": 12345678,
    "Name": "00001",
    "Description": "Abc123456",
}


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 DataFile

Updates an existing datafile.
PUT https://spaces.nexudus.com/api/content/datafiles

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

πŸ”’ Requires role "DataFile-Edit"

Body parameters
Id: number required
The unique Id of the datafile to update.
BusinessId: number cleared if missing
Name: string cleared if missing
Description: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "00001",
    "Description": "Abc123456",
}


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 DataFile

Deletes an existing datafile by its Id.
DELETE https://spaces.nexudus.com/api/content/datafiles/:Id

πŸ”’ Requires role "DataFile-Delete"

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

Example request

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

Example request

GET https://spaces.nexudus.com/api/content/datafiles/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 datafile record IDs.
POST https://spaces.nexudus.com/api/content/datafiles/runacommand
πŸ”’ Requires role "DataFile-Edit"

Example request

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

FileData

GET https://spaces.nexudus.com/api/content/datafiles/getfiledata/:id
URL parameters
Id: number required
The id of the DataFile to get the filedata 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.