From a3ebfab632fd9c3b0802b144618686c6996b94b1 Mon Sep 17 00:00:00 2001 From: Ubuntu <christine.staiger@wur.nl> Date: Tue, 16 Nov 2021 16:02:20 +0000 Subject: [PATCH] Updating the doc/api --- doc/api.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/doc/api.md b/doc/api.md index b13d784..d7d5a2a 100644 --- a/doc/api.md +++ b/doc/api.md @@ -1,4 +1,5 @@ # Microservice API +## PID microservices - __`msiCreateEpicPID(*uuid, *url, *handle, *http_code)`__ @@ -18,6 +19,16 @@ `*http_code`: output, the HTTP code for the request, normally 200 +- __`msiGetEpicPIDMetadtaa(*handle, *metaName, *metaValue, *http_code)`__ + + `*handle`: the PID handle + + `*metaName`: Metadata key in the handle system + + `*metaValue`: output, Metadata value from the handle system + + `*http_code`: output, the HTTP code for the request, normally 200 + - __`msiDeleteEpicPID(*handle, *http_code)`__ `*handle`: the PID handle to delete @@ -33,3 +44,32 @@ `*value`: the metadata value, always a string `*http_code`: output, the HTTP code for the request, normally 200 + +## Archival package microservices +- __`msiArchiveCreate(*archive_name, *collection, *resource, *out)`__ + + `*archive_name`: name of the archive, suffix determines type of archive (tar, zip, bzip, ...) + + `*collection`: iRODS collection to be archived + + `*resource`: iRODS resource the archive should be placed on + + `*out`: status + +- __`msiArchiveExtract(*archive_name, *destination_collection, *extract, *resource, *out)`__ + + `*archive_name`: name of the archive to be extracted + + `*destination_collection`: iRODS collection where data shall be extracted to + + `*extract`: Partial path as stored in the index of the archive if only one element should be extracted, null otherwise + + `*resource`: iRODS resource the data should be placed on + + `*out`: status + +- __`msiArchiveIndex(*archive_name, *out)`__ + + `*archive_name`: name of the archive + + `*out`: status -- GitLab