Get dataset details

Gets the details for a dataset.

Input

Endpoint

GET /orgs/:organisation/datasets/:dataset

Field	Type	Required	Value Description
organisation	String	yes	The organisation name
dataset	String	yes	The dataset name

Request

curl -X GET \
     -H "Authorization: token my-org-api-token" \
     -H "Accept: application/vnd.visii.v2+json" \
     "https://api.visii.com/orgs/my-org/datasets/my-dataset"

Response

Field	Type	Value Description
status	String	The status of the response
dataset	Object	The details of the dataset
dataset.browse_token	String	The authorization token needed when accessing this dataset via the Vision API.
		This token is different from Organisation Token to allow client-side requests with a read-only token.
dataset.content_url	String	The URL for the content of the dataset. This is used to add new content.
dataset.name	String	The dataset name
dataset.processing_errors_url	String	The URL for the outstanding processing errors
dataset.settings	Object	The dataset settings
dataset.settings.fields	Object	The list of array fields and values enabled for querying. For more information check fields page
dataset.status	String	The current status of the dataset. Possible values are pending and published.

HTTP/1.1 200 OK
{
  "dataset": {
    "browse_token": "abcdefghijklmnopqrstuvwxyz123456789",
    "content_url": "https://api.visii.com/my-org/datasets/my-dataset/content",
    "name": "my-dataset",
    "processing_errors_url": "https://api.visii.com/orgs/my-org/datasets/my-dataset/errors",
    "settings": {
      "fields": {
        "arrayField": ["specific", "values", "to", "enable"],
        "arrayNumField": ["*"]
      },
      "version":1
    },
    "status": "published"
  },
  "status": "ok"
}