File Summary Response

object
created
string

Date and time when file was created.

required
description
string

File description.

labels
array[string]

File labels.

uniqueItems: true
name
string

File name. Should include type extension always when possible. Must not include slashes.

required
sizeInBytes
integer
format: int64
source
object
authorization
object

An authorization type and credentials suitable for use in an HTTP Authorization header.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: <type> <credentials>

The credentials field is write-only. It is omitted by read operations.

credentials
object

A username and password suitable for use with HTTP Basic authentication.

When used with a File Source this causes the HTTP request to include the following header:

Authorization: Basic <base64-encoding-of(user:password)>

The password field is write-only. It is omitted by read operations.

expandArchive
boolean
1 validation
lastSyncFailure
string

Date and time when synchronization last failed.

lastSyncStart
string

Date and time when synchronization last started.

lastSyncSuccess
string

Date and time when synchronization last finished successfully.

method
string
oauthToken
object

A reference to a 3rd-party OAuth 2.0 token stored by data.world.

When creating or updating an OAuth token reference, the token must belong to the user making the update.

requestEntity
string
requestHeaders
object

A map of custom HTTP header name/value pairs to pass with the request.

If a requestEntity string is specified, this must contain a Content-Type header.

syncStatus
string

Synchronization status of the file. This status can be checked periodically after changes are made to the dataset to determine the status of asynchronous syncronization.

  • NEW: Just created. Not yet synchronized.
  • INPROGRESS: Currently being synchronized.
  • LOADED: Successfully synchronized.
  • SYSTEMERROR: Error state due to synchronization failure.
required
syncSummary
string

Human-readable message detailing status of last failed sync.

url
string

Source URL of file. Must be an http, https, or stream URL.

1 validation
updated
string

Date and time when file was last updated.

required