ACE API

Add Collection

• Request: POST https://host:port/ace-am/rest/collection

• Request Body: XML or JSON

  collection-add-sample

  {
  "digestAlgorithm":"SHA-256",
  "directory":"/export/gluster/chronopolis/sio-gdc/SSDB",
  "group":"sio-gdc",
  "name":"SSDB",
  "settings":{"entry":[{"key":"proxy.data","value":"false"},
  					 {"key":"email.recipients","value":"thatslackemail@ucsd.edu"},
  					 {"key":"audit.period","value":"182"},
  				     {"key":"audit.tokens","value":"true"}]},
  "storage":"local"
  }

• Response: 200 (on success), 500 (server error), 400 (bad request - duplicate collection)

• Response Body: JSON

  { "id": 14 }

Modify Collection

• Request: POST https://host:port/ace-am/rest/collection/modify/{id}
  • id - The identifier of the collection

• Request Body: JSON

  Collection modify

  {
  "digestAlgorithm":"SHA-256",
  "directory":"/export/gluster/chronopolis/sio-gdc/SSDB-irods",
  "group":"sio-gdc-irods",
  "name":"SSDB",
  "settings":{"entry":[{"key":"proxy.data","value":"true"},
  					 {"key":"email.recipients","value":"updatedslackemail@ucsd.edu"},
  					 {"key":"audit.period","value":"181"},
  				     {"key":"audit.tokens","value":"true"}]},
  "storage":"irods"
  }

• Response: 200 (on success), 400 (bad request)
• Response Body: None

Audit Collection

• Request: POST https://host:port/ace-am/rest/collection/audit/{id}
  • id - The identifier of the collection
• Request Body: None
• Response: 200 (on success)
• Response Body: None

Get Collection

• Request: GET https://host:port/ace-am/rest/collection/settings/by-id/{id}
• Request: GET https://host:port/ace-am/rest/collection/settings/by-name/{name}
• Request: GET https://host:port/ace-am/rest/collection/settings/by-name/{name}/{group}
  • id - The identifier of the collection
  • name - The name of the collection
  • group - The group of the collection. If not included, no group will be used
• Response: 200 (on success)

• Response Body: JSON

  {
  "digestAlgorithm":"SHA-256",
  "directory":"/export/gluster/chronopolis/acadis/acadis_datasets_01-31-2013",
  "group":"acadis",
  "id":"111",
  "lastSync":"2015-08-13T15:46:03-04:00",
  "name":"acadis_datasets_01-31-2013",
  "settings":{"entry":[{"key":"audit.tokens","value":"true"},
  					 {"key":"audit.period","value":"182"},
  					 {"key":"proxy.data","value":"false"}]},
  "state":"65",
  "storage":"local"}

Load TokenStore

• Request: POST https://host:port/ace-am/rest/tokenstore/{collectionId}
  • collectionId - The identifier of the collection
• Request Body: Multipart-Encoded File
• Response Code: 200 (on success)
• Response Body: None