Data Exchange Service – 示例
以下示例说明了如何使用提供的端点:
指定资源的可见性,请参见 Data Exchange Service 可见性空间。
在租户根空间中上传文件
租户根空间是包含租户内所有用户均可访问的文件和文件夹的根组。
请求:
POST /api/dataexchange/v3/files
X-XSRF-TOKEN:b73deb0d-feb2-4183-b4c6-a96abe62a44d
表格数据:
metadata :{"name": "custom_file_name.txt", "parentId":"_PUBLIC_ROOT_ID", "type":"CSV"}
file : <file_content_byte_array>
响应:
{
"resourceId":"327e0baa-f5ba-4d24-af11-8d85de8007e9",
"name": "custom_file_name.txt",
"parentId":"_PUBLIC_ROOT_ID",
"type":"CSV",
"sizeInBytes":8584808,
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
在用户根空间中上传文件
用户根空间是包含仅供租户中的特定用户访问的文件和文件夹的根组。
请求:
POST /api/dataexchange/v3/files
X-XSRF-TOKEN:b73deb0d-feb2-4183-b4c6-a96abe62a44d
表格数据:
metadata :{"name": "custom_file_name.txt", "parentId":"_PRIVATE_ROOT_ID", "type":"CSV"}
file : <file_content_byte_array>
响应:
{
"resourceId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"name": "custom_file_name.txt",
"parentId":"_PRIVATE_ROOT_ID",
"type":"CSV",
"sizeInBytes":8584808,
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
在租户根空间中创建目录
租户根空间是包含租户内所有用户均可访问的文件和文件夹的根组。
请求:
POST /api/dataexchange/v3/directories
X-XSRF-TOKEN:cade03ca-370c-49fd-9acd-b879368263d6
metadata :{"name": "public_directory", "parentId":"_PUBLIC_ROOT_ID"}
响应:
{
"resourceId":"1821dcbb-13c2-4112-b4c3-0cbb799dce54",
"name": "public_directory",
"parentId":"_PUBLIC_ROOT_ID",
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
在用户根空间中创建目录
用户根空间是包含仅供租户中的特定用户访问的文件和文件夹的根组。
请求:
POST /api/dataexchange/v3/directories
X-XSRF-TOKEN:cade03ca-370c-49fd-9acd-b879368263d6
metadata :{"name": "private_directory", "parentId":"_PRIVATE_ROOT_ID"}
响应:
{
"resourceId":"1821dcb1-13c2-4112-b4c3-0cbb799dce54",
"name": "private_directory",
"parentId":"_PRIVATE_ROOT_ID",
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
删除文件
请求:
DELETE /api/dataexchange/v3/files/327e0baa-f5b1-4df4-af11-8d85de8007e9 HTTP/1.1
X-XSRF-TOKEN:b73deb0d-feb2-4183-b4c6-a96abe62a44d
删除目录
请求:
DELETE /api/dataexchange/v3/directories/1821dcbb-13c2-4112-b4c3-0cbb799dce54 HTTP/1.1
X-XSRF-TOKEN:b73deb0d-feb2-4183-b4c6-a96abe62a44d
列出目录内容
请求:
```http tab="private root directory" GET /api/dataexchange/v3/directories/_PRIVATE_ROOT_ID
```http tab="public root directory"
GET /api/dataexchange/v3/directories/_PUBLIC_ROOT_ID
```http tab="other directories" GET /api/dataexchange/v3/directories/1821dcbb-13c2-4112-b4c3-0cbb799dce54
响应:
```json
{
"files": [
{
"id": "f6214934-6f2f-416f-87e1-1fee5c31d91b",
"parentId":"1821dcbb-13c2-4112-b4c3-0cbb799dce54",
"name": "some_file.txt",
"type":"TXT",
"modifiedBy": "a_user@siemens.com",
"sizeInBytes":8584808,
"lastModified":"2018-07-12T13:07:26.966"
},
{
"id": "c8a849e2-801c-47f0-b648-4efb41101b78",
"parentId":"1821dcbb-13c2-4112-b4c3-0cbb799dce54",
"name": "another_file.csv",
"type":"CSV",
"modifiedBy": "some.name@siemens.com",
"sizeInBytes":563433,
"lastModified":"2018-07-09T13:53:36.213"
}
],
"directories": [
{
"id":"17ee9f30-501c-4efa-bdcd-8bbf52d87941",
"parentId":"1821dcbb-13c2-4112-b4c3-0cbb799dce54",
"name": "dir1",
"modifiedBy": "some.name@siemens.com"
},
{
"id":"1891dcbb-13c2-4111-b4c3-0cbb799dce54",
"parentId":"1821dcbb-13c2-4112-b4c3-0cbb799dce54",
"name": "dir2",
"modifiedBy": "a_user@siemens.com"
}
]
}
说明
parentId
字段接受 _PUBLIC_ROOT_ID
或 _PRIVATE_ROOT_ID
的值,或者需要执行列表操作的资源 ID
检索目录属性
请求:
GET /api/dataexchange/v3/directories/327e0baa-f5b1-4df4-af11-8d85de8007e9
响应:
{
"resourceId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"name": "public_dir.txt",
"parentId":"_PUBLIC_ROOT_ID",
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
检索文件属性
请求:
GET /api/dataexchange/v3/files/327e0baa-f5b1-4df4-af11-8d85de8007e9/properties
响应:
{
"resourceId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"name": "custom_file_name.txt",
"parentId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"type":"CSV",
"sizeInBytes":8584808,
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
下载文件
请求:
GET /api/dataexchange/v3/files/327e0baa-f5b1-4df4-af11-8d85de8007e9
Content-Type:application/json
Accept:application/octet-stream
响应:
<file_byte_array>
更新/替换文件内容
请求:
GET /api/dataexchange/v3/files/327e0baa-f5b1-4df4-af11-8d85de8007e9
X-XSRF-TOKEN:b73deb0d-feb2-4183-b4c6-a96abe62a44d
Accept:application/octet-stream
表格数据:
file: <file_byte_array>
响应:
{
"resourceId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"name": "custom_file_name.txt",
"parentId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"type":"CSV",
"sizeInBytes":8584808,
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
重命名/移动/更新文件的类型或可见性
如果文件的可见性为公有,则该文件对租户中的所有用户均可见。可执行以下操将文件设为公有:
- 将其放入 _PUBLIC_ROOT_ID
- 将其置于公有目录中
类似地,您也可以使用私有文件夹将文件设为私有。
请求:
PATCH /api/dataexchange/v3/files/327e0baa-f5b1-4df4-af11-8d85de8007e9
X-XSRF-TOKEN:b73deb0d-feb2-4183-b4c6-a96abe62a44d
Accept:application/octet-stream
主体:
{"name": "renamed_filename.txt", "parentId":"_PUBLIC_ROOT_ID", "type":"Parquet"}
响应:
{
"resourceId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"name": "custom_file_name.txt",
"parentId":"_PUBLIC_ROOT_ID",
"type":"Parquet",
"sizeInBytes":8584808,
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
重命名/移动/更新目录的可见性
如果目录的可见性为公有,则该文件对租户中的所有用户均可见。可执行以下操将目录设为公有:
- 将其放入 _PUBLIC_ROOT_ID
- 将其置于公有目录中
类似地,您也可以使用私有文件夹将目录设为私有。
请求:
PATCH /api/dataexchange/v3/directories/327e0baa-f5b1-4df4-af11-8d85de8007e9
X-XSRF-TOKEN:b73deb0d-feb2-4183-b4c6-a96abe62a44d
Accept:application/octet-stream
主体:
{"name": "renamed_directory", "parentId":"_PUBLIC_ROOT_ID"}
响应:
{
"resourceId":"327e0baa-f5b1-4df4-af11-8d85de8007e9",
"name": "renamed_directory",
"parentId":"_PUBLIC_ROOT_ID",
"modifiedDate":"2018-07-12T13:11:29.180",
"modifiedBy": "a_user@siemens.com"
}
还有问题?
除非另行声明,该网站内容遵循MindSphere开发许可协议.
Last update: July 11, 2019