メインコンテンツへスキップ
GET
/
api
/
publicapi
/
v1
/
catalogs
/
{catalogId}
/
search
指定したプレフィックスでフィルタリングしたカタログレコードを返します
curl --request GET \
  --url https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://vantage-us.abbyy.com/api/publicapi/v1/catalogs/{catalogId}/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "catalogInfo": {
    "columns": [
      {
        "name": "<string>",
        "notEmpty": true,
        "isPredefined": true,
        "order": 123,
        "title": "<string>"
      }
    ],
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "importFileName": "<string>",
    "lastRecordsUpdateTime": "<string>",
    "recordsCount": 123,
    "usedInSkills": [
      {
        "skillId": "<string>",
        "version": 123
      }
    ]
  },
  "records": [
    {
      "externalId": "<string>",
      "columnValues": {}
    }
  ]
}
{
"detail": "<string>",
"instance": "<string>",
"status": "<string>",
"title": "<string>",
"type": "<string>"
}

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

catalogId
string
必須

カタログID

クエリパラメータ

prefix
string

プレフィックスの値。最小長は 2 文字です。

Minimum string length: 2
Limit
integer<int32>

レスポンスで返されるレコードの最大数。 レスポンスで返すレコード数の上限。

Offset
integer<int32>

ページング用のオフセットです。結果セットの取得を開始する前にスキップするレコード数を指定します。 ページネーションに使用するオフセットです。結果セットの取得を開始する前にスキップするレコード数を指定します。

レスポンス

OK

カタログ検索操作の結果を表します。

catalogInfo
object

「Catalog」タイプのデータセットプロファイルに関する追加情報

records
object[] | null

検索条件に一致するカタログレコードの一覧。