Contents

図の一覧取得

自分の図の一覧を取得します。

メソッド

GET

URL

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

フォーマット

json, xml

認証

必須

パラメーター

パラメータ名型内容デフォルト例
organizationKey(必須)文字列Organizations API で取得した組織のキーabcdefghij
offset数値取得開始位置0
limit数値取得上限50
type文字列取得する図の種類
  • all - すべての図
  • own - 自分がオーナー
  • shared - 共有された図
  • stencil - ステンシル
  • template - テンプレート
  • recyclebin - ごみ箱
allown
sortOn文字列ソート対象
  • updated - 更新日
  • title - タイトル
  • owner - オーナー
  • folder - フォルダ
updatedtitle
sortType文字列ソート順
  • desc - 降順
  • asc - 昇順
descasc
folderId数値フォルダID10003
keyword文字列検索キーワードSitemap

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

レスポンス

フィールド型説明例
result配列図の一覧です。-
 + 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
count数値図の一覧総数85

JSON形式のレスポンスの例

{
    "result": [
        {
            "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"
        },
        {
            // ...
        }
    ],
    "count": 85
}

XML形式のレスポンスの例

<?xml version="1.0" encoding="utf-8"?>
<diagrams>
  <result>
    <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>
    </diagram>
    <diagram>
         ...
    </diagram>
  </result>
  <count>85</count>
</diagrams>