Versions Compared

Old Version 1

changes.mady.by.user Michael Ritter

Saved on

compared with

New Version 2

changes.mady.by.user Michael Ritter

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
titleCollection Operations
borderStylesolid

Add Collection

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

  • Request Body: XML or JSON

    Code Block
    languagejfx
    titlecollection-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

    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":{"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

    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":{"entry":[{"key":"audit.tokens","value":"true"},
					 {"key":"audit.period","value":"182"},
					 {"key":"proxy.data","value":"false"}]},
"state":"65",
"storage":"local"}
Panel
titleDiscovery Operations

List Groups

  • Request: GET https://host:port/ace-am/rest/groups
  • Response: 200 (on success)

  • Response Body: JSON

    Code Block
    ["rci-baru","ncar-lib","cdl","sio-gdc","ncstate","cadis","acadis","rci-wagner","rci-siogeocoll","duracloud_statenorthcarolina","chronopolis","rci-annese","ucsd-lib","ncar","ucsdtest"]

List Collection In A Group

  • Request: GET https://host:port/ace-am/rest/collections/by-group
  • Request: GET https://host:port/ace-am/rest/collection/by-group/{group}
    • group: The group to query on. If not included, collection with no group will be searched.
  • Response: 200 (on success)

  • Response Body: JSON

    Code Block
    {"collection":[{"digestAlgorithm":"SHA-256",
				"directory":"/export/gluster/chronopolis/chronopolis/umiacs-ace_2015-08-03",
				"group":"chronopolis",
				"id":"180",
				"lastSync":"2015-08-25T11:17:01-04:00",
				"name":"umiacs-ace_2015-08-03",
				"settings":{"entry":[{"key":"audit.tokens","value":"true"},
									 {"key":"audit.period","value":"90"},
									 {"key":"proxy.data","value":"false"}]},
				"state":"65",
				"storage":"local"},
			   {"digestAlgorithm":"SHA-256",
				"directory":"/export/gluster/chronopolis/chronopolis/ucsd-ace_2015-07-31",
				"group":"chronopolis",
				"id":"179",
				"lastSync":"2015-08-25T11:17:18-04:00",
				"name":"ucsd-ace_2015-07-31",
				"settings":{"entry":[{"key":"audit.tokens","value":"true"},
									 {"key":"audit.period","value":"90"},
									 {"key":"proxy.data","value":"false"}]},
				"state":"65",
				"storage":"local"},
			   {"digestAlgorithm":"SHA-256",
				"directory":"/export/gluster/chronopolis/chronopolis/ncar-ace_2015-08-03",
				"group":"chronopolis",
				"id":"178",
				"lastSync":"2015-08-25T11:17:21-04:00",
				"name":"ncar-ace_2015-08-03",
				"settings":{"entry":[{"key":"audit.tokens","value":"true"},
									 {"key":"audit.period","value":"90"},
									 {"key":"proxy.data","value":"false"}]},
				"state":"65",
				"storage":"local"}]}

 

 

Panel
titleTokenStore
borderStylesolid

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