Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel
borderStylesolid
titleCollection Operations

Add Collection

  • Request: POST https://host:port/ace-am/rest/collection
  • Request Body: XML or JSON

    Code Block
    languagejfx
    {
    "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

    Code Block
    { "id": 14 }


Modify Collection

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

    Code Block
    titleCollection modify
    {
    "digestAlgorithm":"SHA-256",
    "directory":"/export/gluster/chronopolis/sio-gdc/SSDB-irods",
    "group":"sio-gdc-irods",
    "name":"SSDB",
    "settings":{"proxy.data": "true",
    			"email.recipients": "updatedslackemail@ucsd.edu",
    			"audit.period": "181",
    			"audit.tokens": "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

    Code Block
    {
    "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":{"audit.tokens":"true",
    			"audit.period":"182",
    			"proxy.data":"false"},
    "state":"65",
    "storage":"local"}


...