Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get share info

GET /shares/{shid}

Returns the basic information about share.

Example cURL requests

Returns the basic information about share

curl -X GET -H "X-Auth-Token: $TOKEN" \
"https://$HOST/api/v3/oneprovider/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" "doi:10.15911/MyShares.726855"
}

Path parameters

Parameter	Type & Description
shid required	string Share Id (e.g. '1f4b762b1380946e73aeca574c77f14c')

Request Examples

Shell

oneprovider-rest-cli getShare shid=$SHARE_ID

Responses

application/json

200

The share information.

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.

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",
  "rootFileId": "00000000006CB663736861726547756964233339643236366165646365\\ 6266666164353939663761373734313235363166342336656331613534313362366634653\\ 2623031613563383561386664373937653223316634623736326231333830393436653733\\ 6165636135373463373766313463",
  "fileType": "dir",
  "handleId": "doi:10.15911/MyShares.726855"
}

400

Invalid request.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

403

Forbidden request.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

404

File or share not found.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}

500

Internal server error.

Property	Type & Description
error string Identifier representing internal error code.
error_description string Detailed error message.

Example

application/json

{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}