...
This method does not require authentication and can only be run once.
HTML Table |
---|
Wiki Markup |
---|
{table:border=1|cellpadding=5|cellspacing=0|style=border | 1 |
---|
cellpadding | 5 |
---|
cellspacing | 0 |
---|
style |
---|
| | |
}
{tr}{td:style= }* *{td}
{td}Append {{ Table Cell (td) |
---|
Append /api/rest/service |
| }} {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} 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
|
Code Block |
---|
{
serviceInit: {
initialAdminUsername: "fwilson",
initialAdminPassword: "puppies1"
}
}
|
Response: No Format |
---|
HTTP/1.1 200 OK
Content-Type: application/vnd.fcrepo-cloudsync.serviceinfo+json
|
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"
}
}
|
|
...
This method does not require authentication.
HTML Table |
---|
Wiki Markup |
---|
{table:border=1|cellpadding=5|cellspacing=0|style=border | 1 |
---|
cellpadding | 5 |
---|
cellspacing | 0 |
---|
style |
---|
| | |
}
{tr}{td:style= }* *{td}
{td}Append {{ 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: No Format |
---|
GET /cloudsync/api/rest/service HTTP/1.1
Accept: application/vnd.fcrepo-cloudsync.serviceinfo+json
|
Response: No Format |
---|
HTTP/1.1 200 OK
Content-Type: application/vnd.fcrepo-cloudsync.serviceinfo+json
|
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"
}
}
|
|
...
A JSON object with a serviceInfo
field whose value is an associative array of the following fields:
HTML Table |
---|
Wiki Markup |
---|
{table:border=1|cellpadding=5|cellspacing=0|style=border | 1 |
---|
cellpadding | 5 |
---|
cellspacing | 0 |
---|
style |
---|
| | |
}
{:= }{}**{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} 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 |
---|
{
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"
}
}
|
...
A JSON object with a serviceInit
field whose value is an associative array of the following fields:
HTML Table |
---|
Wiki Markup |
---|
{table:border=1|cellpadding=5|cellspacing=0|style=border | 1 |
---|
cellpadding | 5 |
---|
cellspacing | 0 |
---|
style |
---|
| | |
}
{:= }{}**{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} 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 |
---|
{
serviceInit: {
initialAdminUsername: "fwilson",
initialAdminPassword: "PuppiesRgr8!"
}
}
|
...