The Linked Location object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string
parent_type string
location string required
The Linked Location object 
{
  "id": "linked-location_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "location": "location_example"
}
GET /api/assets/linked-location?parent_id={id}

List linked locations by parent

Returns all linked locations belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of linked location objects belonging to the parent.

GET /api/assets/linked-location?parent_id={id} 
curl https://api.overplane.dev/api/assets/linked-location?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "linked-location_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "location": "location_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/assets/linked-location

Create a linked location

Creates a new linked location object.

Body parameters

idx integer
parent_id string
parent_type string
location string required

Returns

Returns the newly created linked location object if the call succeeded.

POST /api/assets/linked-location 
curl https://api.overplane.dev/api/assets/linked-location \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"location":"location_example"}'
Response 
{
  "id": "linked-location_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "location": "location_example"
}
PATCH /api/assets/linked-location/{id}

Update a linked location

Updates the specified linked location by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the linked location to update.

Body parameters

idx integer
parent_id string
parent_type string
location string

Returns

Returns the updated linked location object.

PATCH /api/assets/linked-location/{id} 
curl https://api.overplane.dev/api/assets/linked-location/linked-location_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "linked-location_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "location": "location_example"
}
DELETE /api/assets/linked-location/{id}

Delete a linked location

Permanently deletes a linked location. This cannot be undone.

Path parameters

id string required

The identifier of the linked location to delete.

Returns

Returns a confirmation that the linked location has been deleted.

DELETE /api/assets/linked-location/{id} 
curl https://api.overplane.dev/api/assets/linked-location/linked-location_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "linked-location_abc123",
  "deleted": true
}
POST /api/assets/linked-location/reorder

Reorder linked locations

Updates the sort order of linked locations within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/assets/linked-location/reorder 
curl https://api.overplane.dev/api/assets/linked-location/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "linked-location_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "location": "location_example"
}