Table presets

>>>

GET /api/v2/table_presets
Get all table presets for the user

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Examples

// Succesful request
GET /api/v2/table_presets
200
{
  "table_presets": [
    {
      "name": "Default",
      "id": "default",
      "table_preset_columns": [
        {
          "table_preset_id": "default",
          "order": 0,
          "width": 180,
          "hidden": true,
          "name": "ID",
          "column_type": "default",
          "column_field": "_id"
        },
        {
          "table_preset_id": "default",
          "order": 1,
          "width": 180,
          "hidden": false,
          "name": "Thumbnail",
          "column_type": "default",
          "column_field": "thumbnail"
        },
        {
          "table_preset_id": "default",
          "order": 2,
          "width": 180,
          "hidden": false,
          "name": "Title",
          "column_type": "default",
          "column_field": "metadata.title.raw"
        },
        {
          "table_preset_id": "default",
          "order": 3,
          "width": 180,
          "hidden": false,
          "name": "Description",
          "column_type": "default",
          "column_field": "metadata.description.raw"
        },
        {
          "table_preset_id": "default",
          "order": 4,
          "width": 180,
          "hidden": false,
          "name": "Parent projects",
          "column_type": "default",
          "column_field": "parent_projects"
        },
        {
          "table_preset_id": "default",
          "order": 5,
          "width": 180,
          "hidden": false,
          "name": "Media type",
          "column_type": "default",
          "column_field": "media_type.raw"
        },
        {
          "table_preset_id": "default",
          "order": 6,
          "width": 180,
          "hidden": false,
          "name": "Tags",
          "column_type": "default",
          "column_field": "metadata.tags.keyword"
        },
        {
          "table_preset_id": "default",
          "order": 7,
          "width": 180,
          "hidden": false,
          "name": "Category",
          "column_type": "default",
          "column_field": "metadata.category.raw"
        },
        {
          "table_preset_id": "default",
          "order": 8,
          "width": 180,
          "hidden": false,
          "name": "Status",
          "column_type": "default",
          "column_field": "status.raw"
        },
        {
          "table_preset_id": "default",
          "order": 9,
          "width": 180,
          "hidden": false,
          "name": "Owner",
          "column_type": "default",
          "column_field": "metadata.owner.raw"
        },
        {
          "table_preset_id": "default",
          "order": 10,
          "width": 180,
          "hidden": false,
          "name": "Original filename",
          "column_type": "default",
          "column_field": "original_filename.keyword"
        },
        {
          "table_preset_id": "default",
          "order": 11,
          "width": 180,
          "hidden": false,
          "name": "Created",
          "column_type": "default",
          "column_field": "created_date"
        },
        {
          "table_preset_id": "default",
          "order": 12,
          "width": 180,
          "hidden": false,
          "name": "Modified",
          "column_type": "default",
          "column_field": "modification_date"
        },
        {
          "table_preset_id": "default",
          "order": 13,
          "width": 180,
          "hidden": false,
          "name": "External ID",
          "column_type": "default",
          "column_field": "external_id"
        }
      ]
    }
  ]
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/table_presets
Create a new table preset

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
name
required

Name of the table preset

Validations:

  • Must be a String

Examples

// Succesful request
POST /api/v2/table_presets
{
  "name": "Test preset"
}
200
{
  "table_preset": {
    "id": 1,
    "name": "Test preset",
    "user_id": 112,
    "created_at": "2023-11-27T09:43:02.368Z",
    "updated_at": "2023-11-27T09:43:02.368Z",
    "preference_id": null,
    "table_preset_columns": []
  }
}
// Unprocessable Entity
POST /api/v2/table_presets
{}
422
{
  "error": "Missing parameter name"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

POST /api/v2/table_presets/:table_preset_id/table_preset_columns
Create a table preset column

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
name
required

Column name

Validations:

  • Must be a String
column_type
required

Column type

Validations:

  • Must be a String
order
required

Position of the column

Validations:

  • Must be a Integer
width
required

Width of the column

Validations:

  • Must be a Integer
hidden
optional

Column visibility

Validations:

  • Must be one of: true, false.
field_id
optional

Id of associated custom field

Validations:

  • Must be a Integer

Examples

// Succesful request
POST /api/v2/table_presets/2/table_preset_columns
{
  "name": "ID",
  "column_type": "default",
  "width": 180,
  "order": 1
}
200
{
  "table_preset_column": {
    "id": 1,
    "table_preset_id": 2,
    "field_id": null,
    "name": "ID",
    "column_type": "default",
    "order": 1,
    "width": 180,
    "hidden": false,
    "created_at": "2023-11-27T09:43:02.589Z",
    "updated_at": "2023-11-27T09:43:02.589Z",
    "field_group_id": null,
    "column_field": "_id"
  }
}
// Table preset not found
POST /api/v2/table_presets/-1/table_preset_columns
404
{
  "error": "Couldn't find TablePreset with 'id'=-1"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

PUT /api/v2/table_presets/:table_preset_id
Change details of a table preset

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
name
required

Name of the table preset

Validations:

  • Must be a String

Examples

// Succesful request
PUT /api/v2/table_presets/3
{
  "name": "Test preset2"
}
200
{
  "table_preset": {
    "name": "Test preset2",
    "id": 3,
    "user_id": 116,
    "created_at": "2023-11-27T09:43:02.744Z",
    "updated_at": "2023-11-27T09:43:02.805Z",
    "preference_id": null,
    "table_preset_columns": []
  }
}
// Unprocessable Entity
PUT /api/v2/table_presets/4
{}
422
{
  "error": "Missing parameter name"
}
// Table preset not found
PUT /api/v2/table_presets/-1
{
  "name": "Test preset2"
}
404
{
  "error": "Couldn't find TablePreset with 'id'=-1"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

PUT /api/v2/table_presets/:table_preset_id/table_preset_columns/:table_preset_column_id
Change the details of a table preset column

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Params

Param name Description
order
required

Position of the column

Validations:

  • Must be a Integer
width
required

Width of the column

Validations:

  • Must be a Integer
hidden
optional

Column visibility

Validations:

  • Must be one of: true, false.

Examples

// Succesful request
PUT /api/v2/table_presets/5/table_preset_columns/2
{
  "order": 3,
  "width": 123,
  "hidden": true
}
200
{
  "table_preset_column": {
    "order": 3,
    "width": 123,
    "table_preset_id": 5,
    "hidden": true,
    "id": 2,
    "field_id": null,
    "name": "ID",
    "column_type": "default",
    "created_at": "2023-11-27T09:43:03.097Z",
    "updated_at": "2023-11-27T09:43:03.141Z",
    "field_group_id": null,
    "column_field": "_id"
  }
}
// Table preset column not found
PUT /api/v2/table_presets/6/table_preset_columns/-1
{
  "order": 3,
  "width": 123,
  "hidden": true
}
404
{
  "error": "Couldn't find TablePresetColumn with 'id'=-1"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters
>>>

DELETE /api/v2/table_presets/:table_preset_id
Delete a table preset

Headers

Header name Description
Content-Type
required 		application/json
X-API-KEY
required 		YOUR_API_KEY

Examples

// Succesful request
DELETE /api/v2/table_presets/7
200
{
  "ok": "ok"
}
// Table preset not found
DELETE /api/v2/table_presets/-1
404
{
  "error": "Couldn't find TablePreset with 'id'=-1"
}

Errors

Code Description
401 Unauthorized
404 Not found
500 Internal Server Error
422 Missing parameters