Versions Compared

Old Version 1

changes.mady.by.user Chris Wilper

Saved on

compared with

New Version Current

changes.mady.by.user Chris Wilper

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

On

...

this

...

page:

Table of Contents

Methods

Anchor
getProviderAccounts
getProviderAccounts

GET providerAccounts

Gets key information about the storage provider accounts configured for a DuraCloud instance.

HTML Table
border1
cellpadding5
cellspacing0
stylebackground-color: #eee
Table Row (tr)
Table Cell (td)
stylebackground-color: #ccc
Request URI
Table Cell (td)
See providerAccountsUri in GET serviceInfo or POST serviceInit response
Table Row (tr)
Table Cell (td)
stylebackground-color: #ccc
Query Parameters
Table Cell (td)
url: DuraStore URL
username: The DuraCloud username to connect as
password: The DuraCloud password
Table Row (tr)
Table Cell (td)
stylebackground-color: #ccc
Request Formats
Table Cell (td)
None
* {toc} h1. Methods {anchor:getProviderAccounts} h2. GET providerAccounts Gets key information about the storage provider accounts configured for a DuraCloud instance. {table:border=1|cellpadding=5|cellspacing=0|style=background-color: #eee} {tr}{td:style=background-color: #ccc}*Request URI*{td} {td}See {{providerAccountsUri}} in [GET serviceInfo|Service Resource#getServiceInfo] or [POST serviceInit|Service Resource#postServiceInit] response{td}{tr} {tr}{td:style=background-color: #ccc}*Query Parameters*{td} {td}*url:* DuraStore URL *username:* The DuraCloud username to connect as *password:* The DuraCloud password{td}{tr} {tr}{td:style=background-color: #ccc}*Request Formats*{td} {td}_None_{td}{tr} {tr}{td:style=background-color: #ccc}*Response Formats*{td} {td}{{[
Table Row (tr)
Table Cell (td)
stylebackground-color: #ccc
Response Formats
Table Cell (td)
application/vnd.fcrepo-cloudsync.provideraccounts+json
|#providerAccountsJSON]}} {{[

application/vnd.fcrepo-cloudsync.provideraccounts+xml
|#providerAccountsXML]}}{td}{tr} {tr}{td:style=
Table Row (tr)
Table Cell (td)
stylebackground-color:
#ccc
}*
Typical
Status
Codes
*{td} {td}{{200 Ok}} {{500 Internal Server Error}} if there is any kind of error
Table Cell (td)
200 Ok
500 Internal Server Error if there is any kind of error querying the DuraCloud instance

Example:

Panel

Request:

querying the DuraCloud instance{td}{tr} {table} *Example:* {panel} *Request:* {noformat}
No Format

GET /path/to/providerAccounts HTTP/1.1
Accept: application/vnd.fcrepo-cloudsync.provideraccounts+json
{noformat} *
Response:
*
{
 No Format
}

HTTP/1.1 200 OK
Content-Type: application/vnd.fcrepo-cloudsync.provideraccounts+json

{noformat}
{code}
 Code Block

{
  providerAccounts: [
    {
      id: 38,
      type: "RACKSPACE",
      primary: false
    },
    {
      id: 39,
      type: "AMAZON_S3",
      primary: true
    }
  ]
}

{code}
{panel}




{anchor:getSpaces}
h2. GET spaces



h1. Media Types




{anchor:serviceInfoJSON}
h2. 
 Anchor
getSpaces
getSpaces
GET spaces
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
border
1
cellpadding
5
cellspacing
0
style
background-color: 
 #eee
}
{
 Table Row (tr)
:
style
=
background-color: 
 
 #ccc
}{
 Table Cell (td)
}*
Field
 Table Cell (td)
Description
 Table Cell (td)
Required?
 Table Row (tr)
 Table Cell (td)
buildDate
 Table Cell (td)
The date the CloudSync software was built
 Table Cell (td)
Yes
 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 Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
initialized
 Table Cell (td)
true if POST serviceInit has been successfully called on this instance, false otherwise
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
objectSetsUri
 Table Cell (td)
The URI to be used for GET objectSets and POST objectSet requests
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
objectStoresUri
 Table Cell (td)
The URI to be used for GET objectStores and POST objectStore requests
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
providerAccountsUri
 Table Cell (td)
The URI to be used for GET providerAccounts requests
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
spacesUri
 Table Cell (td)
The URI to be used for GET spaces requests
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
taskLogsUri
 Table Cell (td)
The URI to be used for GET taskLogs requests
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
tasksUri
 Table Cell (td)
The URI to be used for GET tasks and POST task requests
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
usersUri
 Table Cell (td)
The URI to be used for GET users and POST user requests
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
version
 Table Cell (td)
The version of the CloudSync software
 Table Cell (td)
Yes
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
borderStyle
dashed
}
<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
border
1
cellpadding
5
cellspacing
0
style
background-color: 
 #eee
}
{
 Table Row (tr)
:
style
=
background-color: 
 
 #ccc
}{
 Table Cell (td)
}*
Field
 Table Cell (td)
Description
 Table Cell (td)
Required?
 Table Row (tr)
 Table Cell (td)
initialAdminUsername
 Table Cell (td)
The username of the initial admin user.
 Table Cell (td)
Yes
 Table Row (tr)
 Table Cell (td)
initialAdminPassword
 Table Cell (td)
The password of the initial admin user.
 Table Cell (td)
Yes
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
borderStyle
dashed
}
<serviceInit>
  <initialAdminUsername>fwilson</initialAdminUsername>
  <initialAdminPassword>PuppiesRgr8!</initialAdminPassword>
</serviceInit>
{noformat}