...
On
...
this
...
page:
Methods
Anchor |
---|
| postServiceInit |
---|
| postServiceInit |
---|
|
POST serviceInit
Initializes the service by adding the first administrative user.
This method does not require authentication and can only be run once.
HTML Table |
---|
border | 1 |
---|
cellpadding | 5 |
---|
cellspacing | 0 |
---|
style | background-color: #eee |
---|
|
*
{toc}
h1. Methods
{anchor:postServiceInit}
h2. POST serviceInit
Initializes the service by adding the first administrative user.
This method does not require authentication and can only be run once.
{table:border=1|cellpadding=5|cellspacing=0|style=background-color: #eee}
{tr}{td:style=background-color: #ccc}*Request URI*{td}
{td}Append {{ Table Row (tr) |
---|
Table Cell (td) |
---|
style | background-color: #ccc |
---|
| Request URI |
| }} {td}{tr}
{tr}{td:style= }* *{td}
{td}_None_{td}{tr}
{tr}{td:style= }* *{td}
{td}{{[|#serviceInitJSON]}}
{{[|#serviceInitXML]}}{td}{tr}
{tr}{td:style= }* *{td}
{td}{{[|#serviceInfoJSON]}}
{{[|#serviceInfoXML]}}{td}{tr}
{tr}{td:style= }* *{td}
{td}{{200 Ok}}
{{209 Conflict}} if the service is already initialized.{td}{tr}
{table}
*Example:*
{panel}
*Request:*
{noformat} Table Cell (td) |
---|
200 Ok 209 Conflict if the service is already initialized. |
|
|
Example:
Panel |
---|
Request: No Format |
---|
POST /cloudsync/api/rest/service HTTP/1.1
Content-Type: application/vnd.fcrepo-cloudsync.serviceinit+json
Accept: application/vnd.fcrepo-cloudsync.serviceinfo+json
| {noformat}
{code} Code Block |
---|
{
serviceInit: {
initialAdminUsername: "fwilson",
initialAdminPassword: "puppies1"
}
}
| {code}
*Response: *
{} |
---|
HTTP/1.1 200 OK
Content-Type: application/vnd.fcrepo-cloudsync.serviceinfo+json
| {noformat}
{code} Code Block |
---|
{
serviceInfo: {
buildDate: "2011-10-26 11:50:56 UTC-0400",
currentUserUri: "https://example.org/path/to/user",
initialized: false,
objectSetsUri: "https://example.org/path/to/objectSets",
objectStoresUri: "https://example.org/path/to/objectStores",
providerAccountsUri: "https://example.org/path/to/providerAccounts",
spacesUri: "https://example.org/path/to/spaces",
taskLogsUri: "https://example.org/path/to/taskLogs",
tasksUri: "https://example.org/path/to/tasks",
usersUri: "https://example.org/path/to/users",
version: "1.0.0"
}
}
| {code}
{panel}
{anchor:getServiceInfo}
h2. GET serviceInfo
Gets key information about the service, including URIs of other resources that comprise the REST API.
This method does not require authentication.
{table:border=1|cellpadding=5|cellspacing=0|style=background-color: #eee}
{tr}{td:style=background-color: #ccc}*Request URI*{td}
{td}Append {{ |
Anchor |
---|
| getServiceInfo |
---|
| getServiceInfo |
---|
|
GET serviceInfo
Gets key information about the service, including URIs of other resources that comprise the REST API.
This method does not require authentication.
HTML Table |
---|
border | 1 |
---|
cellpadding | 5 |
---|
cellspacing | 0 |
---|
style | background-color: #eee |
---|
|
Table Row (tr) |
---|
Table Cell (td) |
---|
style | background-color: #ccc |
---|
| Request URI |
Table Cell (td) |
---|
Append /api/rest/service |
| }} {td}{tr}
{tr}{td:style= }* *{td}
{td}_None_{td}{tr}
{tr}{td:style= }* *{td}
{td}_None_{td}{tr}
{tr}{td:style= }* *{td}
{td}{{[|#serviceInfoJSON]}}
{{[|#serviceInfoXML]}}{td}{tr}
{tr}{td:style= }* *{td}
{td}{{200 Ok}}{td}{tr}
{table}
*Example:*
{panel}
*Request:*
{noformat} |
Example:
Panel |
---|
Request: No Format |
---|
GET /cloudsync/api/rest/service HTTP/1.1
Accept: application/vnd.fcrepo-cloudsync.serviceinfo+json
| {noformat}
*Response: *
{} |
---|
HTTP/1.1 200 OK
Content-Type: application/vnd.fcrepo-cloudsync.serviceinfo+json
| {noformat}
{code} Code Block |
---|
{
serviceInfo: {
buildDate: "2011-10-26 11:50:56 UTC-0400",
currentUserUri: "https://example.org/path/to/user",
initialized: false,
objectSetsUri: "https://example.org/path/to/objectSets",
objectStoresUri: "https://example.org/path/to/objectStores",
providerAccountsUri: "https://example.org/path/to/providerAccounts",
spacesUri: "https://example.org/path/to/spaces",
taskLogsUri: "https://example.org/path/to/taskLogs",
tasksUri: "https://example.org/path/to/tasks",
usersUri: "https://example.org/path/to/users",
version: "1.0.0"
}
}
| {code}
{panel}
h1. Media Types
{anchor:serviceInfoJSON}
h2. |
Media Types
Anchor |
---|
| serviceInfoJSON |
---|
| serviceInfoJSON |
---|
|
application/vnd.fcrepo-cloudsync.serviceinfo+json
...
A
...
JSON
...
object
...
with
...
a
...
serviceInfo
...
field
...
whose
...
value
...
is
...
an
...
associative
...
array
...
of
...
the
...
following
...
fields:
{ HTML Table |
---|
: | = | | | = | | | = | | | = | |
}
{:= }{}* Table Cell (td) |
---|
Description |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
The date the CloudSync software was built |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
currentUserUri |
Table Cell (td) |
---|
A URI that can be used to get the current user via GET user |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
initialized |
Table Cell (td) |
---|
true if POST serviceInit has been successfully called on this instance, false otherwise |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
objectSetsUri |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
objectStoresUri |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
providerAccountsUri |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
The URI to be used for GET spaces requests |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
taskLogsUri |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
The version of the CloudSync software |
|
|
Example:
Code Block |
---|
*{td}{td}*Description*{td}{td}*Required?*{td}{tr}
{tr}{td}{{buildDate}}{td}{td}The date the CloudSync software was built{td}{td}Yes{td}{tr}
{tr}{td}{{currentUserUri}}{td}{td}A URI that can be used to get the current user via [GET user|User Resources#getUser]{td}{td}Yes{td}{tr}
{tr}{td}{{initialized}}{td}{td}{{true}} if [POST serviceInit|#postServiceInit] has been successfully called on this instance, {{false}} otherwise{td}{td}Yes{td}{tr}
{tr}{td}{{objectSetsUri}}{td}{td}The URI to be used for [GET objectSets|Object Set Resources#getObjectSets] and [POST objectSet|Object Set Resources#postObjectSet] requests{td}{td}Yes{td}{tr}
{tr}{td}{{objectStoresUri}}{td}{td}The URI to be used for [GET objectStores|Object Store Resources#getObjectStores] and [POST objectStore|Object Store Resources#postObjectStore] requests{td}{td}Yes{td}{tr}
{tr}{td}{{providerAccountsUri}}{td}{td}The URI to be used for [GET providerAccounts|DuraCloud Resources#getProviderAccounts] requests{td}{td}Yes{td}{tr}
{tr}{td}{{spacesUri}}{td}{td}The URI to be used for [GET spaces|DuraCloud Resources#getSpaces] requests{td}{td}Yes{td}{tr}
{tr}{td}{{taskLogsUri}}{td}{td}The URI to be used for [GET taskLogs|Task Log Resources#getTaskLogs] requests{td}{td}Yes{td}{tr}
{tr}{td}{{tasksUri}}{td}{td}The URI to be used for [GET tasks|Task Resources#getTasks] and [POST task|Task Resources#postTask] requests{td}{td}Yes{td}{tr}
{tr}{td}{{usersUri}}{td}{td}The URI to be used for [GET users|User Resources#getUsers] and [POST user|User Resources#postUser] requests{td}{td}Yes{td}{tr}
{tr}{td}{{version}}{td}{td}The version of the CloudSync software{td}{td}Yes{td}{tr}
{table}
*Example:*
{code}
{
serviceInfo: {
buildDate: "2011-10-26 11:50:56 UTC-0400",
currentUserUri: "https://example.org/path/to/user",
initialized: false,
objectSetsUri: "https://example.org/path/to/objectSets",
objectStoresUri: "https://example.org/path/to/objectStores",
providerAccountsUri: "https://example.org/path/to/providerAccounts",
spacesUri: "https://example.org/path/to/spaces",
taskLogsUri: "https://example.org/path/to/taskLogs",
tasksUri: "https://example.org/path/to/tasks",
usersUri: "https://example.org/path/to/users",
version: "1.0.0"
}
}
{code}
{anchor:serviceInfoXML}
h2. |
Anchor |
---|
| serviceInfoXML |
---|
| serviceInfoXML |
---|
|
application/vnd.fcrepo-cloudsync.serviceinfo+xml
...
An
...
XML
...
encoding
...
of
...
the
...
above.
...
Example:
*
{ No Format |
---|
: | = |
}
<serviceInfo>
<buildDate>2011-10-26 11:50:56 UTC-0400</buildDate>
<currentUserUri>https://example.org/path/to/user</currentUserUri>
<initialized>false</initialized>
<objectSetsUri>https://example.org/path/to/objectSets</objectSetsUri>
<objectStoresUri>https://example.org/path/to/objectStores</objectStoresUri>
<providerAccountsUri>https://example.org/path/to/providerAccounts</providerAccountsUri>
<spacesUri>https://example.org/path/to/spaces</spacesUri>
<taskLogsUri>https://example.org/path/to/taskLogs</taskLogsUri>
<tasksUri>https://example.org/path/to/tasks</tasksUri>
<usersUri>https://example.org/path/to/users</usersUri>
<version>1.0.0</version>
</serviceInfo>
{noformat}
{anchor:serviceInitJSON}
h2. |
Anchor |
---|
| serviceInitJSON |
---|
| serviceInitJSON |
---|
|
application/vnd.fcrepo-cloudsync.serviceinit+json
...
A
...
JSON
...
object
...
with
...
a
...
serviceInit
...
field
...
whose
...
value
...
is
...
an
...
associative
...
array
...
of
...
the
...
following
...
fields:
{ HTML Table |
---|
: | = | | | = | | | = | | | = | |
}
{:= }{}* Table Cell (td) |
---|
Description |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
initialAdminUsername |
Table Cell (td) |
---|
The username of the initial admin user. |
|
Table Row (tr) |
---|
Table Cell (td) |
---|
initialAdminPassword |
Table Cell (td) |
---|
The password of the initial admin user. |
|
|
Example:
Code Block |
---|
*{td}{td}*Description*{td}{td}*Required?*{td}{tr}
{tr}{td}{{initialAdminUsername}}{td}{td}The username of the initial admin user.{td}{td}Yes{td}{tr}
{tr}{td}{{initialAdminPassword}}{td}{td}The password of the initial admin user.{td}{td}Yes{td}{tr}
{table}
*Example:*
{code}
{
serviceInit: {
initialAdminUsername: "fwilson",
initialAdminPassword: "PuppiesRgr8!"
}
}
{code}
{anchor:serviceInitXML}
h2. |
Anchor |
---|
| serviceInitXML |
---|
| serviceInitXML |
---|
|
application/vnd.fcrepo-cloudsync.serviceinit+xml
...
An
...
XML
...
encoding
...
of
...
the
...
above.
...
Example:
*
{ No Format |
---|
: | = |
}
<serviceInit>
<initialAdminUsername>fwilson</initialAdminUsername>
<initialAdminPassword>PuppiesRgr8!</initialAdminPassword>
</serviceInit>
{noformat} |