Dokümanlar / Uç Noktalar

Yükümlülük Arama

GET /api/v1/obligations/search

Bu sayfada

Yükümlülük Arama
Filtre kategorileri
Sıralama
Yanıt şeması
Sayfalama
Yaygın kullanım örnekleri

Yükümlülük Arama

Tüm dokümanların yükümlülükleri üzerinde filtreli arama yapar. /library/{id}/obligations belirli bir doküman için döner; bu uç nokta tüm katalogda "ödeme kuruluşları için son tarihi 2026 sonuna kadar olan yüksek ciddiyetli yükümlülükler" gibi sorgulara yanıt verir.

Filtre kategorileri

Etiket (tamsayı dizisi): institutionTypes, departments, topics — InstitutionType, DepartmentType, TopicType enum sayı değerleri. Aynı parametreyi tekrar ederek çoklu değer gönderin (?topics=1&topics=8).
Aksiyon (string dizisi): actionTypes — enum isimleri (Report, Implement, Prohibit, Document, FileRecord, Train, UpdatePolicy, NotifyCustomer, Other).
Risk (string): severityMin — yükümlülüğün ciddiyeti bu seviyeye eşit veya üzerinde olanları döner. Değerler: Low, Medium, High, Critical.
Zaman (ISO 8601 tarih): deadlineAfter, deadlineBefore, publicationAfter, publicationBefore. hasDeadline=true parametresi sadece son tarihi tanımlı olanları getirir.
Metin (string): searchText — başlık ve açıklama üzerinde serbest metin araması.

Tam enum değer-isim eşlemesi için Enum Referansı sayfasına bakın.

Yukarıda sayılmayan bir query parametresi gönderirseniz istek 400 ile reddedilmez; tanınmayan ad sessizce yok sayılır ve o filtre hiç uygulanmadan sonuç dönersiniz (diğer geçerli filtreleriniz çalışmaya devam eder). Filtre adlarını birebir yazdığınızdan emin olun.

Sıralama

sort parametresi artan sıralama için yalnızca alan adını alır (deadline), azalan sıralama için alan desc biçimindedir (deadline desc). Desteklenen alanlar: deadline, severity, title. Varsayılan deadline (artan).

asc eki desteklenmez ve tanınmayan bir sort değeri varsayılana düşmez: sort=deadline asc sessizce kayıt oluşturma tarihine göre azalan (en yeni önce) sıralamaya düşer — parametreyi hiç göndermemekle aynı sonucu vermez. Artan sıralama istiyorsanız eki hiç yazmayın.

Yanıt şeması

Yanıt özet şemadır: id, documentId, ordinal, title, sourceReference, actionType, severity, deadlineDate, deadlineKind, deadlineRawText, departmentIds. Tam yükümlülük detayı (açıklama, ceza, kaynak alıntısı, tüm etiketler) için /api/v1/obligations/{id} ile id takibi yapın.

Sayfalama

pageSize 1-100 arası (varsayılan 20)
Filtresiz sayfalama katalogun tamamını taramak için kullanılmamalıdır — büyük tenant kullanımı 429 QUOTA_EXCEEDED ile geri döner

Yaygın kullanım örnekleri

"Ödeme kuruluşları için Q4'te dolacak yükümlülükler" → ?institutionTypes=8&deadlineAfter=2026-10-01&deadlineBefore=2026-12-31
"AML konusunda kritik tüm yükümlülükler" → ?topics=1&severityMin=Critical
"Uyum departmanını ilgilendiren raporlama" → ?departments=1&actionTypes=Report
"Yaklaşan rapor yükümlülükleri" → ?actionTypes=Report&hasDeadline=true&sort=deadline

Parametreler

İsim	Konum	Tip	Zorunlu	Açıklama
`institutionTypes`	Query	`integer[]`	Hayır	Kurum tipi etiketleri — InstitutionType enum sayı değeri dizisi (1-22). Çoklu değer için aynı parametreyi tekrar edin (?institutionTypes=1&institutionTypes=8).
`departments`	Query	`integer[]`	Hayır	Departman etiketleri — DepartmentType enum sayı değeri dizisi (1-24).
`topics`	Query	`integer[]`	Hayır	Konu etiketleri — TopicType enum sayı değeri dizisi (1-25).
`actionTypes`	Query	`string[]`	Hayır	Yükümlülük aksiyon tipi enum isimleri: Report, Implement, Prohibit, Document, FileRecord, Train, UpdatePolicy, NotifyCustomer, Other.
`severityMin`	Query	`string`	Hayır	Asgari ciddiyet seviyesi: Low, Medium, High, Critical. Bu seviye ve üzerini döner.
`deadlineAfter`	Query	`date`	Hayır	Son tarihi bu tarihten sonraki yükümlülükler (ISO 8601, sadece tarih).
`deadlineBefore`	Query	`date`	Hayır	Son tarihi bu tarihten önceki yükümlülükler (ISO 8601, sadece tarih).
`hasDeadline`	Query	`boolean`	Hayır	true: sadece son tarihi tanımlı yükümlülükler.
`publicationAfter`	Query	`date`	Hayır	Yayın tarihi alt sınırı.
`publicationBefore`	Query	`date`	Hayır	Yayın tarihi üst sınırı.
`searchText`	Query	`string`	Hayır	Başlık ve açıklamada serbest metin araması.
`sort`	Query	`string`	Hayır	Sıralama. Artan sıralama için yalnızca alan adını yazın ('deadline', 'severity', 'title'); azalan için 'alan desc' biçimini kullanın (örn. 'deadline desc'). Parametre hiç gönderilmezse varsayılan 'deadline' (artan). 'asc' eki desteklenmez: 'deadline asc' tanınmaz ve sonuçlar son tarihe göre değil, kayıt oluşturma tarihine göre AZALAN sıralanır — yani parametreyi hiç göndermemekle aynı şey değildir.
`page`	Query	`integer`	Hayır	Sayfa numarası.
`pageSize`	Query	`integer`	Hayır	1-100; varsayılan 20.

Yanıtlar

200 — Filtrelenmiş yükümlülükler — özet şema (id, başlık, kaynak referansı, aksiyon, ciddiyet, son tarih).

⚠️ Sunucudan sunucuya — API anahtarınızı tarayıcıda paylaşmayın. Neden?

curl -X GET \
  "https://api.regvion.com/api/v1/obligations/search" \
  -H "X-API-Key: rgv_live_REPLACE_WITH_YOUR_KEY"

const url = 'https://api.regvion.com/api/v1/obligations/search';
const headers = {
  'X-API-Key': 'rgv_live_REPLACE_WITH_YOUR_KEY'
};

const response = await fetch(url, {
  method: 'GET',
  headers,
});

if (!response.ok) throw new Error(`HTTP ${response.status}`);
const body = await response.json();
console.log(body.data);
console.log('Request ID:', body.meta.requestId);

import requests

url = "https://api.regvion.com/api/v1/obligations/search"
headers = {"X-API-Key": "rgv_live_REPLACE_WITH_YOUR_KEY"}
params = {"institutionTypes": "1", "departments": "1", "topics": "1", "actionTypes": "Report", "severityMin": "High", "deadlineAfter": "2026-04-01", "deadlineBefore": "2026-12-31", "hasDeadline": "true", "publicationAfter": "value", "publicationBefore": "value", "searchText": "müşteri tanıma", "sort": "deadline", "page": "1", "pageSize": "20"}
response = requests.get(url, headers=headers, params=params)
response.raise_for_status()
body = response.json()
print(body["data"])
print("Request ID:", body["meta"]["requestId"])

using System.Net.Http;
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY");

var response = await client.GetAsync("https://api.regvion.com/api/v1/obligations/search");
response.EnsureSuccessStatusCode();
var body = await response.Content.ReadFromJsonAsync<JsonElement>();
Console.WriteLine(body.GetProperty("meta").GetProperty("requestId").GetString());

<?php
require 'vendor/autoload.php';

$client = new GuzzleHttp\Client();

$options = [
    'headers' => [
        'X-API-Key' => 'rgv_live_REPLACE_WITH_YOUR_KEY',
    ],
];

$response = $client->request('GET', 'https://api.regvion.com/api/v1/obligations/search', $options);
$body = json_decode($response->getBody(), true);
echo 'Request ID: ' . $body['meta']['requestId'];

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();

HttpRequest.Builder b = HttpRequest.newBuilder()
    .uri(URI.create("https://api.regvion.com/api/v1/obligations/search"))
    .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
    .GET();

HttpResponse<String> response = client.send(b.build(), HttpResponse.BodyHandlers.ofString());
System.out.println("Status: " + response.statusCode());
System.out.println(response.body());

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.regvion.com/api/v1/obligations/search", nil)
    req.Header.Set("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")

    resp, err := http.DefaultClient.Do(req)
    if err != nil { panic(err) }
    defer resp.Body.Close()

    var envelope struct {
        Data interface{} `json:"data"`
        Meta struct { RequestId string `json:"requestId"` } `json:"meta"`
    }
    json.NewDecoder(resp.Body).Decode(&envelope)
    fmt.Println("Request ID:", envelope.Meta.RequestId)
}

require 'net/http'
require 'json'
require 'uri'

uri = URI('https://api.regvion.com/api/v1/obligations/search')
request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'rgv_live_REPLACE_WITH_YOUR_KEY'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

body = JSON.parse(response.body)
puts "Request ID: #{body['meta']['requestId']}"

import okhttp3.*
import okhttp3.MediaType.Companion.toMediaType
import okhttp3.RequestBody.Companion.toRequestBody

val client = OkHttpClient()

val builder = Request.Builder()
    .url("https://api.regvion.com/api/v1/obligations/search")
    .addHeader("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")

client.newCall(builder.build()).execute().use { response ->
    println("Status: ${'$'}{response.code}")
    println(response.body?.string())
}

import Foundation

var request = URLRequest(url: URL(string: "https://api.regvion.com/api/v1/obligations/search")!)
request.httpMethod = "GET"
request.setValue("rgv_live_REPLACE_WITH_YOUR_KEY", forHTTPHeaderField: "X-API-Key")

let (data, response) = try await URLSession.shared.data(for: request)
if let http = response as? HTTPURLResponse { print("Status: \(http.statusCode)") }
print(String(data: data, encoding: .utf8) ?? "")

use reqwest::blocking::Client;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let mut req = client.get("https://api.regvion.com/api/v1/obligations/search")
        .header("X-API-Key", "rgv_live_REPLACE_WITH_YOUR_KEY")
        ;
    let res = req.send()?;
    println!("Status: {}", res.status());
    println!("{}", res.text()?);
    Ok(())
}

$headers = @{
    'X-API-Key' = 'rgv_live_REPLACE_WITH_YOUR_KEY'
}

$response = Invoke-RestMethod -Uri 'https://api.regvion.com/api/v1/obligations/search' -Method Get -Headers $headers

$response.data
Write-Host "Request ID:" $response.meta.requestId