Electric (Coming soon) reference

Electric (Coming soon) endpoint authentication, parameters, request and response contracts.

Last updated:

On this pageGET /api/p/{pid}/elektrik/kutuphaneGET /api/p/{pid}/elektrik/envanterGET /api/p/{pid}/elektrik/politikaPOST /api/p/{pid}/elektrik/politikaGET /api/p/{pid}/elektrik/politika/raporPOST /api/p/{pid}/elektrik/politika/onizlemePOST /api/p/{pid}/elektrik/profil-uygula/onizlemePOST /api/p/{pid}/elektrik/profil-uygulaPOST /api/p/{pid}/elektrik/aktarimPOST /api/p/{pid}/elektrik/aktarim/{token}/onizlemePOST /api/p/{pid}/elektrik/aktarim/{token}DELETE /api/p/{pid}/elektrik/aktarim/{token}POST /api/p/{pid}/elektrik/kaynak-karari/onizlemePOST /api/p/{pid}/elektrik/kaynak-karariGET /api/p/{pid}/elektrik/kaynaklarGET /api/p/{pid}/elektrik/kaynak/{sid}GET /api/p/{pid}/elektrik/disariGET /api/p/{pid}/elektrik/{tur}/{eid}

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}/elektrik/kutuphane

Read electric library

Product library with sourced structure templates and dictionary sources, and project profiles with reference counts.

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

Coming soon: The electric module is not currently available for general use.

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.

GET /api/p/{pid}/elektrik/envanter

Get electric inventory

Inventory (E1-3-SOZLESME §2.2.1–2.2.4): tur=kablo|ekipman|profil; envelope {tur, items, offset, limit, toplam, sayilar}; ordered by identifier text; ends when offset+len>=toplam. Cable rows contain the extension, flattened effective values, effective source, conductor summary, length (saha.cable_lengths) and violation count. Equipment rows contain location source and type, only their own Point, and the resolved root site point. konum=bagimsiz selects records with their own Point only. Invalid parameters return 400 parametre.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
kapaliqueryintegerNo
turquerystringNo
offsetqueryintegerNo
limitqueryintegerNo
profilquerystring | nullNo
durumquerystring | nullNo
qquerystring | nullNo
konumquerystring | nullNo
yerquerystring | 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.

GET /api/p/{pid}/elektrik/politika

Read electric policy

Policy register: levels of the three rules, informational by default, violation counts, whether rejection can be enabled, and the data snapshot. Available to Viewers; writes no data.

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

Coming soon: The electric module is not currently available for general use.

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}/elektrik/politika

Update electric policy

Confirmed write: recalculates the summary under a lock (409 ozet_eskimis). Rejection can be enabled only after a clean scan (409 ret_temiz_degil).

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes

Request body

application/json

FieldTypeRequiredDescription
kurallarobject | nullNo
gerekcestring | nullNo
versioninteger | nullNo
ozetstring | nullNo
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.

GET /api/p/{pid}/elektrik/politika/rapor

Get electric policy report

Evidence report from one data snapshot, without writes. CSV uses the same columns. Does not produce a finding of electrical compliance.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
kapaliqueryintegerNo
kuralquerystring | nullNo
offsetqueryintegerNo
limitqueryintegerNo
formatquerystringNo

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}/elektrik/politika/onizleme

Preview electric policy

Administrators only; writes no data. Shows before/after values for each rule, violation counts, reasons preventing rejection and a confirmation summary.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes

Request body

application/json

FieldTypeRequiredDescription
kurallarobject | nullNo
gerekcestring | nullNo
versioninteger | nullNo
ozetstring | nullNo
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.

POST /api/p/{pid}/elektrik/profil-uygula/onizleme

Plan electric profile application

Explicit profile application plan, without writes: field differences, conductor-to-group mapping supplied or suggested, missing items, summary and versions.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes

Request body

application/json

FieldTypeRequiredDescription
kablo_idstring | nullNo
versioninteger | nullNo
profile_idstring | nullNo
dondurboolean | nullNo
damar_uretobject | nullNo
damar_silnesne[] | nullNo
eslemelerobject | nullNo
override_kaldirnesne[] | nullNo
damar_override_kaldirobject | nullNo
ozetstring | nullNo
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.

POST /api/p/{pid}/elektrik/profil-uygula

Apply electric profile

Applies a confirmed plan in one transaction (SOZLESME §2.8): permission check → project lock → permission recheck → cache (route and canonical intent; request_id mapped to generated operations) → on a cache miss only, regenerate the plan and check summary and applicability → save the mapping → apply the /edit body in the same transaction, repeatable with `pu-<sha(rid)>`. An error rolls back the entire transaction, including the mapping. A competing call cannot alter another call’s mapping because the lock serialises access.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes

Request body

application/json

FieldTypeRequiredDescription
kablo_idstring | nullNo
versioninteger | nullNo
profile_idstring | nullNo
dondurboolean | nullNo
damar_uretobject | nullNo
damar_silnesne[] | nullNo
eslemelerobject | nullNo
override_kaldirnesne[] | nullNo
damar_override_kaldirobject | nullNo
ozetstring | nullNo
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.

POST /api/p/{pid}/elektrik/aktarim

Upload electric import

§1.1 upload: temporary file with a defined size allowance and SHA-256 digest, columns, sheets, suggestions and source namespaces. Writes no data and uses no lock or cache.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes

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.

POST /api/p/{pid}/elektrik/aktarim/{token}/onizleme

Preview electric import

§1.2 preview without writes, locks or cache, following the F2b pattern: row status, cost, batch plan and summary.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
tokenpathstringYes

Request body

application/json

FieldTypeRequiredDescription
kaynakstring | nullNo
sayfastring | nullNo
turstring | nullNo
crsstring | nullNo
eslemobject | nullNo
birimlerobject | nullNo
ebeveynobject | nullNo
secimobject | nullNo
offsetintegerNo

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}/elektrik/aktarim/{token}

Confirm electric import

§1.3 confirmation in one transaction. Order: permission check → _imp_dir format → lock and refreshed module permission check → edit_requests cache → persistent result record in imports with request_hash → directory lookup (404 / 410) → recalculate preview (ozet / plan[0]) → write data, imports and sonuc → edit_requests. Deletes the file when kalan_batch == 0.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
tokenpathstringYes

Request body

application/json

FieldTypeRequiredDescription
kaynakstring | nullNo
sayfastring | nullNo
turstring | nullNo
crsstring | nullNo
eslemobject | nullNo
birimlerobject | nullNo
ebeveynobject | nullNo
secimobject | nullNo
request_idstring | nullNo
ozetstring | nullNo
satirlarnesne[] | 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}/elektrik/aktarim/{token}

Cancel electric import

§1.4 cancellation under the project lock, serialised with confirmation. Returns {ok:true} even if the directory is missing, the sole explicit exception to the general 410 rule.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
tokenpathstringYes

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}/elektrik/kaynak-karari/onizleme

Preview electric source decision

§1.5 decision preview without writes: {ozet, once, sonra, hedef_ozet, uyarilar}.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes

Request body

application/json

FieldTypeRequiredDescription
kaynak_idstring | nullNo
versioninteger | nullNo
kararstring | nullNo
hedefobject | nullNo
kabul_revizyoninteger | nullNo
gerekcestring | nullNo
request_idstring | nullNo
ozetstring | 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.

POST /api/p/{pid}/elektrik/kaynak-karari

Record electric source decision

§1.5 decision write: lock → refreshed permission check → cache → summary/version check → electric_source UPDATE, with changes kind='edit' and full before/after values.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes

Request body

application/json

FieldTypeRequiredDescription
kaynak_idstring | nullNo
versioninteger | nullNo
kararstring | nullNo
hedefobject | nullNo
kabul_revizyoninteger | nullNo
gerekcestring | nullNo
request_idstring | nullNo
ozetstring | 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.

GET /api/p/{pid}/elektrik/kaynaklar

List electric sources

§1.6 source list with envelope {toplam, offset, limit, kaynak_adlari, satirlar}. Invalid parameters return 400 parametre.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
kapaliqueryintegerNo
kaynakquerystring | nullNo
turquerystring | nullNo
kararquerystring | nullNo
qquerystring | nullNo
hedefquerystring | nullNo
silinmisqueryintegerNo
siralaquerystringNo
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.

GET /api/p/{pid}/elektrik/kaynak/{sid}

Get electric source detail

§1.6 source detail: row, revisions ordered newest first and paginated, and hedef_ozet.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
sidpathstringYes
kapaliqueryintegerNo
silinmisqueryintegerNo
rev_offsetqueryintegerNo
rev_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.

GET /api/p/{pid}/elektrik/disari

Export electric sources

§1.7 source-linked export: one REPEATABLE READ READ ONLY transaction, using the existing F8 engine and its output rules (O route and permission check; C formatter).

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
formatquerystring | nullNo
tabloquerystring | 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}/elektrik/{tur}/{eid}

Get electric detail

Detail selected from an allowed type list: cable with extension, effective values, conductors and length; profile with groups and references; conductor with effective values.

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

Coming soon: The electric module is not currently available for general use.

Parameters

NameLocationTypeRequired
pidpathintegerYes
turpathstringYes
eidpathstringYes
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.