File Source Response

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
string

The confidential portion of the Authorization header that follows the type field.

This field is write-only. It is omitted by read operations.

If authorization is required, the credentials value must be provided whenever a File Source is created or modified. An update to a dataset that does not change the File Source may omit the credentials field–the update will preserve the previous value.

3 validations
type
string

The authorization scheme.

Usually this is “Bearer” but it could be other values like “Token” or “Basic” etc.

2 validations + required
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.

password
string

The secret password.

This field is write-only. It is omitted by read operations.

If authorization is required, the password value must be provided whenever a File Source is created or modified. An update to a dataset that does not change the File Source may omit the password field–the update will preserve the previous value.

1 validation
user
string

The name of the account to login to.

1 validation + required
expandArchive
boolean
default: false
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.

id
string
1 validation + required
owner
string

User name of the owner of the OAuth token within data.world.

3 validations + required
site
string
3 validations + required
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.

format: uri