Get Sites per User
Get Crafter Studio sites available to current user with an optional range for pagination.
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
|
GET
|
URL
|
/api/1/services/api/1/site/get-per-user.json |
Response Formats
|
JSON |
Required Role
|
Admin, self
|
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
start
|
Integer
|
Start offset
|
|
number
|
Integer
|
Number of records to retrieve
|
Example
GET .../api/1/services/api/1/site/get-per-user.json
1{
2 "sites":[
3 {
4 "id":4,
5 "siteUuid":"9f41ea2d-e8a0-4c05-8b91-a2a2eb9ee746",
6 "siteId":"hello",
7 "name":"hello",
8 "description":null,
9 "deleted":0,
10 "liveUrl":null,
11 "lastCommitId":"d2302a5753205afe0043e8380dd0fe20e1064334",
12 "publishingEnabled":1,
13 "publishingStatus":"ready",
14 "publishingStatusMessage":"Ready",
15 "lastVerifiedGitlogCommitId":"d2302a5753205afe0043e8380dd0fe20e1064334",
16 "sandboxBranch":"master",
17 "publishedRepoCreated":0,
18 "publishingLockOwner":null,
19 "publishingLockHeartbeat":null,
20 "state":"READY",
21 "lastSyncedGitlogCommitId":"d2302a5753205afe0043e8380dd0fe20e1064334",
22 "siteDeleted":false,"sitePublishedRepoCreated":false
23 },
24 {
25 "id":2,
26 "siteUuid":"a59df951-cf4d-45e3-8103-50ef1db9d51b",
27 "siteId":"my-site",
28 "name":"My Site",
29 "description":null,
30 "deleted":0,
31 "liveUrl":null,
32 "lastCommitId":"2421c262edaec6f9b75647cbb54e0b38ecf4462f",
33 "publishingEnabled":1,
34 "publishingStatus":"queued",
35 "publishingStatusMessage":"Items are queued for publishing",
36 "lastVerifiedGitlogCommitId":"2421c262edaec6f9b75647cbb54e0b38ecf4462f",
37 "sandboxBranch":"master",
38 "publishedRepoCreated":1,
39 "publishingLockOwner":null,
40 "publishingLockHeartbeat":null,
41 "state":"READY",
42 "lastSyncedGitlogCommitId":"2421c262edaec6f9b75647cbb54e0b38ecf4462f",
43 "siteDeleted":false,
44 "sitePublishedRepoCreated":true
45 }
46 ],
47 "total":2
48}
Response
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
.../site/get-per-user.json... |
See example above.
|
400
|
{ "message" : "Invalid parameter(s)" } |
|
401
|
{ "message" : "Unauthorized" } |
|
404
|
{ "message" : "User not found"} |
|
500
|
{ "message" : "Internal server error" } |