POST api/job/SendSystemEmail

Sends a basic email to any specified party. Processes this job API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The send system email.

SendSystemEmailCommandDataContract

Name	Description	Type	Additional information
To	The collection of to.	Collection of string	None.
From	The from value.	string	None.
Subject	The subject value.	string	None.
Body	The body value.	string	None.
SystemDocumentBody	The system document body value.	string	None.
JsonModel	The json model value.	string	None.
SystemDocumentAttachments	The collection of system document attachments.	Collection of string	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "To": [
    "sample string 1",
    "sample string 2"
  ],
  "From": "sample string 1",
  "Subject": "sample string 2",
  "Body": "sample string 3",
  "SystemDocumentBody": "sample string 4",
  "JsonModel": "sample string 5",
  "SystemDocumentAttachments": [
    "sample string 1",
    "sample string 2"
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract

Name	Description	Type	Additional information
SupportsCancellation	Indicates whether supports cancellation is true.	boolean	None.
ReportsProgress	Indicates whether reports progress is true.	boolean	None.
InitialStatusText	The initial status text value.	string	None.
JobReference	The job reference globally unique identifier.	globally unique identifier	None.
Success	Indicates whether success is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "8477d62d-2652-42b6-9e2b-36c830ba6051",
  "Success": true
}