Reference

Emailqueueitemattachment

The emailqueueitemattachment object

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

Json Structure Example


{
  "Id": 1234567,
  "EmailQueueItemId": 12345678,
  "Name": "Header",
  "UniqueId": "b9cbff43-fe7e-43e7-acd2-cc842c49a8d7",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a EmailQueueItemAttachment

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

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

๐Ÿ”’ Requires role "EmailQueueItemAttachment-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 emailqueueitemattachment records based on their different properties.
Id number
?Id=12345678
EmailQueueItemAttachment_EmailQueueItem EmailQueueItem
?EmailQueueItemAttachment_EmailQueueItem=...
EmailQueueItemAttachment_Name string
?EmailQueueItemAttachment_Name=...

Range search querystring parameters
Lets you search emailqueueitemattachment records based on a range of date or numeric values.
To_EmailQueueItemAttachment_CreatedOn date
?To_EmailQueueItemAttachment_CreatedOn=2010-01-01T20:32
From_EmailQueueItemAttachment_CreatedOn date
?From_EmailQueueItemAttachment_CreatedOn=2010-01-01T20:32
To_EmailQueueItemAttachment_UpdatedOn date
?To_EmailQueueItemAttachment_UpdatedOn=2010-01-01T20:32
From_EmailQueueItemAttachment_UpdatedOn date
?From_EmailQueueItemAttachment_UpdatedOn=2010-01-01T20:32

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "EmailQueueItem": ,
        "Name": "Header",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "198f2f45-6603-41eb-8c8a-edbe7df4035b",
        "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 EmailQueueItemAttachments by IDs

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

๐Ÿ”’ Requires role "EmailQueueItemAttachment-List"

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

Example request

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

Example response


{
    "Records": [{
        "Id": 1234567,
        "EmailQueueItem": ,
        "Name": "Header",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "94e8d6c2-40cd-49e4-9e8e-cb88cd0c2db0",
        "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 EmailQueueItemAttachment by Id

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

๐Ÿ”’ Requires role "EmailQueueItemAttachment-Read"

URL parameters
Id: number requried

Example request

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

Example response


{
  "Id": 1234567,
  "EmailQueueItemId": 12345678,
  "Name": "Header",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "999f5c4e-11ac-46f9-b5f4-08048be144dc",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new EmailQueueItemAttachment

Creates a new emailqueueitemattachment.
POST https://spaces.nexudus.com/api/sys/emailqueueitemattachments

๐Ÿ”’ Requires role "EmailQueueItemAttachment-Create"

Body parameters
EmailQueueItemId: number required
Name: string required

Example request

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

{
    "EmailQueueItemId": 12345678,
    "Name": "Header",
}


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 EmailQueueItemAttachment

Updates an existing emailqueueitemattachment.
PUT https://spaces.nexudus.com/api/sys/emailqueueitemattachments

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

๐Ÿ”’ Requires role "EmailQueueItemAttachment-Edit"

Body parameters
Id: number required
The unique Id of the emailqueueitemattachment to update.
EmailQueueItemId: number cleared if missing
Name: string cleared if missing

Example request

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

{
    "Id": 12345678,
    "EmailQueueItemId": 12345678,
    "Name": "Header",
}


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"
        },
    ]
}


Commands

Commands allow to perform actions against one or more emailqueueitemattachment 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 emailqueueitemattachment records.
GET https://spaces.nexudus.com/api/sys/emailqueueitemattachments/commands

Example request

GET https://spaces.nexudus.com/api/sys/emailqueueitemattachments/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 emailqueueitemattachment record IDs.
POST https://spaces.nexudus.com/api/sys/emailqueueitemattachments/runacommand
๐Ÿ”’ Requires role "EmailQueueItemAttachment-Edit"

Example request

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

Binary

GET https://spaces.nexudus.com/api/sys/emailqueueitemattachments/getbinary/:id
URL parameters
Id: number required
The id of the EmailQueueItemAttachment to get the binary 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.