Getting SharePoint Documents
Returns a resource representation of a SharePoint document with a specified ID.
Request
GET https://<hostname>:4443/v5/RestoreSessions/{restoreSessionId}/Organization/Sites/{siteId}/Documents/{documentId} |
Request Headers
The request header must contain an authorization token of the current session.
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
---|---|
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
Property | Type | Description |
---|---|---|
Id | string | Specifies the ID of the backed-up SharePoint document. |
Parent | object | Specifies _links for the parent object. |
Version | int | Specifies the version of the document. |
SizeBytes | int | Specifies the size of the document. |
CreatedBy | string | Specifies the user, which created the document. |
CreationTime | UTC | Specifies date and time when the document was created. |
ModifiedBy | string | Specifies the user, which performed the last modifications to the document. |
ModificationTime | UTC | Specifies date and time when the document was modified. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The following request returns an entity representation of the organization's SharePoint document with a specified ID.
Request: GET https://abc.tech.local:4443/v5/RestoreSessions/0ba45909-ce2d-4457-9a41-c466c21cd1e3/Organization/Sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/Documents/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd057248d332e5-c3f9-4373-9902-beac5510d46a
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "version": "2.0", "id": "1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd057248d332e5-c3f9-4373-9902-beac5510d46a", "name": "request.txt", "createdBy": "System Account", "creationTime": "2017-04-16T12:35:18", "modifiedBy": "System Account", "modificationTime": "2017-04-16T12:37:10", "_links": { "self": { "href": "https://support.north.local:4443/v5/restoresessions/0ba45909-ce2d-4457-9a41-c466c21cd1e3/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/documents/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd057248d332e5-c3f9-4373-9902-beac5510d46a" }, "library": { "href": "https://support.north.local:4443/v5/restoresessions/0ba45909-ce2d-4457-9a41-c466c21cd1e3/organization/sites/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88dd/libraries/1cfe4469-0a31-414b-9fd0-e84a087dcb739f242172-6d3f-47a2-816a-4989d45e88ddd91646d1-5b4a-468f-8d38-7c2eb3cd0572" } } } |