docuteam wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Zuletzt angesehen:
docuteam:bridge

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste ÜberarbeitungBeide Seiten der Revision
docuteam:bridge [2020/01/24 14:13] – Andreas Nefdocuteam:bridge [2020/01/27 15:46] – Andreas Nef
Zeile 103: Zeile 103:
 <code>curl -X POST -F "package=@sip.zip" "https://bridge.docuteam.ch/depositions?token=123456789012345&package_format=DocuteamDublincore1.0"</code> <code>curl -X POST -F "package=@sip.zip" "https://bridge.docuteam.ch/depositions?token=123456789012345&package_format=DocuteamDublincore1.0"</code>
  
-==== index ====+==== Index ====
 Lists/shows the existing depositions with details. Lists/shows the existing depositions with details.
  
Zeile 121: Zeile 121:
  
 === Examples === === Examples ===
-<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345"</code> +<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345" 
-<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345&id=2"</code> +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&id=2" 
-<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=submitted"</code> +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=submitted" 
-<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=submitted&organization=XY"</code> +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=submitted&organization=XY" 
-<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345&from=2018-11-01&until=2018-11-30"</code> +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&from=2018-11-01&until=2018-11-30" 
-<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=error&from=2018-11-01"</code>+curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=error&from=2018-11-01"</code>
  
 ==== Show ==== ==== Show ====
Zeile 159: Zeile 159:
  
 === Examples === === Examples ===
-<code>curl -X PUT "https://bridge.docuteam.ch/depositions/12345?token=123456789012345&status=deleted"</code> +<code>curl -X PUT "https://bridge.docuteam.ch/depositions/12345?token=123456789012345&status=deleted" 
-<code>curl -X PUT "https://bridge.docuteam.ch/depositions/23?token=12super34token56&status=archived&feeder_response=%7B%22pids%22%3A%5B%221%22%2C%222%22%5D%7D"</code> +curl -X PUT "https://bridge.docuteam.ch/depositions/23?token=12super34token56&status=archived&feeder_response=%7B%22pids%22%3A%5B%221%22%2C%222%22%5D%7D"</code> 
  
 ==== Responses ==== ==== Responses ====
Zeile 295: Zeile 295:
  
 === Examples === === Examples ===
-<code>curl "https://bridge.docuteam.ch/access/sync_dip/CH-123456-7:38?token=123456789012345" --output dip.zip</code> +<code>curl "https://bridge.docuteam.ch/access/sync_dip/CH-123456-7:38?token=123456789012345" --output dip.zip 
-<code>curl "https://bridge.docuteam.ch/access/sync_dip/CH-123456-7:38?token=123456789012345&recursively=true  --output dip.zip</code>+curl "https://bridge.docuteam.ch/access/sync_dip/CH-123456-7:38?token=123456789012345&recursively=true  --output dip.zip</code>
  
  
Zeile 320: Zeile 320:
 <code> <code>
 GET   /changes       changes#index GET   /changes       changes#index
-GET   /changes/:id   changes#show +POST  /changes/:pid   changes#create 
-POST  /changes/:id   changes#create +GET   /changes/:pid   changes#show 
-PUT   /changes/:id   changes#update+PUT   /changes/:pid   changes#update
 </code> </code>
  
Zeile 332: Zeile 332:
  
 === Requirements === === Requirements ===
-Token with role ''read'', ''create'', ''manage'',  or ''admin''.+Token with role ''manage'' or ''admin''.
  
 === Parameters === === Parameters ===
   * '':pid'' persistent identifier of a repository object   * '':pid'' persistent identifier of a repository object
   * ''token''   * ''token''
 +  * ''task'' => type of change, e.g. "data_update", "metadata_update", "object_update", "data_delete", or "object_delete"
 +  * ''package_format'' => indicate the format of the submitted package, e.g. "MatterhornMets" or "DocuteamDublincore1.0" (optional, default: "MatterhornMets")
 +  * ''[binary data]'' => required if task is "*_update"
  
 === Examples === === Examples ===
-<code>curl "https://bridge.docuteam.ch/access/sync_metadata/CH-123456-7:38?token=123456789012345" --output ead.xml</code>+<code>curl -X POST -F "package=@sip.zip" "https://bridge-stage.docuteam.ch/changes?token=123456789012345&pid=CH-654321-0:3&task=object_update&package_format=DocuteamDublincore1.0" 
 +curl -X POST "https://bridge-stage.docuteam.ch/changes/CH-654321-0:3?token=123456789012345&task=object_delete"</code> 
 + 
 +==== Index ==== 
 +Lists/shows the existing depositions with details. 
 + 
 +=== Allowed calls === 
 +GET   /depositions 
 + 
 +=== Requirements === 
 +Token with role ''create'', ''manage'', or ''feeder''. 
 + 
 +=== Parameters === 
 +  * ''token'' 
 +  * ''id'' (optional) 
 +  * ''status'' (optional) 
 +  * ''from'' (optional, format:YYYY-MM-DD) 
 +  * ''until'' (optional, format:YYYY-MM-DD) 
 +  * ''organization'' (optional) 
 + 
 +=== Examples === 
 +<code>curl "https://bridge.docuteam.ch/depositions?token=123456789012345" 
 +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&id=2" 
 +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=submitted" 
 +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=submitted&organization=XY" 
 +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&from=2018-11-01&until=2018-11-30" 
 +curl "https://bridge.docuteam.ch/depositions?token=123456789012345&status=error&from=2018-11-01"</code> 
  
 == changes routes detailed == == changes routes detailed ==
 ^ Action      ^ Description       ^ Examples         ^ ^ Action      ^ Description       ^ Examples         ^
-| **create**      | **HTTP POST** on /changes/:id,\\  **parameters:** \\ - pid (repository persistent identifier) \\ - package_fromat (default: MatterhornMets) \\ - task (data_update, metadata_update, object_update or data_delete, object_delete) | <code>curl -X POST -F "package=@sip.zip" "https://bridge-stage.docuteam.ch/changes +| **create**      | **HTTP POST** on /changes/:id,\\  **parameters:** \\ - pid (repository persistent identifier) \\ - package_fromat (default: MatterhornMets) \\ - task (data_update, metadata_update, object_update or data_delete, object_delete) |       |
-          ?token=123456789012345&pid=CH-654321-0:3&task=object_update&package_format=DocuteamDublincore1.0"</code> <code>curl -X POST "https://bridge-stage.docuteam.ch/changes/CH-654321-0:3?token=123456789012345&task=object_delete"</code>       |+
 | **list** / **show** | **HTTP GET** on /changes,\\ **parameters:** \\ - id (optional, change id), \\ -status (optional), \\ -from (optional, format:YYYY-MM-DD), \\ -until (optional, format:YYYY-MM-DD), \\ -organization (optional)   | <code>curl "https://bridge-stage.docuteam.ch/changes?token=123456789012345"</code> <code>curl "https://bridge-stage.docuteam.ch/changes | **list** / **show** | **HTTP GET** on /changes,\\ **parameters:** \\ - id (optional, change id), \\ -status (optional), \\ -from (optional, format:YYYY-MM-DD), \\ -until (optional, format:YYYY-MM-DD), \\ -organization (optional)   | <code>curl "https://bridge-stage.docuteam.ch/changes?token=123456789012345"</code> <code>curl "https://bridge-stage.docuteam.ch/changes
            ?token=123456789012345&id=2"</code> <code>curl "https://bridge-stage.docuteam.ch/changes?token=123456789012345&status=submitted"</code> <code>curl "https://bridge-stage.docuteam.ch/changes            ?token=123456789012345&id=2"</code> <code>curl "https://bridge-stage.docuteam.ch/changes?token=123456789012345&status=submitted"</code> <code>curl "https://bridge-stage.docuteam.ch/changes
Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki