Returns details of stored files, identified by their fileIDs or refDetails.
The fileIDs parameter is an array of file identifiers each corresponding to a file in the file store.
The refDetails parameter must be an array of at least one object, with each object containing the keys refType and refIdentifier. For example:
[{
"refType": "theType",
"refIdentifier": "theIdentifier"
}]
Request Parameters
| Name | Type | Comments |
|---|---|---|
| fileIDs | Array<UUID> | UUID file identifiers of the files to retrieve details about. Either fileIDs or refDetails must be supplied |
| refDetails | List<Reference> | A list of reference objects. Either fileIDs or refDetails must be supplied |
Example Request
{
"id": "testreq1",
"jsonrpc": "2.0",
"method": "getFileDetails",
"params": {
"fileIDs": [
"f618b936-572f-44f1-a300-9944b5b3e2c6"
]
}
}
Example Response
{
"f618b936-572f-44f1-a300-9944b5b3e2c6": {
"success": true,
"fileDetails": {
"id": "f618b936-572f-44f1-a300-9944b5b3e2c6",
"references": [],
"createdBy": null,
"created": "2016-02-22T17:01Z",
"hash": "ba44f7f8f88543fbf91f9b9eb0217cfe",
"lastUpdatedBy": null,
"lastUpdated": "2016-02-22T17:01Z",
"filename": "pusheen.png",
"type": "image/png",
"size": 37029
}
}
}
Share this page
