71 lines
No EOL
4.6 KiB
Text
71 lines
No EOL
4.6 KiB
Text
---
|
|
id: get-entity
|
|
title: "Get entity details"
|
|
description: "Get detailed information about an entity including observations (mental model)."
|
|
sidebar_label: "Get entity details"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: eJy9Vl1v2zYU/SvEfWoB2ZIcJ930lmVelqFpgsbbwwzDoKVrm41EqiTl1BD034tLSbEsz+7QffjFNnl57tc5lyzB8rWBaAYTaYUVaGDuQYIm1iK3QkmI4BYtS9BykWLChFwpnXHaYnypCsu4ZEhnd0zIOC0SIddMLQ3qrbMy7E2G0vKUZSrB9O0QPFA5ard5l0AEa7SLGgE8yLnmGVrUFFQJkmcIESy5fF6IBDwQFFHO7QY80Pi5EBoTiKwu0AMTbzDjEJVgdzkdM1YLuQYPrLApLfzE5TO7S6CqvFfs2vW/gT6py+Dw5wRgciUNGjozCgL6OqzsUxHHaMyqSNnHxhg8iJW0KC2Z8zxPRexK5X8ydKbsxJFrKqRrWlSCSM7FRkF5EHOppIh5uqiTP21/01qyD2RZeUBdFEouYlXUwTVHhbS4Rt05e19bshtnWXmwEtrYhUF0CXC5e1i57h46p540K7JIU6AatpC/EAJ7IoTKg5T/Q7j3vIOWoeUJt/wQjCeJoCx4+tgpc02FBlYtP2Fszzq6b7ErD7qicA2zmJnjPlr8Ys91Zkr7+35gsuD2e+tw32Kwa0ui6GXWFcGsDmzep/vDPqsOhw95fi27E6E/N4awd8y15rtOsg/dmn0rQCfhHsX7vO214Sidn92gO5lJu1EPM7ZSuh1+9YRkKJNcCWlpzOEXnuWpk1lfePCb2kg4VAaMgtF4EISD8HIaBtFFEAXBnzSUaEiGowscX169G+APPy4H4Si5GPDx5dVgPLq6Csfhu3EQBHCgjAZuNAjCaTiOghaup+Pwss/MWdnj1qnAaqa6VNiL0s+GcctulVqnCNW8oo8H49HoePD9wVOR1GSYaK3090+9uuxn5JSq+GD3b8iknWjV/DQx36s6QKdEsz4n2Hs0hq9xz/IzNwgVg01p91tkp7xq141dh8r78tbVPZ1GTfe/dNaa/DqdPh4B1r3N0G5Uc4W7u9tuIAJ/G/oJrniRWp8ubuOXzf1d+di8Mvzy9dqt3L27Uq4urU8hEyPWG8vIO7t+vDtSYrvhNPhq3xCJx45IjdbuMVN6x552xmLm7g8RI6l7b3Kd83iDbDQkERU6hQg21uYm8v2Xl5chd9tDpdd+c9b47+9uJh+eJoPRMBhubJYS8Ba1qcMLh8EwoKVcGZtx2fFF76mDoWH6yZV7NfwHr6+m0aReP0+5cBx2OZdNC2ewDV1MrongufcXRRntH2JtJ2l1/4Sae7BRxhJEWS65wd91WlW0/LlAvYNoNvdgy7XgS2r0rIREGPqdQLTiqcEzlXjzsaH/W3Yqi5blkji+5WlB/8CDZ9x1XpEk9f/R7b46bqBskCeoXe71/nUcY247J4/mH13Zr1q7nUyhqr4CIl/3/g==
|
|
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={"Get entity details"}
|
|
>
|
|
</Heading>
|
|
|
|
<MethodEndpoint
|
|
method={"get"}
|
|
path={"/v1/default/banks/{bank_id}/entities/{entity_id}"}
|
|
context={"endpoint"}
|
|
>
|
|
|
|
</MethodEndpoint>
|
|
|
|
|
|
|
|
Get detailed information about an entity including observations (mental model).
|
|
|
|
<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":"entity_id","in":"path","required":true,"schema":{"type":"string","title":"Entity Id"}}]}
|
|
>
|
|
|
|
</ParamsDetails>
|
|
|
|
<RequestSchema
|
|
title={"Body"}
|
|
body={undefined}
|
|
>
|
|
|
|
</RequestSchema>
|
|
|
|
<StatusCodes
|
|
id={undefined}
|
|
label={undefined}
|
|
responses={{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"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"},"observations":{"items":{"properties":{"text":{"type":"string","title":"Text"},"mentioned_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mentioned At"}},"type":"object","required":["text"],"title":"EntityObservationResponse","description":"An observation about an entity."},"type":"array","title":"Observations"}},"type":"object","required":["id","canonical_name","mention_count","observations"],"title":"EntityDetailResponse","description":"Response model for entity detail endpoint.","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,"observations":[{"mentioned_at":"2024-01-15T10:30:00Z","text":"John works at Google"}]}}}}},"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>
|
|
|
|
|
|
|