Universes Management

Get Universe Entities

ListExport

Trigger asynchronous export of entities for one universe

POST
https://api.textreveal.com/v3/universes/{universe_id}/entities/export

Request

Parameters

  • universe_id*uuid

    Unique identifier of the universe.

  • name(string (operator))[]

    Name of the entity.

    Example: "ilike:hello"
  • alias(string (operator))[]

    Alternative name, abbreviation, or local brand used to refer to a company or entity.

    Example: "ilike:hello"
  • duns(string (operator))[]

    Duns number of the entity.

    Example: "ilike:hello"
  • figi(string (operator))[]

    FIGI (Financial Instrument Global Identifier) of the entity.

    Example: "ilike:hello"
  • isin(string (operator))[]

    International Securities Identification Number used to uniquely identify a financial security.

    Example: "ilike:hello"
  • ticker(string (operator))[]

    Stock market ticker symbol used to identify a publicly traded company on an exchange.

    Example: "ilike:hello"
  • lei(string (operator))[]

    Legal Entity Identifier (LEI) is a 20-character alphanumeric code.

    Example: "ilike:hello"
  • entity_id(string (operator))[]

    SESAMm Unique Entity ID.

    Example: "eq:hello"
  • website(string (operator))[]

    Website of the entity. Protocol is not always present.

    Example: "ilike:hello"
  • country(string (enum))[]

    County of the entity.

    Values: "afghanistan", "aland islands", "albania", "algeria", "american samoa", "andorra", "angola", "anguilla", "antarctica", "antigua and barbuda", "argentina", "armenia", "aruba", "australia", "austria", "azerbaijan", "bahamas", "bahrain... 
  • client_code(string (operator))[]

    Custom entity identifiers to make it easier to link SESAMm entities with external Knowledge Graphs / client systems. The client code are isolated between the SESAMm company model and are not visible to other client.

    To add yours to the entities of your universe, contact your account manager.

    Example: "ilike:hello"
  • orderfield:direction

    Order to apply to the result.

    Possible fields are: name.

    Possible directions are: asc and desc.

    Default: name:ascExample: "name:asc"
  • fields(string (enum))[]

    Fields to include in the response

    Default: ["id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "lei"]Values: "id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "lei"

Response

Response - 200

Starts export of entities

  • task_id*uuid

    Unique identifier of the task

    Example: "f47ac10b-58cc-4372-a567-0e02b2c3d479"
Response
{
  "task_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}

Error

Error - 400

Bad request

  • message*string

    Error message.

    Example: "Check the errors field for more details"
  • code*number (enum)

    Error code.

    Values: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid"
  • errorsobject[]

    Possible error causes.

Response
{
  "message": "Check the errors field for more details",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "string",
      "field": "name",
      "reason": "invalid_type"
    }
  ]
}

Error - 403

Forbidden

  • message*string

    Error message.

    Example: "Access to ungc_classification is restricted"
  • code*number (enum)

    Error code.

    Values: 403
  • reason*string (enum)

    Error reason.

    Values: "forbidden"
Response
{
  "message": "Access to ungc_classification is restricted",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

Not found

  • message*string

    Error message.

    Example: "The requested universe does not exist or is not visible to your company."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)

    Error reason.

    Values: "not_found"
Response
{
  "message": "The requested universe does not exist or is not visible to your company.",
  "code": 404,
  "reason": "not_found"
}

Error - 429

Too many requests

  • message*string

    Error message.

    Example: "You have too many exports in progress. Maximum allowed: 5."
  • code*number (enum)

    Error code.

    Values: 429
  • reason*string (enum)

    Error reason.

    Values: "too_many_requests"
Response
{
  "message": "You have too many exports in progress. Maximum allowed: 5.",
  "code": 429,
  "reason": "too_many_requests"
}

Generic errors are not shown, see Errors for more details.