Raamistike API

Raamistikud tähistavad vastavusstandardeid, regulatsioone või muid standardeid, mida organisatsioon järgib (nt ISO 27001, SOC 2, GDPR). API-s viidatakse raamistikele kui regulations.

POST /regulations/

Uue raamistiku loomine.

Väli	Tüüp	Kohustuslik	Kirjeldus
title	string	Jah	Raamistiku nimi.

curl --location 'https://SINU_KORDONI_DOMEEN/api/v1/regulations/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI' \
--data '{
    "regulation": {
        "title": "ISO 27001:2022"
    }
}'

Vastuse näide:

Staatus 200

{
    "data": {
        "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
        "title": "ISO 27001:2022",
        "created_at": "2024-08-28T14:27:26+00:00",
        "updated_at": "2024-08-28T14:27:26+00:00"
    }
}

---

GET /regulations/:id

Raamistiku pärimine ID järgi.

curl --location --request GET 'https://SINU_KORDONI_DOMEEN/api/v1/regulations/b698a0ed-ad82-4468-900e-3b6eb3f5eb9b' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI'

Vastuse näide:

Staatus 200

{
    "data": {
        "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
        "title": "ISO 27001:2022",
        "created_at": "2024-08-28T14:27:26+00:00",
        "updated_at": "2024-08-28T14:27:26+00:00"
    }
}

---

GET /regulations/

Kõikide raamistike nimekiri.

curl --location --request GET 'https://SINU_KORDONI_DOMEEN/api/v1/regulations/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer SINU_VÕTI'

Vastuse näide:

Staatus 200

{
    "data": [
        {
            "id": "b698a0ed-ad82-4468-900e-3b6eb3f5eb9b",
            "title": "ISO 27001:2022",
            "created_at": "2024-08-28T14:27:26+00:00",
            "updated_at": "2024-08-28T14:27:26+00:00"
        },
        {
            "id": "023fb404-56f6-49cd-9379-dbf584d2eef8",
            "title": "SOC 2 Type II",
            "created_at": "2024-07-15T10:30:00+00:00",
            "updated_at": "2024-07-15T10:30:00+00:00"
        }
    ],