Dimension Details

Endpoint: http://data.gov.om/api/1.0/meta/dataset/<datasetId>/dimension/<dimensionId>

Lists out the given dataset's dimension details. 

Input: Required on both GET and POST requests

NameTypeDescription
DatasetIdStringUnique identifier for dataset.
DimensionIdStringUnique Identifier for dimension.

Input: GET

With input as datasetId and dimensionId from the url we obtain a list of all dimension details.

Result:

The Result contains all dimension details.

Name Type Description 
Key Int Dimension key 
Id String Unique dimension code 
Name String Dimension name 
Description String Dimension details 
isGeoboolSpecifies whether geographical dimension
datasetIdstringUnique identifier for the dataset
datasetTypestringEnumerator specifies whether dataset is type of 0 - "Reguler",  1 - "Virtual" and 2 - "Flat"
fieldsstring

List of Dimension metadata fields
1. Key: key of metadat
2. Name: Name of metadata
3. Type: Type of metadata can be of
Boolean=0,
Integer=1,
Float=2,
Double=3,
DateTime=4,
Char=5,
String =6

Members DimensionMember List of members in the dimension(Contains all members).The data is ordered according to hierarchy first and then by name. 
eg:world data with level 0 will be followed by asia data at level 1. India will be listed next with level as 2. 
Europe is listed next with level 1 so on. 
Each DimensionMember contains : 
  1. Key: Key of the dimension member .
  2. Name: Dimension member name.
  3. Level: Level of the member in the Heirarchy.
  4. HasData: Indicates whether or not Timeseries data is present for this dimension member.
Groups DimensionGroup List of dimension groups present for the respective dimension member. 
  1. Key: Dimensiongroup unique Key.
  2. Name: Dimension group name.
 
GET: http://data.gov.om/api/1.0/meta/dataset/OMINF2016/dimension/periodic-release
{
  "key": 2481430,
  "id": "periodic-release",
  "name": "Periodic release",
  "isGeo": false,
  "datasetId": "OMINF2016",
  "datasetType": 0,
  "fields": [
    {
      "key": 3229950,
      "name": "id",
      "displayName": "Id",
      "type": 6,
      "locale": null,
      "baseKey": null,
      "isSystemField": true
    },
    {
      "key": 3438860,
      "name": "اسم",
      "displayName": "اسم",
      "type": 6,
      "locale": null,
      "baseKey": null,
      "isSystemField": false
    }
  ],
  "items": [
    {
      "key": 1000000,
      "name": "Total",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166693"
      }
    },
    {
      "key": 1000010,
      "name": "Daily",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166703"
      }
    },
    {
      "key": 1000020,
      "name": "Weekly",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166713"
      }
    },
    {
      "key": 1000030,
      "name": "Semimonthly",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166723"
      }
    },
    {
      "key": 1000040,
      "name": "Monthly",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166733"
      }
    },
    {
      "key": 1000050,
      "name": "Bimonthly",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166743"
      }
    },
    {
      "key": 1000060,
      "name": "Quarterly",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166753"
      }
    },
    {
      "key": 1000070,
      "name": "Biannual",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166763"
      }
    },
    {
      "key": 1000080,
      "name": "Annual",
      "level": 0,
      "hasData": true,
      "fields": {
        "id": "17166773"
      }
    }
  ],
  "groups": []
}