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

  • namestring[]

    Name of the entity.

  • aliasstring[]

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

  • dunsstring[]

    Duns number of the entity.

  • figistring[]

    FIGI (Financial Instrument Global Identifier) of the entity.

  • isinstring[]

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

  • tickerstring[]

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

  • leistring[]

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

  • entity_idstring[]

    SESAMm Unique Entity ID.

  • websitestring[]

    Website of the entity. Protocol is not always present.

  • 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: "The server returned an unexpected response"
  • code*integer

    Error code.

    Example: 400
  • reason*string (enum)

    Error reason.

    Values: "invalid", "timeout", "offline", "unknown", "not_found", "unauthorized", "forbidden", "internal", "too_many_requests"
  • errorsobject[]

    Possible error causes, like query params, headers or body.

Response
{
  "message": "The server returned an unexpected response",
  "code": 400,
  "reason": "invalid",
  "errors": [
    {
      "message": "Expected number, received string",
      "field": "size",
      "reason": "invalid_type"
    }
  ]
}

Error - 403

Not authorized

  • message*string
    Example: "Not authorized to access this resource"
  • code*number (enum)

    Error code.

    Values: 403
  • reason*string (enum)
    Values: "forbidden"
Response
{
  "message": "Not authorized to access this resource",
  "code": 403,
  "reason": "forbidden"
}

Error - 404

Not found

  • message*string
    Example: "[record] not found."
  • code*number (enum)

    Error code.

    Values: 404
  • reason*string (enum)
    Values: "not_found"
Response
{
  "message": "[record] not found.",
  "code": 404,
  "reason": "not_found"
}

Error - 429

Too many requests

  • message*string
    Example: "You have too many exports in progress."
  • code*number (enum)
    Values: 429
  • reason*string (enum)
    Values: "too_many_requests"
Response
{
  "message": "You have too many exports in progress.",
  "code": 429,
  "reason": "too_many_requests"
}