Reference layers reference

Reference layers endpoint authentication, parameters, request and response contracts.

Last updated:

On this pagePATCH /api/p/{pid}/ref-layers/{rid}DELETE /api/p/{pid}/ref-layers/{rid}

Paths, methods, parameters and available schemas are generated from the OpenAPI document in the repository.

Note: These endpoints form the browser application contract and do not provide the same versioning assurance as v1. Use the versioned API for external integrations.

PATCH /api/p/{pid}/ref-layers/{rid}

Update reference layer

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

NameLocationTypeRequired
pidpathintegerYes
ridpathintegerYes

Request body

application/json

FieldTypeRequiredDescription
namestring | nullNo
styleobject | nullNo
sortinteger | nullNo

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.

DELETE /api/p/{pid}/ref-layers/{rid}

Delete reference layer

Soft-deletes the layer and its features and records the operation in history. It can be undone in the History panel.

Authentication: User session (cookie). Scope: Relevant organisation/project membership and operation permission; writes also check the current role, module and licence permissions.

Parameters

NameLocationTypeRequired
pidpathintegerYes
ridpathintegerYes

Responses

HTTP 200

application/json

This OpenAPI document does not define a body schema. See the relevant developer guide for details.

HTTP 422

application/json

FieldTypeRequiredDescription
detailValidationError[]No

For error meanings and client actions, see the error code glossary.