Export

Description

Export a record view. The response can be passed to the import endpoint to recreate the record view in another team or tenant.

Request

HTTP Method: GET

Path Parameter Description
record_view_id The ID of the record view to export. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/record_views/<<record_view_id>>/export \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return a JSON object representing the record view in exported form.

Field description

Parameter Description
schema_version The version of the export schema format.
record_view Object containing the record view configuration. Pass this object to the import endpoint to recreate the record view.

Sample response

{
  "schema_version": 1,
  "record_view": {
    "name": "Open cases by priority",
    "report_view": "chart",
    "elements": [
      {
        "id": "a1b2c3d4e5f6",
        "name": "Priority breakdown",
        "record_type_name": "Cases",
        "element_type": "chart",
        "axes": [
          {
            "direction": "x",
            "record_field_name": "priority"
          }
        ],
        "aggregation": "count",
        "rolling_date_range": null,
        "range_start": null,
        "range_end": null,
        "filters": {
          "stories": [],
          "fields": [
            {
              "value": "open",
              "operator": "equals",
              "name": "status"
            }
          ]
        },
        "order": {
          "field": null,
          "direction": null
        },
        "color_palette": "default",
        "options": {},
        "record_fields": [],
        "test_mode": false
      }
    ],
    "layout": [
      {
        "i": "a1b2c3d4e5f6",
        "x": 0,
        "y": 0,
        "w": 6,
        "h": 4
      }
    ]
  }
}
Was this helpful?