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

Reference

Templatefile

The templatefile object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this templatefile
BusinessId: Id required
Description: string optional
FileContents: string optional
FileLanguageId: Id optional
IsCustom: bool optional read-only
Name: string required
Password: string optional
Permalink: string required
Published: bool optional
TemplateVersionId: Id optional
Title: string optional
Visibility: Nexudus.Coworking.Core.Enums.eTemplateFileVisibility optional
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this templatefile
SystemId: string optional api-only
User defined data about this templatefile. This property can only be seen and updated using the API.

Json Structure Example 


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Description": "Descripción",
  "FileContents": "FileContent",
  "FileLanguageId": 12345678,
  "IsCustom": false,
  "Name": "Name",
  "Password": "False",
  "Permalink": "Permalink",
  "Published": false,
  "TemplateVersionId": 12345678,
  "Title": "Title",
  "Visibility": 1,
  "UniqueId": "22357a89-fd27-4d0e-97ab-08e84cd6dbf1",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Find a TemplateFile

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

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

🔒 Requires role "TemplateFile-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 templatefile records based on their different properties.
Id number
?Id=12345678
TemplateFile_Business Business
?TemplateFile_Business=...
TemplateFile_Description string
?TemplateFile_Description=...
TemplateFile_FileContents string
?TemplateFile_FileContents=...
TemplateFile_FileLanguage Language
?TemplateFile_FileLanguage=...
TemplateFile_IsCustom bool
?TemplateFile_IsCustom=...
TemplateFile_Name string
?TemplateFile_Name=...
TemplateFile_Password string
?TemplateFile_Password=...
TemplateFile_Permalink string
?TemplateFile_Permalink=...
TemplateFile_Published bool
?TemplateFile_Published=...
TemplateFile_TemplateVersion TemplateVersion
?TemplateFile_TemplateVersion=...
TemplateFile_Title string
?TemplateFile_Title=...
TemplateFile_Visibility Nexudus.Coworking.Core.Enums.eTemplateFileVisibility
?TemplateFile_Visibility=...

Range search querystring parameters
Lets you search templatefile records based on a range of date or numeric values.
To_TemplateFile_CreatedOn date
?To_TemplateFile_CreatedOn=2010-01-01T20:32
From_TemplateFile_CreatedOn date
?From_TemplateFile_CreatedOn=2010-01-01T20:32
To_TemplateFile_UpdatedOn date
?To_TemplateFile_UpdatedOn=2010-01-01T20:32
From_TemplateFile_UpdatedOn date
?From_TemplateFile_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "TemplateVersion": ,
        "Name": "Name",
        "Title": "Title",
        "Description": "Descripción",
        "Permalink": "Permalink",
        "FileLanguage": ,
        "Published": false,
        "Visibility": 1,
        "Password": "False",
        "IsCustom": false,
        "FileContents": "FileContent",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "100ff99f-4d89-471f-b4af-09840c64d5ce",
        "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 TemplateFiles by IDs

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

🔒 Requires role "TemplateFile-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "TemplateVersion": ,
        "Name": "Name",
        "Title": "Title",
        "Description": "Descripción",
        "Permalink": "Permalink",
        "FileLanguage": ,
        "Published": false,
        "Visibility": 1,
        "Password": "False",
        "IsCustom": false,
        "FileContents": "FileContent",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "c4ff850f-8940-4c23-96fc-1a9d7063508e",
        "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 TemplateFile by Id

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

🔒 Requires role "TemplateFile-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Description": "Descripción",
  "FileContents": "FileContent",
  "FileLanguageId": 12345678,
  "IsCustom": false,
  "Name": "Name",
  "Password": "False",
  "Permalink": "Permalink",
  "Published": false,
  "TemplateVersionId": 12345678,
  "Title": "Title",
  "Visibility": 1,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "a510d3c9-9060-413c-91bd-dfb57176cc7b",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}

Create new TemplateFile

Creates a new templatefile. 
POST https://spaces.nexudus.com/api/sys/templatefiles

🔒 Requires role "TemplateFile-Create"

Body parameters
BusinessId: number required
TemplateVersionId: number optional
Name: string required
Title: string optional
Description: string optional
Permalink: string required
FileLanguageId: number optional
Published: bool optional
Visibility: Nexudus.Coworking.Core.Enums.eTemplateFileVisibility optional
Password: string optional
FileContents: string optional

Example request

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


{
    "BusinessId": 12345678,
    "TemplateVersionId": 12345678,
    "Name": "Name",
    "Title": "Title",
    "Description": "Descripción",
    "Permalink": "Permalink",
    "FileLanguageId": 12345678,
    "Published": false,
    "Visibility": 1, //(check Enumerated values section below)
    "Password": "False",
    "FileContents": "FileContent",
}

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 TemplateFile

Updates an existing templatefile. 
PUT https://spaces.nexudus.com/api/sys/templatefiles

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

🔒 Requires role "TemplateFile-Edit"

Body parameters
Id: number required
The unique Id of the templatefile to update.
BusinessId: number cleared if missing
TemplateVersionId: number cleared if missing
Name: string cleared if missing
Title: string cleared if missing
Description: string cleared if missing
Permalink: string cleared if missing
FileLanguageId: number cleared if missing
Published: bool cleared if missing
Visibility: Nexudus.Coworking.Core.Enums.eTemplateFileVisibility cleared if missing
Password: string cleared if missing
FileContents: string cleared if missing

Example request

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


{
    "Id": 12345678,
    "BusinessId": 12345678,
    "TemplateVersionId": 12345678,
    "Name": "Name",
    "Title": "Title",
    "Description": "Descripción",
    "Permalink": "Permalink",
    "FileLanguageId": 12345678,
    "Published": false,
    "Visibility": 1, //(check Enumerated values section below)
    "Password": "False",
    "FileContents": "FileContent",
}

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 TemplateFile

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

🔒 Requires role "TemplateFile-Delete"

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

Example request

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

Example request

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

Example request

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

Visibility

GET /api/utils/enums?name=eTemplateFileVisibility

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/sys/templatefiles/getpicture/:id
URL parameters
Id: number required
The id of the TemplateFile 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.