図のコピー
図をコピーしてコピー後の図の情報を取得します。
メソッド
GET, POST
URL
https://cacoo.com/api/v1/diagrams/diagramId/copy.format
例 : https://cacoo.com/api/v1/diagrams/00e77f4dc9973517/copy.json
フォーマット
json, xml
認証
必須
エラー
ステータスコード |
メッセージ |
内容 |
400 |
入力検証メッセージ |
入力検証エラー |
403 |
SHEET_SIZE_LIMIT_EXCEEDED |
作成可能な図の枚数を超えたため作成不可 |
404 |
FOLDER_NOT_FOUND |
フォルダが存在しないか権限がないためコピー不可 |
パラメーター
パラメータ名 |
型 |
内容 |
デフォルト |
例 |
diagramId(必須) |
文字列 |
図のID |
|
00e77f4dc9973517 |
organizationKey(必須) |
文字列 |
Organizations API で取得した組織のキー |
|
abcdefghij |
title |
文字列 |
図のタイトル |
Untitled |
ワイヤーフレーム案 |
description |
文字列 |
図の説明 |
|
今回のプロジェクトのワイヤーフレームです。 |
security |
文字列 |
図の公開種別
- private - 共有されたユーザーのみに公開
- url - URLを知っているユーザに公開
- public - URLを知っている人は誰でも編集可能
|
|
url |
folderId |
数値 |
図をコピーするフォルダのID |
|
10001 |
*旧プラン(旧フリープラン・プラスプラン)をご利用の場合、パラメーターにorganizationKey
は不要です。
レスポンス
フィールド |
型 |
説明 |
例 |
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 |
sheets |
配列 |
シート情報の配列 |
- |
+ url |
文字列 |
シート情報の公開用URL |
https://cacoo.com/diagrams/00e77f4dc9973517#aaaa |
+ imageUrl |
文字列 |
シートの画像の公開用URL |
https://cacoo.com/diagrams/00e77f4dc9973517-aaaa.png |
+ imageUrlForApi |
文字列 |
図のAPIからのみアクセス可能な画像URL |
https://cacoo.com/api/v1/diagrams/00e77f4dc9973517-aaaa.png |
+ uid |
文字列 |
シートのユニークID |
aaaa |
+ 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>