Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get share details

GET /shares/{id}

Returns the details about a specific share.

NOTE: Only Oneprovider API supports creating / deleting shares and is preferred for all share operations. Onezone API is limited to retrieving and modifying share details.

This operation requires space_view privilege in space where share is created or oz_shares_view admin privilege.

Example cURL requests

Get share details

curl -u admin:password -X GET \
https://$HOST/api/v3/onezone/shares/$SHARE_ID

{
  "shareId": "1f4b762b1380946e73aeca574c77f14c",
  "name": "Experiment XYZ",
  "description": "# Experiment XYZ\nThis collection contains results from Experiment XYZ.",
  "publicUrl": "https://onedata.org/shares/1f4b762b1380946e73aeca574c77f14c",
  "fileType": "dir",
  "rootFileId": "00000000006CB663736861726547756964233339643236366165646365\
  6266666164353939663761373734313235363166342336656331613534313362366634653\
  2623031613563383561386664373937653223316634623736326231333830393436653733\
  6165636135373463373766313463",
  "spaceId": "6ec1a5413b6f4e2b01a5c85a8fd797e2",
  "handleId" "70570c0ebcd081835ca29560708fd98f",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

Path parameters

Parameter	Type & Description
id required	string Share Id.

Request Examples

Shell

onezone-rest-cli getShare id=303884afb761d91a7362b2841647bc08

Responses

application/json

200

Information about a share.

Property Type & Description

shareId

string

Share Id.

name

string

The name of the share.

description

string

Description of the share contents, interpreted as markdown format when displayed in GUI.

publicUrl

string

The publicly accessible URL for the share.

spaceId

string

The Id of the space in which the share was created.

rootFileId

string

Public Id of shared file or directory, allowing read access to its contents without authentication.

fileType

string

Denotes the type of the shared element (file or directory)

Enum:

filedir

handleId

string

The Id of open data Handle (e.g. DOI or PID) assigned to this share or null.

creator

object (Subject)

Object representing a subject in the system, can be perceived as client (actor) identity.

type string Type of the subject Enum: nobodyuseroneprovider
id string Id of the subject (`null` for nobody)

creationTime

integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json

{
  "shareId": "1f4b762b1380946e73aeca574c77f14c",
  "name": "Experiment XYZ",
  "description": "# Experiment XYZ\\nThis collection contains results from Experiment XYZ.",
  "publicUrl": "https://onedata.org/shares/1f4b762b1380946e73aeca574c77f14c",
  "spaceId": "6ec1a5413b6f4e2b01a5c85a8fd797e2",
  "fileType": "dir",
  "rootFileId": "00000000006CB663736861726547756964233339643236366165646365\\ 6266666164353939663761373734313235363166342336656331613534313362366634653\\ 2623031613563383561386664373937653223316634623736326231333830393436653733\\ 6165636135373463373766313463",
  "handleId": "70570c0ebcd081835ca29560708fd98f260fb4da",
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "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."
  }
}