Import

Overview¶

Import department information using API.

Preparations¶

Please Create an API Key before performing API operations.

Request¶

Send CSV data and JSON parameters in the following request format:

Column to specify in the body¶

API Parameters¶

Execution Example Sample¶

PowerShell (version 6.0 or later) Sample¶

$uri = 'http://servername/api/depts/import'
$filePath = "./sample.csv"
$form = @{
    parameters = ConvertTo-Json @{
        ApiVersion = 1.1;
        ApiKey = "4d84b4773a58bbc3c4...";
        Encoding = "UTF-8";
    };
    file = Get-Item -Path $filePath;
}
Invoke-WebRequest -Uri $uri -Method Post -Form $form

Python Sample¶

import requests
import json

url = "https://servername/api/depts/import"
filePath = "./sample.csv"
data = {
    "parameters": json.dumps({
        "ApiVersion" : 1.1,
        "ApiKey" : "4d84b4773a58bbc3c4...",
        "Encoding" : "UTF-8"
    })
}
files = {
    "file":("sample.csv", open(filePath,"rb"), "text/csv")
}
response = requests.post(url, data, files=files)
print(response.content.decode())

Response¶

JSON data in the following format is returned.

{
    "Id": 0,
    "StatusCode": 200,
    "Message": "50 entries have been added and 12 entries updated."
}

Supported Versions¶

Confirmation Column in Case of Error¶

• An error occurs when executing the API
• What to check if modified configuration files or API requests (JSON format) are not recognized correctly