Optical measurements reference

Optical measurements endpoint authentication, parameters, request and response contracts.

Last updated:

On this pageGET /api/p/{pid}/optikPOST /api/p/{pid}/optik/{oid}/dosyaGET /api/p/{pid}/optik/{oid}/dosyaPOST /api/p/{pid}/optik/{oid}/sor-uygulaGET /api/p/{pid}/optik/rapor

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.

GET /api/p/{pid}/optik

Get optical settings

Product library, project profiles with reference summaries, and selection. Viewer access is allowed; returns 403 if fiber is disabled.

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
kapaliqueryintegerNo

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.

POST /api/p/{pid}/optik/{oid}/dosya

Upload optical measurement file

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
oidpathstringYes
versionqueryinteger | nullNo

Request body

multipart/form-data

FieldTypeRequiredDescription
filestringYes

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.

GET /api/p/{pid}/optik/{oid}/dosya

Download optical measurement file

Downloads a measurement file with read permission; returns 403 if fiber is disabled. The byte digest is checked against the stored sha256 value. A file not transferred with a project package returns `dosya_yok`.

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
oidpathstringYes
kapaliqueryintegerNo

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.

POST /api/p/{pid}/optik/{oid}/sor-uygula

Apply optical SOR suggestions

Applies SOR suggestions through the measurement’s existing compare-and-swap write path, using an explicit field selection.

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
oidpathstringYes

Request body

application/json

Type: object.

{
  "type": "object",
  "additionalProperties": true,
  "title": "Body"
}

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.

GET /api/p/{pid}/optik/rapor

Get optical report

F7-2 measurement report (K14, §7/10; F8 input): compares each measurement with its linked calculation (S6), including that calculation’s current out-of-date status. Uses one consistent data snapshot (`generated_at` and the latest changes.id). format=csv uses a semicolon delimiter, UTF-8 BOM, decimal commas and formula-injection protection.

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
formatquerystringNo
devrequerystring | nullNo
turquerystring | nullNo
durumquerystring | nullNo
limitqueryintegerNo
offsetqueryintegerNo
kapaliqueryintegerNo

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.