Get Mail Deliverables

API Type

REST

HTTP Method

GET

Description

Retrieves all the mail deliverables for a process instance.

URL Format (On Premises)

https://[domain]:[port]/AgilePointServer/Workflow/GetMailDeliverables/[processInstanceID]

URL Format (AgilePoint for Azure)

https://[domain]:[port]/AgilePointService/Workflow/GetMailDeliverables/[processInstanceID]

Request Parameters

Name	Description
processInstanceID	Definition: Specifies the unique ID of a process instance. Type string Allowed Values: A valid process instance ID

JavaScript Code Example

$("#btnGetMailDeliverables").click(function () {
  
  $.ajax({
    url: "https://mydomain:9011/AgilePointServer/Workflow/
                GetMailDeliverables/D91BE666F2044DDEAF5BD202FBBE2467",
    type: "GET"
  });
  
});

Java Code Example

public String GetMailDeliverables(String processInstanceID) {

  String URI = "http://mydomain:9011/AgilePointServer/Workflow/GetMailDeliverables/"
                       + processInstanceID;

  HTTPOperations ops = new HTTPOperations(domain, this.userName,
                       password, appID, locale);

  return ops.GETMethod(URI);
}

C# Code Example

public string GetMailDeliverables()
  {
    string URL = "http://mydomain:9011/AgilePointServer/Workflow/
                         GetMailDeliverables/D9817B5BB4E4423FACFAAA80338C5611";

    HTTPOperations ops = new HTTPOperations(domain, this.userName, 
                         password, appID, locale);

    return ops.GetData(URL);
  }

Output

Array of WFMailDeliverable objects.

JSON Response Body Example

{
  "GetMailDeliverablesResult":[{
  "ActivityInstID": "00000000000000000000000000000000",
  "CreatedDate": "\/Date(1393646742890+0000)\/",
  "DeliveryTime": 1,
  "ID": "02ECFD464F9A4A1AB1D468A889FE30C1",
  "Mail": {
    "Attachments": "",
    "BCC": null,
    "CC": null,
    "Content": "<html>...<\/html>",
    "Format": 2,
    "From": "brian.lucas@mycompany.com",
    "LeftToRight": true,
    "MailPriority": 0,
    "Name": "0A81E99B4E694897A9322A89CCF642CE",
    "Subject": "Subject",
    "To": "lilly.allen@mycompany.com"
    },
  "NextSendingDate": "\/Date(1393646863983+0000)\/",
  "ProcInstID": "00000000000000000000000000000000",
  "Reason": "",
  "Session": 0,
  "Status": "Failure"
  }]
}

Supported Versions

AgilePoint BPMS v5.0 R2 and higher