Skip to content
Docs
Follow yggy on LinkedInFollow @yggy_tech on X

Read an organization entity and this project's facts about it

GET
/api/v1/projects/{projectId}/graph/entities/by-identity
 
curl --request GET \
  --url 'https://api.yggy.tech/api/v1/projects/example/graph/entities/by-identity?uri=https%3A%2F%2Fexample.com' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectId
required
string
>= 1 characters

Query Parameters

Section titled “Query Parameters ”
uri
required

Stable identity URI of the organization entity

string format: uri

Stable identity URI of the organization entity

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Entity read

Media type application/json
object
entity
required
object
id
required
string
label
required
string
type
required
string
aliases
required
Array<string>
canonicalId
required
string | null
identity
required
object
uri
required
string | null
namespaceUri
required
string | null
authorityApproved
required
boolean | null
sourceField
required
string | null
sourceValue
required
string | null
homeProjectExternalId
required
string | null
projects
required

Projects the caller can see that hold a fact or literal about the entity (also on the project route)

Array<string>
documents
required
Array<object>
object
documentId
required
string | null
title
required
string | null
facts
required
Array<object>
object
direction
required
string
Allowed values: outgoing incoming
predicate
required
string
status
required
string
Allowed values: ACTIVE CONFLICTING PENDING_ONTOLOGY RETRACTED SOURCE_DELETED SUPERSEDED
projectExternalId
required
string | null
other
required
object
label
required
string
type
required
string
identityUri
required
string | null
literals
required
Array<object>
object
property
required
string
value
required
string
datatype
required
string
Allowed values: BOOLEAN DATE DATE_TIME DECIMAL INTEGER STRING
sourceField
required
string
status
required
string
Allowed values: ACTIVE CONFLICTING PENDING_ONTOLOGY RETRACTED SOURCE_DELETED SUPERSEDED
projectExternalId
required
string
truncated
required

True when a fact or literal list hit the read cap; the read is partial

boolean
Example 
{
  "documents": [
    {
      "facts": [
        {
          "direction": "outgoing",
          "status": "ACTIVE"
        }
      ],
      "literals": [
        {
          "datatype": "BOOLEAN",
          "status": "ACTIVE"
        }
      ]
    }
  ]
}

404

Section titled “404 ”

Entity not found

Media type application/json
object
success
required
boolean
error
required
object
message
required
string
code
required
string
Allowed values: INTERNAL_ERROR VALIDATION_ERROR UNAUTHORIZED RATE_LIMITED ORG_REQUIRED FORBIDDEN NOT_FOUND CONFLICT PROJECT_DENIED USAGE_LIMIT_EXCEEDED HUGINN_ERROR HUGINN_STREAM_ERROR QUERY_FAILED PROVIDER_CONFLICT PROVIDER_CONFIG_INVALID PROVIDER_NOT_CONNECTED PROVIDER_RATE_LIMITED PROJECT_MEMBER_USER_NOT_IN_ORG PROJECT_MEMBER_UNKNOWN_ROLE PROJECT_MEMBER_LAST_OWNER PROJECT_CONFLICT STORAGE_NOT_CONFIGURED BILLING_NOT_CONFIGURED LICENSE_INACTIVE PLAN_REQUIRED MEMBER_LIMIT_REACHED SAGA_ASK_QUOTA_EXCEEDED SAGA_ASK_RATE_LIMITED SAGA_ASK_BUSY SAGA_ASK_PAUSED SAGA_ASK_UPSTREAM SAGA_DICTATION_BUSY SAGA_DICTATION_UNAVAILABLE SAGA_SHARE_LINK_LIMIT PROJECT_MEMBERSHIP_JWT_TOO_LARGE WEBHOOK_URL_INVALID WEBHOOK_ADDRESS_BLOCKED WEBHOOK_EVENT_UNKNOWN WEBHOOK_ENDPOINT_LIMIT WEBHOOK_ENDPOINT_DISABLED WEBHOOK_DELIVERY_IN_PROGRESS ORG_KEY_PERSONAL_SCOPE API_KEY_PERMISSION_EXCEEDS_ROLE API_KEY_NO_PERMISSIONS ORG_KEY_GRAPH_SCOPE_UNAVAILABLE ORG_KEY_TOO_MANY_PROJECTS SENDER_IS_LOGIN_EMAIL SENDER_TAKEN
details
Example 
{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR"
  }
}