Contents
Move diagram
Move a diagram to specified fodler.
Method
GET, POST
URL
https://cacoo.com/api/v1/diagrams/diagramId/move.format
Example : https://cacoo.com/api/v1/diagrams/00e77f4dc9973517/move.json
Format
json, xml
Authentication
required
Error
Status Code | Message | Content |
---|---|---|
400 | Message to verify entered text | Error found in entered text |
404 | FOLDER_NOT_FOUND | Cannot move the diagram as the folder does not exist or you have no permission. |
Parameters
Parameter Name | Type | Content | Example |
---|---|---|---|
diagramId (Required) | String | Diagram Id | 00e77f4dc9973517 |
folderId (Required) | Integer | Destination folder’s ID | 123 |
organizationKey (Required) | String | Organization Key from the Organizations API | abcdefghij |
*If you are using a legacy plan (i.e. the old Free Plan or Plus Plan), you do not need to add organizationKey
to the parameters.
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 |
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"
}
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>
</diagram>