• Document Up to Date

Copy Item

Copy item to clipboard.

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /studio, please prefix the API URLs with this context.

HTTP Verb
POST
URL
/api/1/services/api/1/clipboard/copy-item.json
Response Formats
JSON
Required Role
N/A

Parameters

Name
Type
Required
Description
site_id
String
Site to use

Example

Request

POST .../api/1/services/api/1/clipboard/copy-item.json?site_id=mysite
 1{
 2  "item":
 3    [
 4      {
 5        "uri":"/site/website/articles",
 6        "children":
 7          [
 8            {
 9              "uri":"/site/website/articles/crafter-level-descriptor.level.xml"
10            },
11            {
12              "uri":"/site/website/articles/2016",
13              "children":
14                [
15                  {
16                    "uri":"/site/website/articles/2016/12",
17                    "children":
18                      [
19                        {
20                          "uri":"/site/website/articles/2016/12/top-books-for-young-women/index.xml"
21                        }
22                      ]
23                  },
24                  {
25                    "uri":"/site/website/articles/2016/6",
26                    "children":
27                      [
28                        {
29                          "uri":"/site/website/articles/2016/6/coffee-is-good-for-your-health/index.xml"
30                        }
31                      ]
32                  },
33                  {
34                    "uri":"/site/website/articles/2016/7",
35                    "children":
36                      [
37                        {
38                          "uri":"/site/website/articles/2016/7/new-acme-phone-released-today/index.xml"
39                        }
40                      ]
41                  }
42                ]
43            },
44            {
45              "uri":"/site/website/articles/2017",
46              "children":
47                [
48                  {
49                    "uri":"/site/website/articles/2017/1",
50                    "children":
51                      [
52                        {
53                          "uri":"/site/website/articles/2017/1/men-styles-for-winter/index.xml"
54                        },
55                        {
56                          "uri":"/site/website/articles/2017/1/women-styles-for-winter/index.xml"
57                        }
58                      ]
59                  },
60                  {
61                    "uri":"/site/website/articles/2017/2",
62                    "children":
63                      [
64                        {
65                          "uri":"/site/website/articles/2017/2/10-tips-to-get-a-six-pack/index.xml"
66                        },
67                        {
68                          "uri":"/site/website/articles/2017/2/top-romantic-valentine-movies/index.xml"
69                        }
70                      ]
71                  },
72                  {
73                    "uri":"/site/website/articles/2017/3",
74                    "children":
75                      [
76                        {
77                          "uri":"/site/website/articles/2017/3/5-popular-diets-for-women/index.xml"
78                        },
79                        {
80                          "uri":"/site/website/articles/2017/3/top-clubs-in-virginia/index.xml"
81                        }
82                      ]
83                  }
84                ]
85            }
86          ]
87      }
88    ]
89}

Response

Status 200 OK

{ "success" : true }

Responses

Status
Location
Response Body
200

See example above.
400

{ "message" : "Bad Request" }