Get the detailed information of the dataset queried.

GET {{baseUrl}}/v1/dataset/ip/:name

What

Get the detailed information of the dataset queried by the name. A dataset is a collection of different data sources that are related to a specific topic. The name of the dataset describes the specific topic.

Parameters

The endpoint accepts only the following parameter in the path: - name: (Mandatory) The code name that identifies uniquely the dataset in the platform. It must be composed of uppercase letters, numbers and underscores.

Result

The result is a JSON object with the following fields: - self: the URI to individual dataset information. - type: what type of dataset is this. The only allowed value is ip. - name: the name of the dataset in human readable form. - description: a human readable long description of the dataset. - status: the status of the dataset. The only allowed value is ENABLED. - items: the number of 'live' items in the dataset when the request is performed.

Errors

  • a 404 Not Found error if the dataset code name was not found.
  • a 422 Unprocessable Entity error if dataset code name does not follow the naming convention.

It will also return the API Global errors described in the API description.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"self":"adipisicing voluptate","type":"ip","name":"nisi irure aliquip ut","description":"qui nisi est tempor in","status":"DISABLED","items":72455697}