V2.1 Get File¶
Get the information of a file.
This API is available in EnOS 2.3.0 CU3 and above.
If you need to invoke this API after performing bulk updates to relevant files using other APIs, it is recommended to wait for about 2 seconds to avoid obtaining unupdated data.
Operation Permissions¶
Before invoking this API, ensure that the service account has been authorized the policy that includes the following service(s) and action permission(s). For how to authorize the service account, see Managing Service Accounts.
Required Service |
Required Operation Permission |
---|---|
Asset |
Read |
Request Format¶
GET https://{integration-address}/connect-service/v2.1/files?action=getFileInfo
Note
{integration-address}: The gateway address of message integration service. Log in to the EnOS Management Console and find it in Help > Environment Information.
Request Parameters (URI)¶
Note
Use one of the following methods to specify the asset:
Include
assetId
in the requestInclude
productKey
+deviceKey
in the request
Name |
Location (Path/Query) |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|---|
orgId |
Query |
Mandatory |
String |
The organization ID which the asset belongs to. How to get orgId>> |
fileUri |
Query |
Mandatory |
String |
The URI of the file. Format: |
category |
Query |
Mandatory |
String |
The type of the file to be downloaded. The value |
assetId |
Query |
Optional (See Note above) |
String |
The asset ID. How to get assetID>> |
productKey |
Query |
Optional (See Note above) |
String |
The product key. To be used with |
deviceKey |
Query |
Optional (See Note above) |
String |
The device key. To be used with |
Request Parameters (Header)¶
Name |
Mandatory/Optional |
Data Type |
Description |
---|---|---|---|
apim-accesstoken |
Mandatory |
String |
The access token obtained via token authentication. For more information, see Get Access Token |
Response Parameters¶
Name |
Data Type |
Description |
---|---|---|
data |
FileMetaDto Struct |
The file metadata information. For more information, see FileMetaDto Struct |
FileMetaDto Struct ¶
Name |
Data Type |
Description |
---|---|---|
orgId |
String |
The organization ID which the asset belongs to. |
category |
String |
The type of the file to be downloaded. |
fileUri |
String |
The URI of the file. |
originalFilename |
String |
The file name. |
fileSize |
Integer |
The file size. |
md5 |
String |
The MD5 of the file. |
signMethod |
String |
The signature algorithm for the file. |
sign |
String |
The file signature. |
createTime |
Long |
The time when the file is created. |
Samples¶
Request Sample¶
https://{integration-address}/connect-service/v2.1/files?action=getFileInfo&orgId=yourOrgId&fileUri=yourFileUri&category=feature&assetId=yourAssetId
method: GET
requestHeader: {
"apim-accesstoken":"yourAccessToken"
}
Response Sample¶
{
"code": 0,
"msg": "OK",
"requestId": "6a02a5a5-49f0-4df1-b364-496ad2079033",
"data": {
"orgId": "yourOrgId",
"category": "feature",
"fileUri": "yourFileUri",
"originalFilename": "file.txt",
"fileSize": 123,
"md5": "md5value",
"signMethod": "md5",
"sign": "fileSig",
"createTime": 1648694084000
}
}
SDK Samples¶
You can access the SDK samples for Connection Service on GitHub: