CRUD (Buat, Baca, Perbarui, Hapus)

API Administrasi IIS menyediakan akses langsung ke sumber daya pada sistem. Banyak dari sumber daya ini memungkinkan operasi buat, baca, perbarui, dan hapus. REST API memetakan operasi CRUD ke metode HTTP. Tabel berikut menentukan metode HTTP mana yang dipetakan ke operasi mana.

Buat (POST)

Sumber daya dibuat dengan mengirim permintaan HTTP POST ke API. Jenis sumber daya ditentukan oleh URL permintaan. Isi permintaan harus berisi objek JSON yang menjelaskan sumber daya yang akan dibuat. Objek dalam isi permintaan menentukan status awal sumber daya akan menjadi saat dibuat. Beberapa sumber daya memerlukan properti tertentu disediakan ketika dibuat, yang lain dapat dibuat dengan objek JSON kosong.

Membuat sumber daya saat mengatur properti nama. POST

{
    "name": "Example Resource Name"
}

Membuat sumber daya milik orang lain

Terkadang sumber daya dibuat yang dimaksudkan untuk milik sumber daya lain. Misalnya, jika aplikasi harus milik situs web dan seseorang ingin membuat aplikasi baru maka mereka akan menentukan hubungan tersebut selama pembuatan aplikasi seperti yang ditunjukkan di bawah ini.

Membuat aplikasi untuk situs web. POST

{
    "path": "/MyApp",
    "physical_path": "c:/sites/mysite/myapp",
    "website": {
        "id": {website_id}
    }
}

Baca (GET)

Sumber daya diambil dengan melakukan permintaan HTTP GET. Ada dua metode utama untuk mengambil sumber daya. Metode pertama melibatkan permintaan daftar sumber daya, metode kedua adalah ketika satu sumber daya diminta. Permintaan ke satu sumber daya ditandai dengan adanya id sumber daya di URL permintaan. Terkadang, sumber daya tunggal juga dapat ditentukan melalui paremeter string kueri di URL. Perilaku ini tergantung pada titik akhir API individual.

Mengambil beberapa sumber daya

Membaca daftar sumber daya dilakukan dengan meminta titik akhir sumber daya tanpa menentukan sumber daya individual id. Terkadang sumber daya memerlukan parameter string kueri atau tidak, sumber daya tidak dapat menghasilkan daftar yang valid. Misalnya aplikasi IIS hidup di titik akhir /api/webserver/webapps, tetapi meminta titik akhir itu saja tidak akan menghasilkan informasi. Ini karena situs web harus ditentukan untuk memberi tahu API aplikasi mana yang harus ditampilkan. Jadi konsumen akan meminta /api/webserver/webapps?website.id={website_id} untuk melihat daftar aplikasi.

Mengambil daftar sumber daya. GET/api/websites

{
    "websites": [
        {
            "name": "Default Web Site",
            "id": "{id}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id}"
                }
            }
        },
        {
            "name": "My Site",
            "id": "{id_1}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id_1}"
                }
            }
        }
        {
            "name": "docs",
            "id": "{id_2}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id_2}"
                }
            }
        }
    ]
}

Mengambil sumber daya individual

Sumber daya diambil secara individual dengan memberikan id sumber daya di URL titik akhir sumber daya. Beberapa titik akhir API juga memungkinkan menentukan sumber daya individual dengan menyediakan mengidentifikasi parameter string kueri secara unik. Misalnya, file dapat diambil dengan memberikan id file di URL atau dengan menyediakan physical_path file.

Sumber daya file memungkinkan beberapa metode untuk mengambil file individual:

• /api/files/{id}
• /api/files?physical_path={jalur fisik file}

Titik akhir file menyediakan perilaku ini karena hanya satu file yang dapat ada untuk jalur fisik tertentu, sehingga merupakan secara unik mengidentifikasi parameter string kueri.

Pembaruan (PATCH / PUT)

Pembaruan dilakukan dengan mengeluarkan permintaan HTTP PATCH ke URL tempat sumber daya berada. Ketika permintaan PATCH dilakukan, properti isi permintaan dibaca, dan jika sumber daya memiliki properti dengan nama yang sama, properti sumber daya akan diatur ke nilai baru.

Contoh sumber daya sebelum PATCH

{
    "name": "My Site",
    "id": "12345",
    "physical_path": "c:\\sites\\mysite"
    "_links": {
        "self": {
            "href": "/api/webserver/websites/{12345}"
        }
    }
}

Melakukan permintaan PATCH

Permintaan patch untuk memperbarui nama sumber daya. PATCH/api/webserver/websites/12345

{
    "name": "My Site 2"
}

Sumber daya setelah PATCH

{
    "name": "My Site 2",
    "id": "12345",
    "physical_path": "c:\\sites\\mysite"
    "_links": {
        "self": {
            "href": "/api/webserver/websites/{12345}"
        }
    }
}

Hapus (HAPUS)

Sumber daya dihapus dengan mengirim permintaan HTTP DELETE ke URL tempat sumber daya berada. Ini adalah URL yang berisi id sumber daya.