Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
irods-microservices
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Package registry
Model registry
Operate
Terraform modules
Analyze
Contributor analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
RDM Infrastructure
irods-microservices
Commits
a3ebfab6
Commit
a3ebfab6
authored
3 years ago
by
Staiger, Christine
Browse files
Options
Downloads
Patches
Plain Diff
Updating the doc/api
parent
056e89c4
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
doc/api.md
+40
-0
40 additions, 0 deletions
doc/api.md
with
40 additions
and
0 deletions
doc/api.md
+
40
−
0
View file @
a3ebfab6
# 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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment