Skip to content
Cloud APIs
/
/
/File Service

File Service

The File Service allows users to manage files on the data platform. File Management includes uploads, downloads, creation and retrieval of metadata record for files.

Operations

Get a location in Landing Zone to upload a file.

Request

Gets a temporary signed URL to upload a file (Service does not upload the file by itself, User needs to use this URL to upload the file). The generated URL is time bound and by default expires by 7 days maximum.

User will receive a FileSource in the response.This is the relative path where the uploaded file will persist. Once the file is uploaded, FileSource can then be used to post metadata of the file.

Required roles: 'service.file.editors'. Users added to groups 'users.datalake.editors', 'users.datalake.admins', 'users.datalake.ops' would be added to group 'service.file.editors' by default.

Security
bearer
Headers
data-partition-idstringrequired

desired data partition id.

curl -i -X GET \
  https://as5.api.enterprisedata.slb.com/api/file/v2/files/uploadURL \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'data-partition-id: string'

Responses

Created location

Bodyapplication/json
FileIDstring(FileID)^[\w,\s-]+(\.\w+)?$

Unique Identifier for the file

Locationobject
Response
{
  "FileID": "string",
  "Location": {
    "SignedURL": "GCS signed URL",
    "FileSource": "AXB564XVCY\\SHVCU7632"
  }
}