Technical circuits reference

Technical circuits endpoint authentication, parameters, request and response contracts.

Last updated:

On this pageGET /api/p/{pid}/devrelerPOST /api/p/{pid}/devreler/yol-araGET /api/p/{pid}/devreler/ortak-riskGET /api/p/{pid}/devreler/kullanimGET /api/p/{pid}/devreler/{did}POST /api/p/{pid}/devreler/dogrulaPOST /api/p/{pid}/devreler/{did}/dogrulaGET /api/p/{pid}/devreler/{did}/optikPOST /api/p/{pid}/devreler/{did}/optik-hesap

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}/devreler

List technical circuits

Circuit list and counts by status × path status. The `kopuk` filter provides the disconnection report. Cable or device filters identify circuits whose recorded path passes through that record, for information.

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
durumquerystring | nullNo
yol_durumuquerystring | nullNo
amacquerystring | nullNo
ucquerystring | nullNo
kabloquerystring | nullNo
cihazquerystring | nullNo
qquerystring | nullNo
grupquerystring | nullNo
offsetqueryintegerNo
limitqueryintegerNo

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}/devreler/yol-ara

Find circuit path

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

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}/devreler/ortak-risk

Assess shared circuit risk

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
dquerystring[]No
yolquerystringNo
formatquerystringNo
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.

GET /api/p/{pid}/devreler/kullanim

Get circuit usage

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
kabloquerystring | nullNo
cihazquerystring | nullNo
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.

GET /api/p/{pid}/devreler/{did}

Get circuit

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
didpathstringYes
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}/devreler/dogrula

Validate all

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

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}/devreler/{did}/dogrula

Validate one

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
didpathstringYes

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}/devreler/{did}/optik

Get circuit optical calculations

Live calculation, without saving, and the circuit’s saved calculation snapshots with reasons they are out of date (K12). Uses one consistent data snapshot.

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
didpathstringYes
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}/devreler/{did}/optik-hesap

Save optical calculation snapshot

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
didpathstringYes

Request body

application/json

FieldTypeRequiredDescription
request_idstring | 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.