fileFormat

Get all file formats

Securityapi_key
Request
query Parameters
page_number
integer <int64>
Default: 1

The page number for which to get file formats. This will default to the first page if excluded

page_size
integer <int64>

The maximum number of objects to return. This will default to the DefaultApiPageSize setting property if not provided

Responses
200

Success

403

Forbidden access

get/file-formats
Response samples
application/json
{
  • "_pageInfo": {
    },
  • "responseList": [
    ]
}

Create file format

WARNING: The generated curl command is incorrect, so please refer to the Masking API guide for instructions on how to upload files through the API

Securityapi_key
Request
Request Body schema: multipart/form-data
required
fileFormatName
string <= 100 characters

The name of the fileformat to be uploaded, if not provided, the name of the uploaded file will be used.

fileFormat
required
string <binary>

The file format to be uploaded. The logical name of the file format will be exactly the name of this uploaded file

fileFormatType
required
string

The type of the file format being uploaded

Enum: "DELIMITED" "FIXED_WIDTH" "XML" "JSON" "PARQUET"
Responses
201

Success

403

Forbidden access

409

Conflict

post/file-formats
Response samples
application/json
{
  • "fileFormatId": "3",
  • "fileFormatName": "DelimitedFileFormat.txt",
  • "fileFormatType": "DELIMITED",
  • "header": 2,
  • "footer": 1
}

Get file format by ID

Securityapi_key
Request
path Parameters
fileFormatId
required
integer <int32>

The ID of the file format to get

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

get/file-formats/{fileFormatId}
Response samples
application/json
{
  • "fileFormatId": "3",
  • "fileFormatName": "DelimitedFileFormat.txt",
  • "fileFormatType": "DELIMITED",
  • "header": 2,
  • "footer": 1
}

Update file format

Securityapi_key
Request
path Parameters
fileFormatId
required
integer <int32>

The ID of the file format to update

Request Body schema: application/json
required

The updated file format

header
integer <int32>

The number of lines at the beginning of the file to skip.

footer
integer <int32>

The number of lines at the end of the file to skip.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

put/file-formats/{fileFormatId}
Request samples
application/json
{
  • "fileFormatId": "3",
  • "fileFormatName": "DelimitedFileFormat.txt",
  • "fileFormatType": "DELIMITED",
  • "header": 2,
  • "footer": 1
}
Response samples
application/json
{
  • "fileFormatId": "3",
  • "fileFormatName": "DelimitedFileFormat.txt",
  • "fileFormatType": "DELIMITED",
  • "header": 2,
  • "footer": 1
}

Delete file format by ID

Securityapi_key
Request
path Parameters
fileFormatId
required
integer <int32>

The ID of the file format to delete

Responses
200

Success

400

Bad request

403

Forbidden access

404

Not found

delete/file-formats/{fileFormatId}

Copy file format by ID

Securityapi_key
Request
path Parameters
fileFormatId
required
integer <int32>

The ID of the file format to duplicate

Request Body schema: application/json
required

The name for the new file format copy

fileFormatName
required
string <= 100 characters

The name of the new file format.

ignoreMaskingAssignments
boolean
Default: false

Flag to ignore copying masking assignments. If true, masking assignments will not be copied.

Responses
201

Success

400

Bad request

403

Forbidden access

404

Not found

put/file-formats/{fileFormatId}/copy
Request samples
application/json
{
  • "fileFormatName": "",
  • "ignoreMaskingAssignments": "false"
}
Response samples
application/json
{
  • "fileFormatId": "3",
  • "fileFormatName": "DelimitedFileFormat.txt",
  • "fileFormatType": "DELIMITED",
  • "header": 2,
  • "footer": 1
}

Export File Format using File Format ID

Returns a fileDownloadId for the given fileFormatId and (optional) recordTypeId.

Securityapi_key
Request
query Parameters
fileFormatId
required
integer <int32>

File format ID

recordTypeId
integer <int32>

Record type ID

Responses
200

Success

400

Invalid request

404

File format not found

post/file-formats/export
Response samples
application/json
{
  • "fileFormatId": "3",
  • "fileFormatName": "DelimitedFileFormat.txt",
  • "fileFormatType": "DELIMITED",
  • "header": 2,
  • "footer": 1
}
➔ Next to fileMetadata