FileMetadata

Create a file metadata.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required

The parameters to create a file metadata.

delimiter
required
string [ 1 .. 50 ] characters

The delimiter used for exporting data source to the delimited file.

endOfRecord
required
string [ 1 .. 25 ] characters

The string of characters that delineates the end-of-record for a file. Note that, for linux this is \n, and for windows it is \r\n.

enclosure
string [ 1 .. 5 ] characters

The text enclosure used for exporting data source to the delimited file.

enclosureEscapeCharacter
string or null = 1 characters

The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.

escapeEnclosureEscapeCharacter
boolean
Default: false

This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.

built_in
boolean
Default: false

This flag indicates whether created by customers or internal service. For example, if true, then the file metadata is created by unload service and false for the one created by customer through controller service.

Responses
201

Created

400

Invalid Input provided.

500

Internal Service Unavailable.

post/file-metadata
Request samples
application/json
{
  • "delimiter": ",",
  • "endOfRecord": "\n",
  • "enclosure": "'",
  • "enclosureEscapeCharacter": "'",
  • "escapeEnclosureEscapeCharacter": false,
  • "built_in": false
}
Response samples
application/json
{
  • "delimiter": ",",
  • "endOfRecord": "\n",
  • "enclosure": "'",
  • "enclosureEscapeCharacter": "'",
  • "escapeEnclosureEscapeCharacter": false,
  • "built_in": false
}

Returns a list of file metadata.

SecurityApiKeyAuth
Responses
200

OK

500

Internal Service Unavailable.

get/file-metadata
Response samples
application/json
[
  • {
    }
]

Returns a file metadata by ID.

SecurityApiKeyAuth
Request
path Parameters
fileMetadataId
required
integer <int64> >= 1

Numeric ID of the file metadata.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

get/file-metadata/{fileMetadataId}
Response samples
application/json
{
  • "delimiter": ",",
  • "endOfRecord": "\n",
  • "enclosure": "'",
  • "enclosureEscapeCharacter": "'",
  • "escapeEnclosureEscapeCharacter": false,
  • "built_in": false
}

Update an existing file metadata.

SecurityApiKeyAuth
Request
path Parameters
fileMetadataId
required
integer <int64> >= 1

Numeric ID of the file metadata.

Request Body schema: application/json
required

The updated file metadata information.

delimiter
required
string [ 1 .. 50 ] characters

The delimiter used for exporting data source to the delimited file.

endOfRecord
required
string [ 1 .. 25 ] characters

The string of characters that delineates the end-of-record for a file. Note that, for linux this is \n, and for windows it is \r\n.

enclosure
string [ 1 .. 5 ] characters

The text enclosure used for exporting data source to the delimited file.

enclosureEscapeCharacter
string or null = 1 characters

The character used to escape a literal enclosure character within an enclosed value. By default, this is equal to the enclosure value itself, so doubling the enclosure character escape it.

escapeEnclosureEscapeCharacter
boolean
Default: false

This flag indicates whether the enclosure escape character also escapes itself. For example, if the enclosure escape character is *, then the sequence ** would be treated as a single * character, rather than an escape.

built_in
boolean
Default: false

This flag indicates whether created by customers or internal service. For example, if true, then the file metadata is created by unload service and false for the one created by customer through controller service.

Responses
200

OK

400

Invalid Input provided.

404

Object Not Found.

500

Internal Service Unavailable.

put/file-metadata/{fileMetadataId}
Request samples
application/json
{
  • "delimiter": ",",
  • "endOfRecord": "\n",
  • "enclosure": "'",
  • "enclosureEscapeCharacter": "'",
  • "escapeEnclosureEscapeCharacter": false,
  • "built_in": false
}
Response samples
application/json
{
  • "delimiter": ",",
  • "endOfRecord": "\n",
  • "enclosure": "'",
  • "enclosureEscapeCharacter": "'",
  • "escapeEnclosureEscapeCharacter": false,
  • "built_in": false
}

Delete an existing file metadata.

SecurityApiKeyAuth
Request
path Parameters
fileMetadataId
required
integer <int64> >= 1

Numeric ID of the file metadata.

Responses
200

OK

404

Object Not Found.

500

Internal Service Unavailable.

delete/file-metadata/{fileMetadataId}
➔ Next to StructuredDataFormat