図の一覧取得

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

メソッド

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 - ごみ箱
 all own
sortOn 文字列 ソート対象
  • updated - 更新日
  • title - タイトル
  • owner - オーナー
  • folder - フォルダ
 updated title
sortType 文字列 ソート順
  • desc - 降順
  • asc - 昇順
 desc asc
folderId 数値 フォルダID 10003
keyword 文字列 検索キーワード Sitemap

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

レスポンス

フィールド 型 説明 例
result 配列 図の一覧です。 -
 + url 文字列 図の公開URL https://cacoo.com/diagrams/00e77f4dc9973517
 + imageUrl 文字列 図の公開画像URL https://cacoo.com/diagrams/00e77f4dc9973517.png
 + imageUrlForApi 文字列 図のAPIからのみアクセス可能な画像URL https://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png
 + diagramId 文字列 図のID 00e77f4dc9973517
 + 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 数値 図が所属するフォルダのID 10001
 + 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>