Przejdź do treści

Read Knowledge Base Entries

Pobranie wszystkich artykułów z bazy wiedzy

GET /knowledge_base_entry

Query Parameters

Możliwe parametry w URL:

Parametr Domyślnie Przykład Opis
limit 100 1000 Limit pobranych rekordów
offset 0 2 Od którego rekordu
sort NULL name Parametr do sortowania
dir NULL asc Kierunek sortowania
filter NULL [{"property": "project_id_list", "value": "[54, 22, 13]"}] Filtrowanie po parametrach

Dostępne opcje dla parametru sort:

  • asc: sortowanie rosnące
  • desc: sortowanie malejące

Dostępne property dla parametru filter:

  • active
  • project_id_list
  • team_id_list
  • user_id_list

Opis pól znajdziesz w Knowledge Base Entry

Parametr filter musi być listą obiektów przekształconą w ciąg JSON zakodowany w UTF-8.

Przykład przekształcenia:

encodeURI(JSON.stringify([{"property": "project_id_list", "value": "[54, 22, 13]"}]))

Przekształcona wartość:

%5B%7B%22property%22:%22project_id_list%22,%22value%22:%22%5B54,%2022,%2013%5D%22%7D%5D

Response Body

{
    "data": <LIST<KnowledgeBaseEntry>>
}
Nazwa Rodzaj Opis Zasób
data <KnowledgeBaseEntry> Obiekt KnowledgeBaseEntry

Response Code

Status Opis
200 Pomyślnie obsłużono żądanie
400 Nieprawidłowe dane
404 Nie znaleziono zasobu

Example

curl -X GET \
$CONPEEK_URL/knowledge_base_entry \
-H 'Authorization: '$CONPEEK_KEY \
-H 'Content-Type: application/json'
import requests
import os
from urllib import parse

url = parse.urljoin(os.environ["CONPEEK_URL"], "/knowledge_base_entry")

headers = {
    'Content-Type': "application/json",
    'Authorization': os.environ["CONPEEK_KEY"]
}

response = requests.request("GET", url, headers=headers)
print(response.text)
<?php
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/knowledge_base_entry",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: ".getenv("CONPEEK_KEY"),
        "Content-Type: application/json"
    ),
));

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

curl_close($curl);

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