Get a single share


Get a single share identified by shareId.

Endpoint URL: {service.share.url} received in EndpointFetching

Request Syntax

GET /v1/shares/{shareId}


Request Headers

ParameterDescriptionRequired
AuthorizationThe authorized access token in the format "Bearer bb23e25a-f51d-44b6-b8d9-a669e5d4c01e". If the share retrieved is not public then the user must be a valid user.

Value of type: string
true
correlationIDUsed for logging/analytics tracking.

Value of type: string
false


Request Path Parameters

ParameterDescriptionRequired
shareIdThe shareId of the share to be retrieved.

Value of type: string
true


200 Response

Success

Response Headers

ParameterDescriptionRequired
Access-Control-Allow-OriginIndicates whether the response can be shared with resources with the given origin.

Value of type: string
false


Response Payload

ParameterDescriptionRequired
dataObject of type: GetShareResponsefalse
errorA successful response will return a 200 HTTP status code with null in error response.

An unsuccessful response will return a 4xx HTTP status code. An example of an unsuccessful request would be when a share could not be found and you would get the following response body in addition to a 404 HTTP status code.

{"data": null,"error": {"label": "SHARE_NOT_FOUND","message": "404 Not Found Could not find share",}}

Possible HTTP response codes, error labels, and messages:

* 400, `GENERAL_INSUFFICIENT_PARAMETERS`, "400 Bad Request Required parameter _{parameter name}_ not present, invalid or empty"

Value of type: object

false
messageDescription

Value of type: string
false


Example

Sample request to get a share identified by shareId.

Request

GET shares/v1/shares/{shareId} HTTP/1.1Host: Endpoint-URLAuthorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUContent-Type: application/json

Response

HTTP/1.1 200 OK{  "data": {    "lastModified": 1476834055308,    "deviceId": "12345",    "shareId": "12345",    "fileIds": [      "357",      "579"    ],    "authId": "123456789",    "useCache": true,    "cacheUrl": "https://cache.mycloud.com/cache",    "url": "https://mycloud.com/#/action/share/12345",    "ownerId": "123",    "shareToken":"ZJNh2jOeofrUvpUxtXPxHUToXF4rExJ4ylttj4-EeWCUwsPMSAPvX8ZbS8bUpyp8-3n3a5C6lKY01ac2FyVC0Of7cvnJqM6XhG_tTinFCcB3WnfBteA8SIKTTc6gbrfbz4TvbIUMw-RFttly9qtnVdApDmaO4inIBESCmNBaDFFgaR5xzePXkjcEE-uGkDQ9snq7L1RUKisdCZENm6OcFlnNXfeG6TLxC1-rP7fbkkjERFk9QAAEsMwjPA6Q_W1NDK_7CgLgqFk426aUJhaQ",    "dateCreated": 1476834055308,    "device": {}  },  "error": null}