Kohandatud väljade API

Kohandatud väljad võimaldavad teil laiendada Kordoni ressursse täiendavate atribuutidega, mis on spetsiifilised teie organisatsiooni vajadustele. Saate lisada kohandatud välju erinevatele ressursitüüpidele nagu Nõuded, Varad, Riskid ja muud.

Väljatüübid

Saadaolevad väljatüübid (kind):

• string - Tekstisisestuse väli
• number - Numbriline sisestusväli
• boolean - Tõene/väär märkeruut
• date - Kuupäeva valija
• select - Rippmenüü eelmääratletud valikutega
• multiselect - Mitme valiku rippmenüü

Hetkel toetatud

Praegu on toetatud ainult string tüüp. Teised väljatüübid on planeeritud tulevastesse versioonidesse.

Välja seadistused

configuration objekt sisaldab tüübispetsiifilisi seadistusi:

• select ja multiselect jaoks: Saadaolevate valikute nimekiri
• number jaoks: Min/max väärtused, kümnendkohad
• string jaoks: Maksimaalne pikkus, valideerimisreeglid

Õigused

permissions objekt näitab, milliseid toiminguid praegune kasutaja saab teha:

• update - Saab kohandatud välja muuta
• destroy - Saab kohandatud välja kustutada
• connect - Saab välja kasutada ressurssidel
• changelog - Saab vaadata välja muudatuste ajalugu

GET /custom_fields/

Kõikide organisatsiooni kohandatud väljade nimekiri.

Väljad

Väli	Tüüp	Kirjeldus
id	UUID	Kohandatud välja unikaalne tunnus.
name	string	Välja sisemine nimi (väiketähed alakriipsudega).
label	string	Kasutajatele näidatav nimi.
description	string	Välja eesmärgi kirjeldus (valikuline).
kind	string	Väljatüüp (string, number, boolean, date, select, multiselect). Hetkel on toetatud ainult string.
attribute_of	string	Ressursitüüp, millele see väli kuulub (nt “Requirement”, “Asset”).
is_required	boolean	Kas väli tuleb täita. (Ei ole veel rakendatud)
is_shown_in_detail_view	boolean	Kas väli kuvatakse ressursi detailvaates.
public	boolean	Kas väli on nähtav kõigile kasutajatele. (Ei ole veel rakendatud)
configuration	object	Tüübispetsiifilised seadistused ja valikud.
permissions	object	Kasutaja õigused: update, destroy, connect, changelog.
created_at	timestamp	ISO 8601 ajatempel, millal väli loodi.
updated_at	timestamp	Viimase muudatuse ISO 8601 ajatempel.

curl --location GET \
--url "https://SINU_KORDONI_DOMEEN/api/v1/custom_fields/" \
--header "Authorization: Bearer SINU_VÕTI"

Vastuse näide

Staatus: 200

{
    "data": [
        {
            "id": "83d028c1-9ce1-4f29-ad2b-994c2d0ebd4f",
            "attribute_of": "Requirement",
            "configuration": {},
            "created_at": "2026-02-20T11:19:53+00:00",
            "description": "",
            "is_required": false,
            "is_shown_in_detail_view": false,
            "kind": "string",
            "label": "my custom field",
            "name": "my_custom_field",
            "permissions": {
                "update": true,
                "destroy": true,
                "connect": true,
                "changelog": true
            },
            "public": true,
            "updated_at": "2026-02-20T11:19:53+00:00"
        }
    ],
    "meta": {
        "total_count": 1,
        "page": 1,
        "permissions": {
            "create": true
        }
    }
}

GET /custom_fields/:id

Konkreetse kohandatud välja päring ID järgi.

curl --location GET \
--url "https://SINU_KORDONI_DOMEEN/api/v1/custom_fields/83d028c1-9ce1-4f29-ad2b-994c2d0ebd4f" \
--header "Authorization: Bearer SINU_VÕTI"

Vastuse näide

Staatus: 200

{
    "data": {
        "id": "83d028c1-9ce1-4f29-ad2b-994c2d0ebd4f",
        "attribute_of": "Requirement",
        "configuration": {},
        "created_at": "2026-02-20T11:19:53+00:00",
        "description": "",
        "is_required": false,
        "is_shown_in_detail_view": false,
        "kind": "string",
        "label": "my custom field",
        "name": "my_custom_field",
        "permissions": {
            "update": true,
            "destroy": true,
            "connect": true,
            "changelog": true
        },
        "public": true,
        "updated_at": "2026-02-20T11:19:53+00:00"
    }
}

POST /custom_fields/

Uue kohandatud välja loomine.

Väli	Tüüp	Kohustuslik	Kirjeldus
name	string	Jah	Välja sisemine nimi (väiketähed, ainult alakriipsud).
label	string	Jah	Kasutajatele näidatav nimi.
kind	string	Jah	Väljatüüp: string, number, boolean, date, select, multiselect. Hetkel on toetatud ainult string.
attribute_of	string	Jah	Ressursitüüp: Requirement, Asset, Risk, Control, jne.
description	string	Ei	Välja eesmärgi kirjeldus (valikuline).
is_required	boolean	Ei	Kas väli tuleb täita. Vaikimisi: false. (Ei ole veel rakendatud)
is_shown_in_detail_view	boolean	Ei	Kuva detailvaates. Vaikimisi: false.
public	boolean	Ei	Nähtav kõigile kasutajatele. Vaikimisi: true. (Ei ole veel rakendatud)
configuration	object	Ei	Tüübispetsiifilised seadistused (nt valikud select väljadele).

curl --location POST \
--url "https://SINU_KORDONI_DOMEEN/api/v1/custom_fields/" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer SINU_VÕTI" \
--data '{
    "name": "compliance_status",
    "label": "Vastavuse staatus",
    "kind": "select",
    "attribute_of": "Requirement",
    "description": "Nõuete vastavuse staatuse jälgimine",
    "is_required": true,
    "is_shown_in_detail_view": true,
    "public": true,
    "configuration": {
        "options": ["Alustamata", "Pooleli", "Vastavuses", "Mittevastavuses"]
    }
}'

Vastuse näide

Staatus: 201

{
    "data": {
        "id": "a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890",
        "attribute_of": "Requirement",
        "configuration": {
            "options": ["Alustamata", "Pooleli", "Vastavuses", "Mittevastavuses"]
        },
        "created_at": "2026-02-20T12:30:45+00:00",
        "description": "Nõuete vastavuse staatuse jälgimine",
        "is_required": true,
        "is_shown_in_detail_view": true,
        "kind": "select",
        "label": "Vastavuse staatus",
        "name": "compliance_status",
        "permissions": {
            "update": true,
            "destroy": true,
            "connect": true,
            "changelog": true
        },
        "public": true,
        "updated_at": "2026-02-20T12:30:45+00:00"
    }
}

PATCH /custom_fields/:id

Olemasoleva kohandatud välja uuendamine.

Märkus

Välja kind muutmine, kui sellel on juba andmeid, võib põhjustada andmekadu või teisendusprobleeme.

curl --location PATCH \
--url "https://SINU_KORDONI_DOMEEN/api/v1/custom_fields/83d028c1-9ce1-4f29-ad2b-994c2d0ebd4f" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer SINU_VÕTI" \
--data '{
    "label": "Uuendatud kohandatud väli",
    "is_required": true,
    "is_shown_in_detail_view": true
}'

Vastuse näide

Staatus: 200

{
    "data": {
        "id": "83d028c1-9ce1-4f29-ad2b-994c2d0ebd4f",
        "attribute_of": "Requirement",
        "configuration": {},
        "created_at": "2026-02-20T11:19:53+00:00",
        "description": "",
        "is_required": true,
        "is_shown_in_detail_view": true,
        "kind": "string",
        "label": "Uuendatud kohandatud väli",
        "name": "my_custom_field",
        "permissions": {
            "update": true,
            "destroy": true,
            "connect": true,
            "changelog": true
        },
        "public": true,
        "updated_at": "2026-02-20T13:45:22+00:00"
    }
}

DELETE /custom_fields/:id

Kohandatud välja kustutamine.

curl --location DELETE \
--url "https://SINU_KORDONI_DOMEEN/api/v1/custom_fields/83d028c1-9ce1-4f29-ad2b-994c2d0ebd4f" \
--header "Authorization: Bearer SINU_VÕTI"

Vastuse näide

Staatus: 204 No Content

---

Kohandatud väljade kasutamine ressurssidel

Kui olete kohandatud välja loonud, saate seada selle väärtuse vastaval ressursitüübil kasutades PATCH päringut. Kasutage kohandatud välja name võtmena.

Kohandatud välja väärtuse seadmine

Kohandatud välja väärtuse seadmiseks või uuendamiseks ressursil (nt Nõue, Vara, Risk), lisage väli PATCH päringus selle ressursi otspunkti.

Näide: Kohandatud välja seadmine nõudel

curl --location PATCH \
--url "https://SINU_KORDONI_DOMEEN/api/v1/requirements/NÕUDE_ID" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer SINU_VÕTI" \
--data '{
  "requirement": {
    "my_custom_field": "Pühapäeva test"
  }
}'

Näide: Mitme välja seadmine koos kohandatud väljadega

curl --location PATCH \
--url "https://SINU_KORDONI_DOMEEN/api/v1/requirements/NÕUDE_ID" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer SINU_VÕTI" \
--data '{
  "requirement": {
    "title": "Uuendatud nõude pealkiri",
    "my_custom_field": "Kohandatud väärtus",
    "compliance_status": "Pooleli"
  }
}'

Väljade nimed

Kasutage kohandatud välja name omadust (mitte label). Näiteks, kui lõite välja nimega name: "my_custom_field", kasutage täpselt seda nime oma PATCH päringutes.

Kohandatud välja väärtuse tühjendamine

Kohandatud välja väärtuse tühjendamiseks, seadke see null või tühja stringi:

curl --location PATCH \
--url "https://SINU_KORDONI_DOMEEN/api/v1/requirements/NÕUDE_ID" \
--header "Content-Type: application/json" \
--header "Authorization: Bearer SINU_VÕTI" \
--data '{
  "requirement": {
    "my_custom_field": null
  }
}'