CSV report schema
The generated task produces a CSV export with these columns.
Two new fields are available for the export:
Request
Parameters
universe_id*uuidUnique identifier of the universe.
Example: "75ebc096-749e-4b8f-b690-df13daf49c62"name(string (operator))[]Name of the entity.
Example: "eq:fujitsu"alias(string (operator))[]Alternative name, abbreviation, or local brand used to refer to a company or entity.
Example: "ilike:fujitsu"duns(string (operator))[]Duns number of the entity.
Example: "eq:000000000"figi(string (operator))[]FIGI (Financial Instrument Global Identifier) of the entity.
Example: "eq:BBG000BGJWM6"isin(string (operator))[]International Securities Identification Number used to uniquely identify a financial security.
Example: "eq:JP3818000006"ticker(string (operator))[]Stock market ticker symbol used to identify a publicly traded company on an exchange.
Example: "eq:6702.T"lei(string (operator))[]Legal Entity Identifier (LEI) is a 20-character alphanumeric code.
Example: "eq:123400ABCDEFGH56789"entity_id(string (operator))[]SESAMm Unique Entity ID.
Example: "eq:7457a013-9c65-451f-b82d-96d7a22b5cfa"website(string (operator))[]Website of the entity. Protocol is not always present.
Example: "eq:https://www.official-website.com"city(string (operator))[]Name of the city, town, township, village, borough, etc. where the entity is located. Value is in lowercase.
Example: "eq:miami"country(string (enum))[]Country 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...registration_code(string (operator))[]List of registration codes for the entity. Searches on the
Example: "eq:17133723"valuefield.isic4(string (operator))[]International Standard Industrial Classification of All Economic Activities, Revision 4 (ISIC4) codes identifying the entity's primary economic activities.
Example: "eq:Public order and safety activities"industry_code(string (operator))[]Industry classification codes for the entity. Searches on code and description values.
Example: "eq:1811"unspsc(string (operator))[]United Nations Standard Products and Services Codes for the entity. Searches on code and description values.
Example: "eq:51000000"region(string (operator))[]Administrative region or state in which the entity is located. Value is in lowercase.
Example: "eq:florida"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: "eq:F32001976"orderfield:direction[]Order to apply to the result.
Possible fields are:
name.Possible directions are:
Default: [name:asc]Array length: [1, 1]Example: "name:asc"ascanddesc.fields(string (enum))[]Fields to include in the response
Default: ["id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "isic4", "city", "region", "lei", "client_code", "registration_codes_flat", "industry_codes_flat", "unspsc_flat"]Values: "id", "description", "name", "figi", "isin", "ticker", "alias", "website", "country", "isic4", "industry_codes", "unspsc", "city", "region", "lei", "client_code", "registration_codes", "registration_codes_flat", "industry_codes_flat...mappingMap<string, string>Custom label overrides.
Default: {"registration_codes_flat":"registration_codes","industry_codes_flat":"industry_codes","unspsc_flat":"unspsc"}
Response
Error
Bad request
message*stringError message.
Example: "Check the errors field for more details"code*number (enum)Error code.
Values: 400reason*string (enum)Error reason.
Values: "invalid"errorsobject[]Possible error causes.
{
"message": "Check the errors field for more details",
"code": 400,
"reason": "invalid",
"errors": [
{
"message": "string",
"field": "name",
"reason": "invalid_type"
}
]
}Unauthorized
message*stringError message.
Example: "Authorization header is expected"code*number (enum)Error code.
Values: 401reason*string (enum)Error reason.
Values: "unauthorized"errors*object[]Array length: [1, 1]
{
"message": "Authorization header is expected",
"code": 401,
"reason": "unauthorized",
"errors": [
{
"message": "Required",
"field": "headers.authorization",
"reason": "invalid_type"
}
]
}Forbidden
message*stringError message.
Example: "Access to duns is restricted"code*number (enum)Error code.
Values: 403reason*string (enum)Error reason.
Values: "forbidden"
{
"message": "Access to duns is restricted",
"code": 403,
"reason": "forbidden"
}Not found
message*stringError message.
Example: "The requested universe does not exist or is not visible to your company."code*number (enum)Error code.
Values: 404reason*string (enum)Error reason.
Values: "not_found"
{
"message": "The requested universe does not exist or is not visible to your company.",
"code": 404,
"reason": "not_found"
}Too many requests
message*stringError message.
Example: "You already have 5 tasks in progress. Please wait for one to finish before starting a new one."code*number (enum)Error code.
Values: 429reason*string (enum)Error reason.
Values: "too_many_requests"
{
"message": "You already have 5 tasks in progress. Please wait for one to finish before starting a new one.",
"code": 429,
"reason": "too_many_requests"
}Generic errors are not shown, see Errors for more details.