Update Report Schedule

User Guide > Resources > Update Report Schedules

This request changes the attributes of a report schedule.

Resource

PATCH /reportschedules/<OID>

Where OID is the object ID of the report schedule.

Parameters

None

Payload

Patch Document

Fields

name Patch Operations

commonName

replace

enabled

replace

frequency

replace

mailToList

replace

mailText

replace

extendByDays

replace

sendSeperatly

replace

Mail From Address

mailFromAddress.address

replace

mailFromAddress.addressType

replace

Export Device

exportDevice.type

replace

exportDevice.location

replace

exportDevice.usbId

replace

exportDevice.smbUserName

replace

exportDevice.smbPassword

replace

exportDevice.smbVersion

replace

exportDevice.ssl

replace

exportDevice.subDirectory

replace

exportDevice.mode

replace

automatedReports

add, remove

Response

None

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/reportschedules/10317713
Payload

change direct member

{
    "operations": [
            {
        "op": "replace",
            "path": "/extendByDays",
            "value": 3
            }
    ]
}

add an automated report

{
    "operations": [
            {
        "op": "add",
        "path": "/automatedReports/1",
        "value": "1651120"
            }
    ]
}

remove an automated report

{
    "operations": [
            {
        "op": "remove",
        "path": "/automatedReports/846874"
            }
    ]
}

update mail from address

{
    "operations": [
            {
        "op": "replace",
            "path": "/mailFromAddress/address",
            "value": "info@xelion.nl"
            }
    ]
}

update export device

{
    "operations": [
            {
        "op": "replace",
            "path": "/exportDevice/type",
            "value": "windowsShare"
            }
    ]
}