Dokümanlar / Uç Noktalar

Doküman Yükümlülükleri

GET /api/v1/documents/{id}/obligations

Bu sayfada

Doküman Yükümlülükleri
Özet vs detay
İzin paylaşımı
404 ne zaman döner

Doküman Yükümlülükleri

Bir dokümandan AI tarafından çıkarılmış yükümlülükleri, dokümandaki orijinal sıralarına (Ordinal) göre döner. Yanıt özet şema ile gelir; başlık, kaynak referansı, aksiyon, ciddiyet ve son tarih için yeterlidir.

Özet vs detay

Tek bir yükümlülüğün tam açıklamasını, kaynak alıntısını, ceza bilgilerini ve etiketlerini istiyorsanız döndürülen id alanını /api/v1/obligations/{id} ile takip edin. Bu uç nokta liste görünümü için optimize edilmiştir.

İzin paylaşımı

Bu uç nokta Api.Library.Browse izniyle çalışır — dokümanı listeleyebilen herkes yükümlülüklerini de görebilir. Tier yapılandırmasında ayrı bir Api.Documents.Obligations izni yoktur.

404 ne zaman döner

Doküman ID'si geçersiz UUID formatında — istek daha yönlendirme (routing) aşamasında reddedilir; gövdesiz bir 404 döner (error.code ve meta.requestId yoktur). İstemcinizin bu yolda JSON ayrıştırmaya çalışmadığından emin olun.
Doküman bulunamadı
Doküman boru hattını henüz tamamlamamış (PipelineStatus != Completed) — bu durum ID'nin var olduğunu sızdırmamak için "bulunamadı" yanıtıyla aynı NOT_FOUND zarfına maskelenir

Parametreler

İsim	Konum	Tip	Zorunlu	Açıklama
`id`	Path	`uuid`	Evet	Doküman ID'si.

Yanıtlar

200 — Yükümlülükler — Ordinal'a göre sıralı, özet şema (id, başlık, kaynak referansı, aksiyon, ciddiyet, son tarih).

404 — Doküman bulunamadı veya henüz boru hattını tamamlamadı.

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

curl -X GET \
  "https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations" \
  -H "X-API-Key: rgv_live_REPLACE_WITH_YOUR_KEY"

const url = 'https://api.regvion.com/api/v1/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations';
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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations"
headers = {"X-API-Key": "rgv_live_REPLACE_WITH_YOUR_KEY"}
response = requests.get(url, headers=headers)
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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations");
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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations', $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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations"))
    .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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations", 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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations')
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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations")
    .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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations")!)
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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations")
        .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/documents/7a3f9e2c-4b8d-11ef-8a3c-0242ac120002/obligations' -Method Get -Headers $headers

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