Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Core Tools

Locations

5 endpoints2 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/locationsList Project Locations
  2. POST /rest/v1.0/projects/{project_id}/locationsCreate Location (Admin)
  3. GET /rest/v1.0/projects/{project_id}/locations/{location_id}Show Project Location
  4. PATCH /rest/v1.0/projects/{project_id}/locations/{location_id}Update Project Location
  5. DELETE /rest/v1.0/projects/{project_id}/locations/{location_id}Delete Project Location
GET /rest/v1.0/projects/{project_id}/locations

List Project Locations

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • filters[id]
    integer[]query
  • filters[parent_id]
    integerquery
  • filters[code]
    string[]query
  • filters[search]
    stringquery
  • filters[search_with_code]
    stringquery
  • filters[superlocations_for]
    integerquery
  • filters[sublocations_for]
    integerquery
  • filters[updated_at]
    string (date)query
  • sort
    stringquery
  • project_id
    integerpathrequired
  • page
    integerquery
  • per_page
    integerquery
  • filters[depth_range]
    stringquery

Response · 200 · object[]

  • id
    integer
  • name
    string
  • node_name
    string
  • parent_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • code
    string
POST /rest/v1.0/projects/{project_id}/locations

Create Location (Admin)

v1.0Implemented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired

Request body

  • location
    objectrequired

Response · 201 · object

  • id
    integer
  • name
    string
  • node_name
    string
  • parent_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • code
    string
GET /rest/v1.0/projects/{project_id}/locations/{location_id}

Show Project Location

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • location_id
    integerpathrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • node_name
    string
  • parent_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • code
    string
PATCH /rest/v1.0/projects/{project_id}/locations/{location_id}

Update Project Location

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • location_id
    integerpathrequired

Request body

  • location
    objectrequired

Response · 200 · object

  • id
    integer
  • name
    string
  • node_name
    string
  • parent_id
    integer
  • created_at
    string (date-time)
  • updated_at
    string (date-time)
  • code
    string
DELETE /rest/v1.0/projects/{project_id}/locations/{location_id}

Delete Project Location

v1.0Documented

Parameters

  • OS-Company-Id
    integerheaderrequired
  • project_id
    integerpathrequired
  • location_id
    integerpathrequired

Response · 200

No response body.

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