Reference

Templateversion

The templateversion object

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

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Description": "Descripción",
  "Name": "Name",
  "UniqueId": "581837ba-0c53-478f-a8c6-e424d66eed33",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a TemplateVersion

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

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

🔒 Requires role "TemplateVersion-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 templateversion records based on their different properties.
Id number
?Id=12345678
TemplateVersion_Business Business
?TemplateVersion_Business=...
TemplateVersion_Description string
?TemplateVersion_Description=...
TemplateVersion_Name string
?TemplateVersion_Name=...

Range search querystring parameters
Lets you search templateversion records based on a range of date or numeric values.
To_TemplateVersion_CreatedOn date
?To_TemplateVersion_CreatedOn=2010-01-01T20:32
From_TemplateVersion_CreatedOn date
?From_TemplateVersion_CreatedOn=2010-01-01T20:32
To_TemplateVersion_UpdatedOn date
?To_TemplateVersion_UpdatedOn=2010-01-01T20:32
From_TemplateVersion_UpdatedOn date
?From_TemplateVersion_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Description": "Descripción",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "090ceff9-a923-4406-8676-c1cc492f2e84",
        "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 TemplateVersions by IDs

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

🔒 Requires role "TemplateVersion-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Name": "Name",
        "Description": "Descripción",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "85379d06-9a9e-4e80-aff0-a1a00a815c37",
        "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 TemplateVersion by Id

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

🔒 Requires role "TemplateVersion-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "Description": "Descripción",
  "Name": "Name",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "cf1570dc-1b76-490e-ba8a-c73c44f2c8e1",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new TemplateVersion

Creates a new templateversion.
POST https://spaces.nexudus.com/api/sys/templateversions

🔒 Requires role "TemplateVersion-Create"

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

Example request

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

{
    "BusinessId": 12345678,
    "Name": "Name",
    "Description": "Descripción",
}


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 TemplateVersion

Updates an existing templateversion.
PUT https://spaces.nexudus.com/api/sys/templateversions

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

🔒 Requires role "TemplateVersion-Edit"

Body parameters
Id: number required
The unique Id of the templateversion 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/sys/templateversions
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "Name": "Name",
    "Description": "Descripción",
}


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 TemplateVersion

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

🔒 Requires role "TemplateVersion-Delete"

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

Example request

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

Example request

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

Example request

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