Gets file information
- 23 May 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Gets file information
- Updated on 23 May 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/v2/Drive/Folders/{folderId}/{fileId}
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Path parameters
folderId
stringRequired
The ID of drive folder
fileId
stringRequired
The ID of file
Query parameters
appendSASToken
boolean
Set this to false to exclude appending SAS token for images/files
Default"False"
Responses
200
Success
Success status response
Here, you can verify the file’s information.
{
"data": {
"id": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"file_name": "New-Image",
"file_type": "Other",
"file_url": "https://file.example.com/new-image.jpg",
"updated_on": "2024-05-23T02:28:57Z",
"updated_by": "d79c041c-0f94-4b04-a8b6-a14bb1995eca",
"size": "235",
"height": null,
"width": null,
"parent_folder_id": null,
"title": "Document",
"alternative_text": null,
"tags": [
{
"id": "d8b65d24-ce62-407a-8463-846efc8eee93",
"tag_name": "new-tag"
}
],
"thumbnail_url": "https://file.example.com/New-thumbnail-url",
"is_starred": true
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}object
data
object (MediaFileAndTagsMetaDataCustomer)
id
string
The file ID
Min length1
file_name
string | null
The file name
file_type
string | null
The file type
file_url
string | null
The file URL
updated_on
string (date-time)
The date the file was uploaded
updated_by
string | null
The ID of user who uploaded the file
size
string | null
The file size
height
string | null
The file height
width
string | null
The file width
parent_folder_id
string | null
The parent folder ID
title
string | null
The file title
alternative_text
string | null
The file alternative text
tags
Array of object (TagsMetaDataCustomer) | null
The tags associated with the file
object
id
string | null
The tag ID
tag_name
string | null
The tag name
thumbnail_url
string | null
The thumbnail URL
is_starred
boolean
This denotes the file is starred or not
extension_data
object (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
description
string | null
status description for customer Api response information
400
Bad Request
Bad Response
Kindly verify the given file is valid and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [],
"warnings": [],
"information": []
}object
extension_data
object (ExtensionDataObject)
success
boolean
Status indication for customer API response
errors
Array of object (BaseError) | null
Errors in the customer API response
object
extension_data
object (ExtensionDataObject)
stack_trace
string | null
Stack trace for error response message
description
string | null
Description for error cause
error_code
string | null
Error code for Api response
custom_data
object | null
warnings
Array of object (BaseWarning) | null
Warnings in the customer API response
object
extension_data
object (ExtensionDataObject)
description
string | null
Warning description
warning_code
string | null
warning code for customer Api base response
information
Array of object (BaseInformation) | null
Information passed by the customer API response
object
extension_data
object (ExtensionDataObject)
description
string | null
status description for customer Api response information
Was this article helpful?
