Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Project Management

Photos

14 endpoints13 implementedAll modules →
  1. GET /rest/v1.0/image_categoriesList image categories
  2. POST /rest/v1.0/image_categoriesCreate image category
  3. GET /rest/v1.0/image_categories/{id}Show image category
  4. PATCH /rest/v1.0/image_categories/{id}Update image category
  5. DELETE /rest/v1.0/image_categories/{id}Delete image category
  6. GET /rest/v1.0/image_categories/ids_with_imagesList Image Category IDs That Contain Images
  7. GET /rest/v1.0/imagesList images
  8. POST /rest/v1.0/imagesCreate image
  9. GET /rest/v1.0/images/{id}Show image
  10. PATCH /rest/v1.0/images/{id}Update image
  11. DELETE /rest/v1.0/images/{id}Delete image
  12. GET /rest/v1.0/images/{id}/annotationsList photo annotations (markup)
  13. POST /rest/v1.0/images/{id}/annotationsCreate a photo annotation (markup)
  14. DELETE /rest/v1.0/images/{id}/annotations/{annotation_id}Delete a photo annotation
GET /rest/v1.0/image_categories

List image categories

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • page
    integerquery
  • per_page
    integerquery

Response · 200 · object[]

  • id
    integer
  • count
    integer
  • cover_photo
    string
  • created_at
    string (date-time)
  • links
    object
  • name
    string
  • private
    boolean
  • updated_at
    string (date-time)
  • position
    integer
POST /rest/v1.0/image_categories

Create image category

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired

Request body

  • image_category
    objectrequired

Response · 201 · object

  • id
    integer
  • name
    string
  • position
    integer
  • album_cover_id
    integer
  • created_at
    string (date-time)
  • private
    boolean
  • count
    integer
GET /rest/v1.0/image_categories/{id}

Show image category

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • position
    integer
  • album_cover_id
    integer
  • created_at
    string (date-time)
  • private
    boolean
  • count
    integer
PATCH /rest/v1.0/image_categories/{id}

Update image category

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Request body

  • image_category
    objectrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • position
    integer
  • album_cover_id
    integer
  • created_at
    string (date-time)
  • private
    boolean
  • count
    integer
DELETE /rest/v1.0/image_categories/{id}

Delete image category

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200

No response body.

GET /rest/v1.0/image_categories/ids_with_images

List Image Category IDs That Contain Images

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • filters[updated_at]
    stringquery

Response · 200 · integer[]

No documented fields.

GET /rest/v1.0/images

List images

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired
  • image_category_id
    integerquery
  • page
    integerquery
  • per_page
    integerquery
  • filters[daily_log_segment_id]
    integer[]query
  • filters[log_date]
    string (date)query
  • filters[private]
    booleanquery
  • filters[starred]
    booleanquery
  • filters[location_id]
    integer[]query
  • filters[include_sublocations]
    booleanquery
  • filters[trade_ids]
    integer[]query
  • filters[projection]
    stringquery
  • filters[query]
    stringquery
  • filters[created_at]
    string (date)query
  • filters[updated_at]
    string (date)query
  • filters[uploader_id]
    integer[]query
  • filters[id]
    integer[]query
  • sort
    stringquery
  • serializer_view
    stringquery

Response · 200 · object[]

  • id
    integer
  • url
    string
  • size
    integer
  • filename
    string
  • thumbnail_url
    string
  • taken_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • location
    object
  • image_category_name
    string
  • image_category_id
    integer
  • permanently_deleted
    boolean
  • private
    boolean
  • projection
    string
  • starred
    boolean
  • width
    integer
  • height
    integer
  • image_category_private
    boolean
  • origin_id
    integer
  • daily_log_header_id
    integer
  • daily_log_segment_id
    integer
  • daily_log_segment
    object
  • gps_lat
    string
  • gps_long
    string
  • uploader
    object
  • links
    object
  • trades
    object[]
  • comments_count
    integer
POST /rest/v1.0/images

Create image

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerqueryrequired

Request body

  • upload_uuid
    string
  • source_image_id
    integer
  • image_name
    string
  • image
    objectrequired

Response · 201 · object

  • id
    integer
  • url
    string
  • size
    integer
  • filename
    string
  • thumbnail_url
    string
  • taken_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • location
    object
  • image_category_name
    string
  • image_category_id
    integer
  • permanently_deleted
    boolean
  • private
    boolean
  • projection
    string
  • starred
    boolean
  • width
    integer
  • height
    integer
  • image_category_private
    boolean
  • origin_id
    integer
  • daily_log_header_id
    integer
  • daily_log_segment_id
    integer
  • daily_log_segment
    object
  • gps_lat
    string
  • gps_long
    string
  • uploader
    object
  • links
    object
  • trades
    object[]
  • comments_count
    integer
GET /rest/v1.0/images/{id}

Show image

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Response · 200 · object

  • id
    integer
  • url
    string
  • size
    integer
  • filename
    string
  • thumbnail_url
    string
  • taken_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • location
    object
  • image_category_name
    string
  • image_category_id
    integer
  • permanently_deleted
    boolean
  • private
    boolean
  • projection
    string
  • starred
    boolean
  • width
    integer
  • height
    integer
  • image_category_private
    boolean
  • origin_id
    integer
  • daily_log_header_id
    integer
  • daily_log_segment_id
    integer
  • daily_log_segment
    object
  • gps_lat
    string
  • gps_long
    string
  • uploader
    object
  • links
    object
  • trades
    object[]
  • comments_count
    integer
  • tiling_status
    string
  • tiles_config
    object
PATCH /rest/v1.0/images/{id}

Update image

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired

Request body

  • image
    objectrequired

Response · 200 · object

  • id
    integer
  • url
    string
  • size
    integer
  • filename
    string
  • thumbnail_url
    string
  • taken_at
    string (date-time)
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • location
    object
  • image_category_name
    string
  • image_category_id
    integer
  • permanently_deleted
    boolean
  • private
    boolean
  • projection
    string
  • starred
    boolean
  • width
    integer
  • height
    integer
  • image_category_private
    boolean
  • origin_id
    integer
  • daily_log_header_id
    integer
  • daily_log_segment_id
    integer
  • daily_log_segment
    object
  • gps_lat
    string
  • gps_long
    string
  • uploader
    object
  • links
    object
  • trades
    object[]
  • comments_count
    integer
DELETE /rest/v1.0/images/{id}

Delete image

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • id
    integerpathrequired
  • project_id
    integerqueryrequired
  • permanent
    booleanquery

Response · 200

No response body.

GET /rest/v1.0/images/{id}/annotations

List photo annotations (markup)

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired
  • id
    integerpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • image_id
    integerrequired
  • note
    stringrequired
  • x
    number
  • y
    number
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • created_by
    object
POST /rest/v1.0/images/{id}/annotations

Create a photo annotation (markup)

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired
  • id
    integerpathrequired

Request body

  • annotation
    objectrequired

Response · 201 · object

  • id
    integerrequired
  • image_id
    integerrequired
  • note
    stringrequired
  • x
    number
  • y
    number
  • created_at
    string (date-time)required
  • updated_at
    string (date-time)required
  • created_by
    object
DELETE /rest/v1.0/images/{id}/annotations/{annotation_id}

Delete a photo annotation

v1.0Implemented

Parameters

  • project_id
    integerqueryrequired
  • id
    integerpathrequired
  • annotation_id
    integerpathrequired

Response · 200 · object

  • id
    integerrequired

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file