1. API
  2. Records
  3. Record views

Import

Last updated Open markdown version

Description

Import a record view. The import data should be obtained from the export endpoint.

See the List Record Views API to learn more about record views.

Request

HTTP Method: POST

Body parameter Description
team_id ID of the team to which the record view should be added.
data JSON object representing the record view in exported form.
mode Optional Create a new record view or replace an existing one by name (new, replace). Defaults to new.
name Optional Name for the record view. Defaults to the name in the export data. In replace mode, this specifies which existing view to replace.

The data value is the full response body from the Export Record View API, including schema_version. Any record types and story slugs referenced in the export must already exist in the destination team — they are resolved by name and are not created automatically.

curl -X POST \
  https://<tenant-domain>/api/v1/record_views/import \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
    "team_id": 14,
    "name": "Imported view",
    "mode": "new",
    "data": {
      "schema_version": 1,
      "export_type": "record_view",
      "exported_at": "2025-02-10T12:30:45Z",
      "record_view": {
        "name": "Open cases by priority",
        "report_view": "chart",
        "elements": [
          {
            "id": "a1b2c3d4e5f6",
            "name": "Priority breakdown",
            "record_type_name": "Cases",
            "element_type": "bar_chart",
            "axes": [{ "direction": "X", "record_field_name": "priority" }],
            "aggregation": "COUNT",
            "rolling_date_range": "LAST_7_DAYS",
            "range_start": null,
            "range_end": null,
            "filters": { "stories": [], "fields": [] },
            "order": { "field": null, "direction": "DESC" },
            "color_palette": "colorful",
            "options": {},
            "record_fields": [],
            "test_mode": false
          }
        ],
        "layout": [{ "i": "a1b2c3d4e5f6", "h": 4, "w": 6, "x": 0, "y": 0 }]
      }
    }
  }'

Response

A successful request will return a JSON object describing the newly created record view with a 201 status code.

Field description

Parameter Description
id Integer ID of the record view.
name Name of the record view.
team Object describing the team this record view belongs to.
team.id Integer ID of the team.
team.name Name of the team.
created_at ISO 8601 timestamp representing when the record view was created.
updated_at ISO 8601 timestamp representing when the record view was last updated.

Sample response

{
  "id": 42,
  "name": "Imported view",
  "team": {
    "id": 14,
    "name": "Security Operations"
  },
  "created_at": "2025-02-14T10:30:00Z",
  "updated_at": "2025-02-14T10:30:00Z"
}
Was this helpful?