71 lines
No EOL
4.6 KiB
Text
71 lines
No EOL
4.6 KiB
Text
---
|
|
id: list-entities
|
|
title: "List entities"
|
|
description: "List all entities (people, organizations, etc.) known by the bank, ordered by mention count."
|
|
sidebar_label: "List entities"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJzNVttu4zYQ/RVinnYB2bqsk231lqZpm8LZBhu3Dw2CgJbGFjcUqSWpJKqhfy+GkmLZibPbLQo0Lw7E4ZnbOcPZgONrC+k1nCknnEALNwHkaDMjKie0ghTmwjrGpWTYm7A3FepKYsC0WXMl/uJkaQOGLpu+ZXdKPyi2bJgrkC25uiO7HA3m9LEkFK1YpmvlphCArtB4gPMcUpDCutvBEQRQccNLdGgoyA0oXiKkQKi3IocABEVYcVdAAAY/18JgDqkzNQZgswJLDukGXFPRNeuMUGsIwAkn6cMPXN2x8xzaNnjClqIUbkD+XKNpdqBXXNqXsIVyuEYD+9W74I+irEum6nKJhunVtoxOM4OuNspfWvFaOkjjKNrGN/extN+E2d5Q2LbSyqKlQJMoop9dqKs6y9DaVS3Zx94YAsi0cqgcmfOqkiLzDQo/WbqzGSVfGWqf71W6AeGw3P1n7zx/rRnUhwAyrrQSGZe3XT8O258OluwDWbYB9Ny69dx6sTfD3Yuehafesg1gJYx1txbRJ8hV89vKE27XOdGk/6JqKX2NB8ifCIFdEUIbgOT/Em7OR2glOp5zx3fBeJ4LyoLLy1GZO+73sHr5CTP3qqOLAbtt96+NeX8NXm977dmv+QjXD5SGhse5w/KZLrpjRnpnRBf2IFzBbF2W3DQ0F/CRl5X0DNjnBPyqCxLNuGmQRMlsEsWT+GgRR+m7KI2iP0nGNFXi5B3Ojo7fT/C775eTOMnfTfjs6HgyS46P41n8fhZFEew0rYdLJlG8iGdpNMDtUSw+GlWNG8ObMaG9Cr5YVm/1YuFGitwt3nDASp2jZCttugnQ1xNVXmnRjddRGXtVXv/PC3rT0l8AsyR5Pq/+4FLkfhqxM2O0+fZhlaPjQr4yraTOdk6/QsXDoGlvDrNirrsAva7t+rUJd4HW8rUfbZ3JYVNfDLag0y8RjvLqXPd2I+5ty9tV93AaP3ble8nZYPLLYnH5DLDrbYmu0ESkNTr/yrsCUgjv47B/CEN64m246V/6NhztBEKttK/F4Eeo3Ip14Rh5ZCeX588EMxx4qTzZ9+ThmSdPL4ULLLVp2FVjaWzRKBcZkgi3JicVzwpkyZQ4XhsJKRTOVTYNw4eHhyn3x1Nt1mF/14bz89OzD1dnk2QaTQtXSgK+R2O78OJpNI3oU6WtK7ka+Zp3gn5KfievzZb8//Wa1jfZ4aMLK8mF56/PfdO37xru49EmE/gtjUJOt+sajrbMQltHtzabJbf4u5FtS5+7lYtklgvLl3K0dB3M/SuXrBdzuMNmtPXdc1mTjX8i77kRFME/jObNx15tb9khp4OoVDP2OQQz1MuPkQJ5jsaH0J2eZBlW41ifTT2K/UlhP58toG3/BkhS/u4=
|
|
sidebar_class_name: "get api-method"
|
|
info_path: docs/api-reference/endpoints/hindsight-http-api
|
|
custom_edit_url: null
|
|
---
|
|
|
|
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
|
import ParamsDetails from "@theme/ParamsDetails";
|
|
import RequestSchema from "@theme/RequestSchema";
|
|
import StatusCodes from "@theme/StatusCodes";
|
|
import OperationTabs from "@theme/OperationTabs";
|
|
import TabItem from "@theme/TabItem";
|
|
import Heading from "@theme/Heading";
|
|
|
|
<Heading
|
|
as={"h1"}
|
|
className={"openapi__heading"}
|
|
children={"List entities"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/default/banks/{bank_id}/entities"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
List all entities (people, organizations, etc.) known by the bank, ordered by mention count.
|
|
|
|
<Heading
|
|
id={"request"}
|
|
as={"h2"}
|
|
className={"openapi-tabs__heading"}
|
|
children={"Request"}
|
|
>
|
|
</Heading>
|
|
|
|
<ParamsDetails
|
|
parameters={[{"name":"bank_id","in":"path","required":true,"schema":{"type":"string","title":"Bank Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Maximum number of entities to return","default":100,"title":"Limit"},"description":"Maximum number of entities to return"}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"id":{"type":"string","title":"Id"},"canonical_name":{"type":"string","title":"Canonical Name"},"mention_count":{"type":"integer","title":"Mention Count"},"first_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Seen"},"last_seen":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Seen"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"}},"type":"object","required":["id","canonical_name","mention_count"],"title":"EntityListItem","description":"Entity list item with summary.","example":{"canonical_name":"John","first_seen":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","last_seen":"2024-02-01T14:00:00Z","mention_count":15}},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"EntityListResponse","description":"Response model for entity list endpoint.","example":{"items":[{"canonical_name":"John","first_seen":"2024-01-15T10:30:00Z","id":"123e4567-e89b-12d3-a456-426614174000","last_seen":"2024-02-01T14:00:00Z","mention_count":15}]}}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"}}}}}}
|
|
>
|
|
|
|
</StatusCodes>
|
|
|
|
|
|
|