Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get space details in the Marketplace

GET /spaces/marketplace/{id}

Returns the Marketplace related details about a specific space.

This operation can be performed by any user, but only for spaces advertised in the Marketplace.

Example cURL requests

Get space details in the Marketplace

curl -H "x-auth-token: $TOKEN" -H \
https://$ZONE_HOST/api/v3/onezone/spaces/marketplace/$SPACE_ID

{
  "name": "Meteo dataset",
  "index": "Meteo dataset@2c0160248ba9a66f45da751ca459535a",
  "description": "This dataset contains meteorological data for major Polish cities in years 2012-2014.",
  "organizationName": "ACK Cyfronet AGH",
  "tags": ["archival", "big-data", "open-data", "environment"],
  "providerNames": ["krakow", "paris"],
  "totalSupportSize": 30500000000,
  "creationTime": 1576152793
}

Path parameters

Parameter	Type & Description
id required	string Space Id.

Request Examples

Shell

onezone-rest-cli getSpaceDataInMarketplace id=b752ceafabb662b4e5728b2ded25cdd1

Responses

application/json

200

Marketplace related details about a space.

Property	Type & Description
spaceId string Unique Id of the space.
name string The name of the space.
index string Indicates the position of this space in the Marketplace list (can be used to specify a custom listing starting point).
description string (SpaceDescription) Space description in markdown (.md) format.
organizationName string (SpaceOrganizationName) Name of the organization responsible for space management.
tags array of strings A list of short keywords or phrases that helps to understand the purpose of a space. Available space tags can be retrieved from the configuration endpoint.
providerNames array of strings Names of providers supporting this space.
totalSupportSize integer Sum of granted support sizes.
creationTime integer (Timestamp) Timestamp in seconds (UNIX epoch), e.g. `1563819329`.

Example

application/json

{
  "spaceId": "2c0160248ba9a66f45da751ca459535a",
  "name": "Meteo dataset",
  "index": "Meteo dataset@2c0160248ba9a66f45da751ca459535a",
  "description": "This dataset contains meteorological data for major Polish cities in years 2012-2014.",
  "organizationName": "ACK Cyfronet AGH",
  "tags": [
    "archival",
    "big-data",
    "open-data",
    "environment"
  ],
  "providerNames": [
    "krakow",
    "paris"
  ],
  "totalSupportSize": 30500000000,
  "creationTime": 1576152793
}

400

Invalid request.

Property

Type & 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.

Property

Type & 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.

Property

Type & 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.

Property

Type & 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.

Property

Type & 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."
  }
}