Create Report Schedule

User Guide > Resources > Create Report Schedule

This request creates an report schedule.

Resource

POST /reportschedules

Parameters

Common Create Parameters

Payload

Report Schedule

Response

Object Response < Report Schedule >

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
POST https://xelion.nl/api/v1/master/reportschedules
Payload
{
    "commonName": "auto report test",
    "frequency": "MONTHLY",
    "enabled": true,
    "mailText": "",
    "extendByDays": 0,
    "sendSeperatly": false,
    "mailFromAddress": {
        "address": "info@xelion.nl"
    },
    "exportDevice": {
        "type": "ftpServer",
        "location": "ftp.xelion.nl",
        "usbId": "",
        "smbUserName": "test",
        "smbPassword": "test",
        "smbVersion": "",
        "ssl": true,
        "subDirectory": "/export",
        "mode": "passive",
        "objectType": "XCCExternalDevice"
    },
    "automatedReports": [
      {
        "automatedReport": {
          "oid": "1928941",
          "objectType": "AutomatedReport"
        },
        "objectType": "relScheduledAutomated"
      }
    ],
    "objectType": "QBQueryReportSchedule"
}
Response
{
    "object": {
        "frequency": "MONTHLY",
        "enabled": true,
        "mailFromAddress": {
            "commonName": "info@xelion.nl",
            "addressType": "Email",
            "address": "info@xelion.nl",
            "label": "",
            "orderNumber": 0,
            "oid": "2047282",
            "objectType": "TelecomAddress"
        },
        "mailText": "",
        "exportDevice": {
            "type": "ftpServer",
            "location": "ftp.xelion.nl",
            "usbId": "",
            "smbUserName": "test",
            "smbPassword": "test",
            "smbVersion": "",
            "ssl": true,
            "subDirectory": "/export",
            "mode": "passive",
            "oid": "1929276",
            "objectType": "XCCExternalDevice"
        },
        "extendByDays": 0,
        "nextCreationDate": "2020-02-29 23:00:00",
        "sendSeperatly": false,
        "previousResults": [],
        "automatedReports": [
            {
                "automatedReport": {
                    "permissions": "ReadWriteRemove",
                    "commonName": "test2",
                    "oid": "1928941",
                    "objectType": "AutomatedReport"
                },
                "oid": "1929280",
                "objectType": "relScheduledAutomated"
            }
        ],
        "permissions": "ReadWriteRemove",
        "commonName": "auto report test",
        "oid": "1929275",
        "objectType": "QBQueryReportSchedule"
    },
    "links": [
        {
            "rel": "self",
            "method": "GET"
        }
    ]
}