Copy diagram

Copy the diagram and get information about the copied diagram.

Method

GET, POST

URL

https://cacoo.com/api/v1/diagrams/diagramId/copy.format
Example : https://cacoo.com/api/v1/diagrams/00e77f4dc9973517/copy.json

Format

json, xml

Authentication

required

Error

Status Code Message Content
400 Message to verify entered text Error found in entered text
403 SHEET_SIZE_LIMIT_EXCEEDED Cannot copy the diagram as it will exceed the number of allowed sheets.
404 FOLDER_NOT_FOUND Cannot copy the diagram as the folder does not exist or you have no permission.

Parameters

Parameter Name Type Content Default Example
diagramId(Required) String Diagram Id 00e77f4dc9973517
title String Title of Diagram Untitled wireframe
description String Diagram description Current project wireframe
security String Security status of the diagram
  • private - only viewable with shared users
  • url - visible to anyone who knows the URL.
  • public - anyone who knows the URL will be able to edit this diagram.
url
folderId Integer The folder ID where the copy will be created 10001

Response

Field Type Description Example
url String Public URL for Diagram https://cacoo.com/diagrams/00e77f4dc9973517
imageUrl String URL of the first image https://cacoo.com/diagrams/00e77f4dc9973517.png
imageUrlForApi String String to interact with the image using the API https://cacoo.com/api/v1/diagrams/00e77f4dc9973517.png
diagramId String Diagram ID 00e77f4dc9973517
title String Title of Diagram Wireframe
description String Diagram description Current project wireframe
security String Security status of the diagram
  • private - only viewable with shared users
  • url - visible to anyone who knows the URL.
  • public - anyone who knows the URL will be able to edit this diagram.
url
type String Type of the diagram
  • normal - Ordinary diagram
  • stencil - Stencil
  • template - Template
normal
ownerName(Deprecated) String Owner's user name 1MUJPfNEEeVUox15
ownerNickname(Deprecated) String Owner's nick name Yoko
owner Object Owner's -
 + name String User name 1MUJPfNEEeVUox15
 + nickname String Nick name Yoko
 + type String Account Type
  • cacoo - Manage authentication on Cacoo.
  • other - Manage authentication on other than Cacoo.
cacoo
 + imageUrl String User Icon URL(32x32 pixels) https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32
editing Boolean Is the diagram currently being edited? true
own Boolean Is this a diagram you created? true
shared Boolean Is this a diagram that has been shared with you? false
folderId Integer ID of the folder the diagram is in 10001
folderName String Name of the folder the diagram is in Design
sheetCount Integer Number of sheets in the diagram 3
created Date Date Created(RFC2822) Mon, 10 Aug 2009 17:00:00 +0900
updated Date Date last updated(RFC2822) Mon, 10 Aug 2009 17:00:00 +0900
sheets Array Array of information about the sheets -
 + url String Public URL for the sheet https://cacoo.com/diagrams/00e77f4dc9973517#aaaa
 + imageUrl String Public URL for the image https://cacoo.com/diagrams/00e77f4dc9973517-aaaa.png
 + imageUrlForApi String String to interact with the image using the API https://cacoo.com/api/v1/diagrams/00e77f4dc9973517-aaaa.png
 + uid String Unique ID for Sheet aaaa
 + name String Sheet Name sheet1
 + width Integer Image Width 200
 + height Integer Image Height 100
comments Array Comment array -
 + user Object Commenter -
  + name String User name 1MUJPfNEEeVUox15
  + nickname String Nick name Yoko
  + type String Account Type
  • cacoo - Manage authentication on Cacoo.
  • other - Manage authentication on other than Cacoo.
cacoo
  + imageUrl String User Icon URL(32x32 pixels) https://cacoo.com/account/1MUJPfNEEeVUox15/image/32x32
 + content String Comment information comment 1
 + created Date Date Created(RFC2822) Mon, 10 Aug 2009 17:00:00 +0900
 + updated Date Date last updated(RFC2822) Mon, 10 Aug 2009 17:00:00 +0900

JSON Response Example

{
    "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": "Wireframe",
    "description": "Current project wireframe",
    "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 Response Example

<?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>Wireframe</title>
  <description>Current project wireframe</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>