How to Map Files in Request

While uploading data to Timeline, it is important for a file to have a specific structure. The file must have three mandatory columns, related to Timeline ID, Timestamp, and Event name and can include any number of optional columns. All columns can have arbitrary names, as no naming rules are imposed.

Data structure sample

TimelineID Timestamp Event name Employee Location Comment
N008 1/16/2017 7:20:15 Ticket Registered John Smith Charlotte Insurance claims
N123 4/10/2017 10:33:58 Ticket Closed Anna Brown Boston Refund

One of the requirements to upload files from temporary storage to the project is to provide correct mapping in the request body. You must map at least three mandatory fields and any number of optional columns. Include the corresponding block in the request body, where you specify column names from the file and their type. For the data sample above, mapping mandatory fields looks as follows:

"mapping": {
        "event_id": {
          "title": "Event name",
          "type": "String"
        },
        "timeline_id": {
          "title": "TimelineID",
          "type": "String"
        },
        "timestamp": {
          "title": "Timestamp",
          "type": "Date"
        }
    

Add attributes to the mapping to upload them into the project as a part of timelines. Specify attribute column names from the file and their type. For the data sample above, mapping attributes looks as follows:

"attributes": [
          {
            "title": "Employee",
            "type": "String"
          },
          {
            "title": "Location",
            "type": "Number"
          },
          {
            "title": "Comment",
            "type": "Number"
          }
        ]
    

Important. In case you upload several files to the project, make sure that files have the same structure. They must contain all mapped columns, have the same column names and types for mandatory and optional fields.

For more details on the file structure and what is the mapping process, see Data Requirements and Mapping.

22.02.2024 17:28:05

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.