Articles in this section

File definitions API endpoints

download.svg​​ Download Postman collection

file definition refers to the specifications and structure for reading or writing files used in integrations. These file definitions outline the format, fields, and data types expected in files (such as CSV, JSON, or XML) when transferring data between systems. The file definition helps to ensure that the data being imported or exported is consistent and can be mapped correctly to target fields in an integration flow.

Relative URI

Method

Success code

Description

/filedefinitions

GET

200

Get all file definitions.

POST

201

Create a file definition.

/filedefinitions/<_id>

GET

200

Get the list of file definition metadata.

PUT

200

Update a specific file definition.

DELETE

204

Delete a specific file definition.