Contents

図の新規作成

図を新規作成し作成後の図の情報を取得します。

メソッド

GET, POST

URL

https://cacoo.com/api/v1/diagrams/create.format
例 : https://cacoo.com/api/v1/diagrams/create.json

フォーマット

json, xml

認証

必須

エラー

ステータスコードメッセージ内容
400入力検証メッセージ入力検証エラー
403SHEET_SIZE_LIMIT_EXCEEDED作成可能な図の枚数を超えたため作成不可
404FOLDER_NOT_FOUNDフォルダが存在しないか権限がないため作成不可

パラメーター

パラメータ名型内容デフォルト例
organizationKey(必須)文字列Organizations API で取得した組織のキーabcdefghij
folderId数値図を作成するフォルダのID123
title文字列図のタイトルUntitledワイヤーフレーム案
description文字列図の説明今回のプロジェクトのワイヤーフレームです。
security文字列図の公開種別
  • private - 共有されたユーザーのみに公開
  • url - URLを知っているユーザに公開
  • public - URLを知っている人は誰でも編集可能

privateurl

*旧プラン（旧フリープラン・プラスプラン）をご利用の場合、パラメーターにorganizationKeyは不要です。

レスポンス

フィールド型説明例
url文字列図の公開URLhttps://cacoo.com/diagrams/00e77f4dc9973517
imageUrl文字列図の公開画像URLhttps://cacoo.com/diagrams/00e77f4dc9973517.png
imageUrlForApi文字列図のAPIからのみアクセス可能な画像URLhttps://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png
diagramId文字列図のID00e77f4dc9973517
title文字列図のタイトルワイヤーフレーム案
description文字列図の説明今回のプロジェクトのワイヤーフレームです。
security文字列図の公開種別
  • private - 共有されたユーザーのみに公開
  • url - URLを知っているユーザに公開
  • public - URLを知っている人は誰でも編集可能

url
type文字列図の種別
  • normal - 通常の図
  • stencil - ステンシル
  • template - テンプレート

normal
ownerName(非推奨)文字列オーナーのユーザ名1MUJPfNEEeVUox15
ownerNickname(非推奨)文字列オーナーのニックネームYoko
ownerオブジェクトオーナー-
 + name文字列ユーザ名1MUJPfNEEeVUox15
 + nickname文字列ニックネームYoko
 + type文字列ユーザーの種別
  • cacoo - Cacooで認証管理
  • other - Cacoo以外で認証管理
cacoo
 + imageUrl文字列ユーザーの画像URL(サイズは32x32)https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32
editing真偽現在図を誰かが編集しているか？true
own真偽自分が作成した図か？true
shared真偽他人から共有された図か？false
folderId数値図が所属するフォルダのID10001
folderName文字列図が所属するフォルダ名Design
sheetCount数値図のシートの数3
created日付作成日(RFC2822)Mon, 10 Aug 2009 17:00:00 +0900
updated日付更新日(RFC2822)Mon, 10 Aug 2009 17:00:00 +0900
sheets配列シート情報の配列-
 + url文字列シート情報の公開用URLhttps://cacoo.com/diagrams/00e77f4dc9973517#aaaa
 + imageUrl文字列シートの画像の公開用URLhttps://cacoo.com/diagrams/00e77f4dc9973517-aaaa.png
 + imageUrlForApi文字列図のAPIからのみアクセス可能な画像URLhttps://cacoo.com/api/v1/diagrams/00e77f4dc9973517-aaaa.png
 + uid文字列シートのユニークIDaaaa
 + name文字列シート名sheet1
 + width数値画像の幅200
 + height数値画像の高さ100
comments配列コメントの配列-
 + userオブジェクトコメントしたユーザー-
  + name文字列ユーザ名1MUJPfNEEeVUox15
  + nickname文字列ニックネームYoko
  + type文字列ユーザーの種別
  • cacoo - Cacooで認証管理
  • other - Cacoo以外で認証管理
cacoo
  + imageUrl文字列ユーザーの画像URL(サイズは32x32)https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32
 + content文字列コメントの内容comment 1
 + created日付作成日(RFC2822)Mon, 10 Aug 2009 17:00:00 +0900
 + updated日付更新日(RFC2822)Mon, 10 Aug 2009 17:00:00 +0900

JSON形式のレスポンスの例

{
    "url": "https://cacoo.com/diagrams/00e77f4dc9973517",
    "imageUrl": "https://cacoo.com/diagrams/00e77f4dc9973517.png",
    "imageUrlForApi": "https://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png",
    "diagramId": "00e77f4dc9973517",
    "title": "ワイヤーフレーム案",
    "description": "今回のプロジェクトのワイヤーフレームです。",
    "security": "url",
    "type": "normal",
    "ownerName": "1MUJPfNEEeVUox15",
    "ownerNickname": "Yoko",
    "owner": {
        "name": "1MUJPfNEEeVUox15",
        "nickname": "Yoko",
        "type": "cacoo",
        "imageUrl": "https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32"
    },
    "editing": true,
    "own": true,
    "shared": false,
    "folderId": 10001,
    "folderName": "Design",
    "sheetCount": 3,
    "created": "Mon, 10 Aug 2009 17:00:00 +0900",
    "updated": "Mon, 10 Aug 2009 17:00:00 +0900",
    "sheets": [
        {
            "url": "https://cacoo.com/diagrams/00e77f4dc9973517#aaaa",
            "imageUrl": "https://cacoo.com/diagrams/00e77f4dc9973517-aaaa.png",
            "imageUrlForApi": "https://cacoo.com/api/v1/diagrams/00e77f4dc9973517-aaaa.png",
            "uid": "aaaa",
            "name": "sheet1",
            "width": 200,
            "height": 100
        },
        {
            // ...
        }
    ],
    "comments": [
        {
            "user": {
                "name": "1MUJPfNEEeVUox15",
                "nickname": "Yoko",
                "type": "cacoo",
                "imageUrl": "https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32"
            },
            "content": "comment 1",
            "created": "Mon, 10 Aug 2009 17:00:00 +0900",
            "updated": "Mon, 10 Aug 2009 17:00:00 +0900"
        },
        {
            // ...
        }
    ]
}

XML形式のレスポンスの例

<?xml version="1.0" encoding="utf-8"?>
<diagram>
  <url>https://cacoo.com/diagrams/00e77f4dc9973517</url>
  <imageUrl>https://cacoo.com/diagrams/00e77f4dc9973517.png</imageUrl>
  <imageUrlForApi>https://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png</imageUrlForApi>
  <diagramId>00e77f4dc9973517</diagramId>
  <title>ワイヤーフレーム案</title>
  <description>今回のプロジェクトのワイヤーフレームです。</description>
  <security>url</security>
  <type>normal</type>
  <ownerName>1MUJPfNEEeVUox15</ownerName>
  <ownerNickname>Yoko</ownerNickname>
  <owner>
    <name>1MUJPfNEEeVUox15</name>
    <nickname>Yoko</nickname>
    <type>cacoo</type>
    <imageUrl>https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32</imageUrl>
  </owner>
  <editing>true</editing>
  <own>true</own>
  <shared>false</shared>
  <folderId>10001</folderId>
  <folderName>Design</folderName>
  <sheetCount>3</sheetCount>
  <created>Mon, 10 Aug 2009 17:00:00 +0900</created>
  <updated>Mon, 10 Aug 2009 17:00:00 +0900</updated>
  <sheets>
    <sheet>
      <url>https://cacoo.com/diagrams/00e77f4dc9973517#aaaa</url>
      <imageUrl>https://cacoo.com/diagrams/00e77f4dc9973517-aaaa.png</imageUrl>
      <imageUrlForApi>https://cacoo.com/api/v1/diagrams/00e77f4dc9973517-aaaa.png</imageUrlForApi>
      <uid>aaaa</uid>
      <name>sheet1</name>
      <width>200</width>
      <height>100</height>
    </sheet>
    <sheet>
         ...
    </sheet>
  </sheets>
  <comments>
    <comment>
      <user>
        <name>1MUJPfNEEeVUox15</name>
        <nickname>Yoko</nickname>
        <type>cacoo</type>
        <imageUrl>https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32</imageUrl>
      </user>
      <content>comment 1</content>
      <created>Mon, 10 Aug 2009 17:00:00 +0900</created>
      <updated>Mon, 10 Aug 2009 17:00:00 +0900</updated>
    </comment>
    <comment>
         ...
    </comment>
  </comments>
</diagram>