POST - Query API

Genel Bakış

Sorgu API'si, filtreleme ve sıralama yetenekleriyle nesneleri aramak için kullanılan API'dir. Bu, TheHive 4 tarafından tanıtılan ve yeni veri modeli için optimize edilmiş bir API'dir.

TheHive, önceden tanımlanmış arama Sorguları listesiyle birlikte gelir:

Sorgu API isteğinin gövdesi aşağıdaki alanlara sahip bir nesne olmalıdır:

query required: farklı türlerde işlemlerden oluşan bir dizi:

excludeFields isteğe bağlı: alan adlarından oluşan bir dizi.

Örnekler

{
    "query": [
        {
            "_name": "listOrganisation"
        }
    ]
}
  • Filtreli liste:
{
    "query": [
        {
            "_name": "listOrganisation"
        },
        {
            "_name": "filter",
            "_eq": {
                "_field": "name",
                "_value": "admin"
            }
        }
    ]
}

Admin adı verilen organizasyonları listeler, yükselen _updatedAt değerine göre sıralanır, ilk 15 öğeyi görüntülemek için sayfalandırılır.

{
    "query": [
        {
            "_name": "listOrganisation"
        },
        {
            "_name": "filter",
            "_eq": {
                "_field": "name",
                "_value": "admin"
            }
        },
        {
            "_name": "sort",
            "_fields": [
                {
                    "_updatedAt": "asc"
                }
            ]
        },
        {
            "_name": "page",
            "from": 0,
            "to": 15
        }
    ]
}

Kimliği ~1234 olan vaka için gözlemlenebilirleri listeleyin

{
    "query": [
        {
            "_name": "getCase",
            "idOrName": "~1234"
        },
        {
            "_name": "observables"
        },
        {
            "_name": "page",
            "from": 0,
            "to": 15
        }
    ]
}
  • Alanları hariç tutun:
{
    "query": [
      {
        "_name": "listCase"
      }
    ],
    "excludeFields": ["description", "summary"]
}

Filtreler

Mevcut filtreler:

Sıralama

Kullanım: {"_name": "sort", "fields": [ {"<field>": "<direction>" }, ... ]}

Yön(direction), asc veya desc olabilir.

Sayfalama ve Ek Veriler

Basit sayfalama: {"_name": "page", "from": 0, "to": 30}

Nesne ile ek veri iste: {"_name": "page", "from": 0, "to": 30, "extraData": ["shareCount", "contributors"] }

Nesnenin extraData alanı, seçilen alanları içeren bir JSON nesnesini içerecektir. Kullanılabilir ek veriler, istenen varlığa bağlıdır.

resim.png

Yanıtlar

resim.png


resim.png


Revision #6
Created 14 April 2024 09:18:27 by Güldeniz Akca
Updated 14 April 2024 21:34:55 by Güldeniz Akca