Preference

>>>

GET /api/v2/user/preference
Get user preference

Headers

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

Examples

// Succesful request
GET /api/v2/user/preference
200
{
  "preference": {
    "id": 7,
    "results_per_page": 40,
    "toggle_view": 0,
    "user_id": 61,
    "created_at": "2023-11-27T09:42:48.304Z",
    "updated_at": "2023-11-27T09:42:48.304Z",
    "search_attachments": false,
    "table_preset": {
      "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"
        }
      ]
    },
    "search_options": [
      {
        "id": 43,
        "data_field": "metadata.title"
      },
      {
        "id": 44,
        "data_field": "metadata.description"
      },
      {
        "id": 45,
        "data_field": "metadata.tags"
      },
      {
        "id": 46,
        "data_field": "ai_tags"
      },
      {
        "id": 47,
        "data_field": "exiftool_metadata.Keywords"
      },
      {
        "id": 48,
        "data_field": "exiftool_metadata.Copyright"
      },
      {
        "id": 49,
        "data_field": "exiftool_metadata.Creator"
      }
    ]
  }
}

Errors

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

PUT /api/v2/user/preference
Update user preference

Headers

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

Params

Param name Description
results_per_page
optional

Results per page

Validations:

  • Must be a Integer
toggle_view
optional

Toggle view

Validations:

  • Must be a Integer
table_preset_id
optional

Table preset ID

Validations:

  • Must be a Integer
search_attachments
optional

Include attachments in search

Validations:

  • Must be one of: true, false.

Examples

// Succesful request
PUT /api/v2/user/preference
{
  "results_per_page": 40
}
200
{
  "preference": {
    "user_id": 62,
    "results_per_page": 40,
    "id": 8,
    "toggle_view": 0,
    "created_at": "2023-11-27T09:42:48.483Z",
    "updated_at": "2023-11-27T09:42:48.483Z",
    "search_attachments": false,
    "table_preset": {
      "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"
        }
      ]
    },
    "search_options": [
      {
        "id": 50,
        "data_field": "metadata.title"
      },
      {
        "id": 51,
        "data_field": "metadata.description"
      },
      {
        "id": 52,
        "data_field": "metadata.tags"
      },
      {
        "id": 53,
        "data_field": "ai_tags"
      },
      {
        "id": 54,
        "data_field": "exiftool_metadata.Keywords"
      },
      {
        "id": 55,
        "data_field": "exiftool_metadata.Copyright"
      },
      {
        "id": 56,
        "data_field": "exiftool_metadata.Creator"
      }
    ]
  }
}

Errors

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

DELETE /api/v2/user/preference/table_preset
Remove chosen table preset, reset chosen table preset to default

Headers

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

Examples

// Succesful request
DELETE /api/v2/user/preference/table_preset
200
{
  "preference": {
    "user_id": 63,
    "id": 9,
    "results_per_page": 40,
    "toggle_view": 0,
    "created_at": "2023-11-27T09:42:48.696Z",
    "updated_at": "2023-11-27T09:42:48.696Z",
    "search_attachments": false,
    "table_preset": {
      "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"
        }
      ]
    },
    "search_options": [
      {
        "id": 57,
        "data_field": "metadata.title"
      },
      {
        "id": 58,
        "data_field": "metadata.description"
      },
      {
        "id": 59,
        "data_field": "metadata.tags"
      },
      {
        "id": 60,
        "data_field": "ai_tags"
      },
      {
        "id": 61,
        "data_field": "exiftool_metadata.Keywords"
      },
      {
        "id": 62,
        "data_field": "exiftool_metadata.Copyright"
      },
      {
        "id": 63,
        "data_field": "exiftool_metadata.Creator"
      }
    ]
  }
}

Errors

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

POST /api/v2/user/preference/search_options
Add a search option

Headers

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

Params

Param name Description
data_field
required

Validations:

  • Must be a String
search_option_type
required

Validations:

  • Must be a String
field_id
optional

Validations:

  • Must be a Integer

Examples

// Succesful request
POST /api/v2/user/preference/search_options
{
  "search_option_type": "default",
  "data_field": "metadata.title"
}
200
{
  "search_option": {
    "id": 71,
    "data_field": "metadata.title"
  }
}

Errors

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

DELETE /api/v2/user/preference/search_options/:search_option_id
Remove search option

Headers

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

Examples

// Succesful request
DELETE /api/v2/user/preference/search_options/79
200
{
  "ok": "ok"
}
// Search option not found
DELETE /api/v2/user/preference/search_options/-1
404
{
  "error": "Couldn't find SearchOption with 'id'=-1"
}

Errors

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