Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Request space membership via Marketplace

POST /spaces/marketplace/{id}/request

Request space membership for a space advertised in the Marketplace as currently authenticated user.

This operation can be invoked on behalf of the current user only.

Example cURL requests

Request space membership via Marketplace

curl -u admin:password -H "Content-type: application/json" -X POST \
-d '{ "contactEmail" : "user@example.com"}' \
https://$ZONE_HOST/api/v3/onezone/spaces/marketplace/$SPACE_ID/request

Path parameters

Parameter Type & Description
id required
string

Space Id.

Request body

application/json

Space membership request body.

PropertyType & Description
contactEmail required
string

Requester email address, which will be passed to the space maintainer for the purpose of processing the request and used for notifying about their decision. By providing the address, the user agrees to the above.

message
string

A message to the maintainer stating user's motivation to join the space and/or any information that may help in making the decision.

Request Examples

application/json
{
  "contactEmail": "user@example.com"
}

Responses

application/json
200

The request has been delivered and awaits resolution.

PropertyType & Description
requestId
string

Unique Id of the request.

Example

application/json
{
  "requestId": "97216a666edd09945880a0785ad66a7b"
}
400

Invalid request.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
401

Authentication error.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
403

Authorization error.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
404

Resource not found.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}
500

Internal server Error.

PropertyType & Description
error
object

Object describing an error.

id required
string

String identifying the error type. Does not change between error instances.

description required
string

Human readable error description. May contain information specific to given error instance.

details
object

Details about the error instance. The object schema is specific to each error type.

Example

application/json
{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}