/entity

Main endpoint for interacting with entity metadata.

Table of Contents #

GET /entity #

Gets metadata for a specific entity.

Request

GET /entity
GET /entity/{entityReference}

Parameters

entityReference : A reference to the entity

extras : Provides extra data to each result row. The following values are supported (and can be combined as a comma separated list):

Response

All the metadata available for an entity.

Example: The request https://api.silobreaker.com/entity/11_240886?type=json will return

{
      "EntityReference": "barack-obama-11_240886",
      "Id": "11_240886",
      "Description": "Barack Obama",
      "Type": "Person",
      "LocalizedType": "Person",
      "Extras": {
         "Metadata": {
            "TextFields": [
                  {
                     "Value": "US President",
                     "ValueFormatted": "US President",
                     "Key": "Title"
                  },
                  {
                     "Value": "1961-08-04",
                     "ValueFormatted": "1961-08-04",
                     "Key": "Date of Birth"
                  }
            ],
            "ItemFields": [
                  {
                     "Value": {
                        "EntityReference": "honolulu-11_118141",
                        "Id": "11_118141",
                        "Description": "Honolulu",
                        "Type": "City",
                        "LocalizedType": "City",
                        "LastUpdated": "0001-01-01T00:00:00"
                     },
                     "Key": "Place of Birth"
                  },
                  {
                     "Value": {
                        "EntityReference": "united-states-government-11_329131",
                        "Id": "11_329131",
                        "Description": "United States Government",
                        "Type": "Organization",
                        "LocalizedType": "Organization",
                        "LastUpdated": "0001-01-01T00:00:00"
                     },
                     "Key": "Organization"
                  },
                  {
                     "Value": {
                        "PublicationDate": "2009-07-20T11:23:00Z",
                        "CreatedDate": "2009-07-20T13:22:00Z",
                        "Publisher": "Silobreaker",
                        "Language": "en",
                        "IndexOrder": 109946,
                        "ContributingUserId": 0,
                        "SilobreakerUrl": "https://api.silobreaker.com/5_2262470255601254400",
                        "Id": "5_2262470255601254400",
                        "Description": "Biography for Barack Obama",
                        "Type": "Fact Sheet",
                        "LocalizedType": "Fact Sheet",
                        "LastUpdated": "0001-01-01T00:00:00"
                     },
                     "Key": "Fact Sheet"
                  }
            ],
            "LastUpdated": "0001-01-01T00:00:00"
         },
         "Images": {
            "Items": [
                  {
                     "ImageKey": "4/p/b/4pbru8jyfjvl-_.jpg",
                     "ImageSrc": "https://thumbs-dev.silobreaker.com/w100h100/4/p/b/4pbru8jyfjvl-_.jpg",
                     "ExternalUrl": "http://images.genesis.elucidon.com/GetBlobProperty.aspx?PropertyId=251160",
                     "SourceUrl": "http://obama.senate.gov/about/",
                     "Width": 80,
                     "Height": 100,
                     "Description": "Barack Obama",
                     "Type": "Unknown",
                     "CreationDate": "2010-05-14T12:35:45",
                     "Provider": "Able2Act",
                     "LastUpdated": "0001-01-01T00:00:00"
                  }
            ],
            "LastUpdated": "0001-01-01T00:00:00"
         }
      },
      "LastUpdated": "0001-01-01T00:00:00"
}

GET /entity/add #

Creates a new entity.

Request

GET /entity/add/{parameters}

Parameters

desc : entity description, must be system unique

entityType : See full list of entity types for available types.

lang : Language ISO code i.e sv, en.

Response

Example: The API request entity/add?desc=ObamaMomma&entityType=Person&type=json will produce

{
    "Info": "created",
    "Description": "ObamaMomma",
    "Type": "Person",
    "LastUpdated": "0001-01-01T00:00:00"
}

GET /entity/request #

Sends a request to Silobreaker QA for the addition of an entity.

Request

/entity/request/{parameters}

Parameters

desc : entity description, must be system unique

entityType : Allowed entity types are

comment : comment that will be sent to Silobreaker QA team

lang : Language ISO code i.e sv, en.

Response

Example: The query entity/request?desc=Sextus Quintilius Varus&type=json (father of one of Caesar's murderers) will yield

{
      "Info": "requested",
      "Description": "Sextus Quintilius Varus",
      "LastUpdated": "0001-01-01T00:00:00"
}

Documentation generated by mdoc.