インポート

2023-10-252026-10-11

概要¶

APIを使用して組織情報をインポートします。

事前準備¶

APIの操作を行う前にAPIキーの作成を実施してください。

リクエスト¶

下記のリクエスト形式で、CSVデータとJSONパラメータを送信します。

設定項目	値
HTTPメソッド	POST
Content-Type	multipart/form-data
文字コード	UTF-8
URL	http://{サーバー名}/api/depts/import¹
Body	後述の「Bodyに指定する項目」を参照のこと

Bodyに指定する項目¶

項目名	値
parameters	後述の「APIパラメータ」の内容をJSON形式の文字列で指定
file	登録するCSVファイルのバイナリデータ

APIパラメータ¶

項目名	設定例	備考
ApiVersion	1.1	APIバージョン
ApiKey	3da0fa3a7R61faf821...	取得したAPIキー
Encoding	Shift-JIS	CSVファイルのエンコーディング。"UTF-8"または"Shift-JIS"を指定

実行例のサンプル¶

PowerShell（version6.0 以降）のサンプル¶

PowerShell

$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のサンプル¶

Python

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())

レスポンス¶

下記の形式のJSONデータが返却されます。

JSON

{
    "Id": 0,
    "StatusCode": 200,
    "Message": "50 件追加し、12 件更新しました。"
}

対応バージョン¶

対応バージョン	内容
1.3.48.0 以降	機能追加

エラー時の確認事項¶

{サーバー名}の部分は、適宜、環境に合わせて編集してください。 ↩