Skip to content
Omniglass Omniglass Omniglass

Set a property on a location

PUT
/locations/{name}/properties/{property}
 
curl --request PUT \
  --url https://example.com/api/v1/locations/example/properties/example \
  --header 'Content-Type: application/json' \
  --data '{ "value": "example" }'

Declares a value for the property on this location, overriding the location type contract’s default. Idempotent: the first set stores the value, a later set replaces it. The property need not be on the contract, but it must exist in the catalog (422 otherwise). Gated by location:update; an out-of-scope location is a non-disclosing 404.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
name
required

The location’s unique name

string

The location’s unique name

property
required

The property name

string

The property name

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
value
required

The value to declare, shape given by the property’s data_type

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
location
required
string
property_type_id
required

The catalog property’s uuid, the stable form of property_type_name

string
property_type_name
required
string
value
required

The stored value, shape given by the property’s data_type

value_id
required

The stored value’s id

string
Example 
{
  "$schema": "/api/v1/schemas/LocationPropertyBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}