エディタの自動処理登録

エディタを開いたときに自動実行する処理を登録します。

メソッド

GET, POST

URL

https://cacoo.com/api/v1/diagrams/diagramId/editor/automation.format
例 : https://cacoo.com/api/v1/diagrams/00e77f4dc9973517/editor/automation.json?command={"operations":[{"type":"AddImageUrl","parameter":{"url":"http://www.nulab.co.jp"}}], "error":"ignore"}

フォーマット

json, xml

認証

必須

パラメーター

パラメータ名 内容
diagramId(必須) 文字列 図のID 00e77f4dc9973517
command(必須) JSON文字列 自動実行する処理の内容。JSON形式の文字列を渡します。 {“operations”:[{“type”:“AddImageUrl”,“parameter”:{“url”:“http://www.nulab.co.jp"}}], “error”:“ignore”}

commandパラメーター

パラメータ名 内容
operations(必須) 配列 処理内容を設定したオブジェクトの配列です。各オブジェクトは、typeとparameterをプロパティとして持ちます。
typeに処理の種類、parameterに処理ごとのパラメーターを指定します。指定できる処理とパラメーターは、以下の各処理のパラメータを参照して下さい。
[{“type”:“AddImageUrl”,“parameter”:{“url”:“http://www.nulab.co.jp", “x”:10, “y”:20}},{“type”:“…”,“parameter”:{…}},{“type”:“…”,“parameter”:{…}}]
error 文字列 自動処理の実行中にエラーが発生したときの挙動を指定します。値は”ignore”, “message”, “stop”のいずれかです。省略した場合は”ignore”と同じ扱いになります。
  • ignore - エラーを無視して続行します。
  • message - エディタにエラーメッセージを表示して中断します。
  • stop - 処理を中断します。

ignore

URLを指定して画像を挿入 ( type : “AddImageUrl” )

パラメータ名 内容
url(必須) 文字列 挿入する画像のもとになるURLです。 http://www.nulab.co.jp/
x 数値 画像の挿入位置(X座標)。省略した場合は0になります。 10
y 数値 画像の挿入位置(Y座標)。省略した場合は0になります。 20

オブジェクトを削除 ( type : “DeleteObject” )

パラメータ名 内容
uid(必須) 文字列 削除するオブジェクトのuidです。uidは図の内容取得APIから参照できます。 8FE31DA2-6396-4872-6A90-F7E710AD035A
sheetUid(必須) 文字列 削除するオブジェクトが配置されているシートのuidです。uidは図の内容取得APIから参照できます。 3532B

レスポンス

フィールド 説明
token 文字列 エディタ APIの ‘automationToken’ パラメータに指定するトークン文字列 wAHbE0gJ8DgRIUhy

JSON形式のレスポンスの例

{
    "token": "wAHbE0gJ8DgRIUhy"
}

XML形式のレスポンスの例

<?xml version="1.0" encoding="utf-8"?>
<editor>
  <token>wAHbE0gJ8DgRIUhy</token>
</editor>