List Email Tasks

post/admin.fetchemailtasks

Retrieves email tasks that are pending or have already been sent. The response contains a list with all (or filtered out) email task objects (type code: ET).

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
endRow
integer
oldValues
object or null
operationType
string
startRow
integer
textMatchStyle
string
object
_constructor
string
operator
string
Array of objects
Array
fieldName
string
operator
string
value
string
Responses
200

OK

Response Schema: application/json
object
node
string
startRow
integer
Array of objects (EmailTask)
Array
typedId
string
subject
string <= 2048 characters
lastUpdateDate
string <date-time>
errorMessage
string <= 255 characters
sourceObject
string <= 255 characters
body
string
version
integer
sent
boolean
retriesLeft
integer
attachment
boolean
createdBy
integer
object
object
recipient
string
plainText
boolean
createDate
string <date-time>
lastUpdateBy
integer
endRow
integer
totalRows
integer
status
integer
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "sourceObject",
        • "operator": "iEquals",
        • "value": "2147494428.Q"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "node": "pricefx-cluster-app-frontend-b6c678dff-58hnc",
    • "startRow": 0,
    • "data": [
      • {
        • "version": 1,
        • "typedId": "3041.ET",
        • "retriesLeft": 0,
        • "body": "bodyContent",
        • "subject": "Pricefx - Creation Workflow Finished - Quote: P-2147494428 - New Quote",
        • "sourceObject": "2147494428.Q",
        • "createDate": "2024-07-02T08:43:20",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2024-07-02T08:43:47",
        • "lastUpdateBy": 2147490696,
        • "recipient": "ondrej.tesar@pricefx.eu",
        • "attachment": false,
        • "sent": true
        },
      • {
        • "version": 1,
        • "typedId": "3042.ET",
        • "retriesLeft": 0,
        • "body": "bodyContent",
        • "subject": "Pricefx - Approval Required - Quote: P-2147494428 - New Quote",
        • "sourceObject": "2147494428.Q",
        • "createDate": "2024-07-02T08:43:22",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2024-07-02T08:43:47",
        • "lastUpdateBy": 2147490696,
        • "recipient": "admin <ondrej.tesar@pricefx.eu>",
        • "attachment": false,
        • "sent": true
        }
      ],
    • "endRow": 2,
    • "totalRows": 2,
    • "status": 0
    }
}