Update Csv Import Settings

User Guide > Resources > Update Csv Import Settings

This request changes csv import schedule attributes.

Resource

PATCH /sync/csv

Parameters

None

Payload

Patch Document

Fields

Name Patch Operations

maxBackups

replace

maxLogs

replace

External Device

externalDevice.type

replace

externalDevice.location

replace

externalDevice.usbId

replace

externalDevice.smbUserName

replace

externalDevice.smbPassword

replace

externalDevice.smbVersion

replace

externalDevice.ssl

replace

externalDevice.subDirectory

replace

externalDevice.mode

replace

Schedules List

schedules

add, remove, replace submember

schedules.day

replace

schedules.startTime

replace

Response

None

Context

Authorization

Administrator

Errors

Common Errors

Example

Request
PATCH https://xelion.nl/api/v1/master/sync/csv
Payload

change csv import schedule direct member

{
    "operations": [
            {
        "op": "replace",
            "path": "/maxLogs",
            "value": true
            }
    ]
}

change csv import external device member

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

add new schedule to the csv import schedule, first add a new object with virtual id 1 and then set the submember(s) by adding replace operations on the virtual id '1'

{
    "operations": [
            {
        "op": "add",
            "path": "/schedules/1",
            },
            {
        "op": "replace",
            "path": "/schedules/1/day",
            "value": "tuesday"
            }
    ]
}

remove schedule from csv import schedule, <OID> is the oid of the schedule

{
     "operations": [
            {
            "op": "remove",
            "path": "/schedules/1726623"
            }
    ]
}

change schedule submember, <OID> is the oid of the schedule

{
    "operations": [
            {
        "op": "replace",
            "path": "/schedules/1726623/startTime",
            "value": "00:50"
            }
    ]
}