Skip to content
Cloud APIs
/
/
/
OSDU AbstractFileSourceIn...

OSDU AbstractFileSourceInfo

Namestring

user-friendly file name. if provided then the user can download file with the same name and content type using downloadURL API.

PreLoadFilePathstring

File system path to the data file as it existed before loading to the data platform

FileSourcestringrequired

Relative file path for the data in the file

PreloadFileCreateUserstring

Optional user name or reference, who created the file prior to up-loading to the platform.

PreloadFileCreateDatestring

Optional create date and time of the file prior to uploading to the platform.

PreloadFileModifyUserstring

Optional user name or reference, who last modified the file prior to up-loading to the platform.

PreloadFileModifyDatestring

Optional last modified date and time of the file prior to up-loading to the platform.

FileSizestring

Length of file in bytes. Implemented as string. The value must be convertible to a long integer (sizes can become very large).

EncodingFormatTypeIDstring^srn:<namespace>:reference-data\\/EncodingFor...

Encoding Format Type ID

Checksumstring^([0-9a-fA-F]{2})+$

Checksum of file bytes - a hexadecimal number with even number of bytes.

ChecksumAlgorithmstring

The name of the checksum algorithm e.g. MD5, SHA-256.

{
  "Name": "string",
  "PreLoadFilePath": "string",
  "FileSource": "string",
  "PreloadFileCreateUser": "string",
  "PreloadFileCreateDate": "string",
  "PreloadFileModifyUser": "string",
  "PreloadFileModifyDate": "string",
  "FileSize": "string",
  "EncodingFormatTypeID": "string",
  "Checksum": "string",
  "ChecksumAlgorithm": "string"
}