Multibox box manager API
Multibox box life cycle RPC methods
Multibox API is accessible on the box manager URL. Please use an external REST client to access your Multibox server.
List FHIR versions supported by the server. One of these values must be used in
multibox/create-box
.Create a new box for the current user.
Parameters
Response
Errors
id
(required): id of the box to create. Must match/[a-z][a-z0-9]{4,}/
fhirVersion
(required): FHIR version. Value must be from themultibox/versions
response.description
: description of the box to create.env
: object with environment variables inlower-kebab-case
(not inUPPER_SNAKE_CASE
).
description
- box description
meta
- meta info about the box resource
fhirVersion
box-url
access-url
- link to get admin access
participant
- collection of user resources
resourceType
env
- object with environment variables in lower-kebab-case (not in UPPER_SNAKE_CASE)
access-token
id
message
- "Can not create box"
message
- "Box already exists"
message
- FHIR OperationOutcome
List boxes available for the current user.
Parameters
Response
Error
Expects no parameters
Collection of objects with the following structure:
id
- box idcluster
fhirVersion
- fhir versionmessage -
"No user session"Get box information.
Parameters
Response
Error
id
(required): id of the boxdescription
- box description
meta
- meta info about the box resource
fhirVersion
box-url
access-url
- link to get admin access
participant
- collection of user resources
resourceType
env
- object with environment variables in lower-kebab-case (not in UPPER_SNAKE_CASE)
access-token
id
message
- "You do not have access to this box"
message
- "No box with id - "
message
- "No user session"This operation will drop the box database. Can not be undone!
Delete a box
Parameters
Response
Error
id
(required): id of the boxdescription
- box description
meta
- meta info about the box resource
fhirVersion
box-url
access-url
- link to get admin access
participant
- collection of user resources
resourceType
env
- object with environment variables in lower-kebab-case (not in UPPER_SNAKE_CASE)
access-token
id
message
- "Only owner can delete box."
message
- "Cannot delete box: \n <details>"
message
- FHIR OperationOutcome
Drop cache in every box
Parameters
Response
expects no parameters.
String: "ok".
Last modified 8mo ago