An error occured. Details Hide
You have unsaved pages. Restore Cancel

Dimension details (filtered)

Lists out the given dataset's dimension details. 

Input

All Dimension members will be listed out. The post can be used when advanced filters are required to determine whether observation data is present between a given date range and for a list of frequencies. The date filters (i.e start date,end date) will set the HasData flag depending on whether or not data is present for the given condition.

If start date and end date is not given data from all time ranges will be considered. By default if not frequency is given, all frequencies will be considered.

NameType Description 
DimensionsArray[DimensionFilter] List of dimensions to be filtered on. This field is the same as the above mentioned simple request. 
DimensionFilter contains 
  1. DimensionId: Unique dimension id.
  2. Members: It is an array of integers which contain dimension member keys.
StartDateDate StartDate of observation values(only changes HasData field to false. It provides all data as output)
EndDateDate EndDate of observation values(only changes HasData field to false. It provides all data as output)
FrequencyArray[char] Array of required Frequencies. values can be 'A' -Annual ,'Q' -Quarterly, 'M' -Monthly ,'W' -Weekly
 

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.
 
Post: http://data.gov.om/api/1.0/meta/dataset/OMINF2016/dimension/periodic-release
{
   "DimensionRequest": [
      {
         "DimensionId": "region",
         "Members": [
            1000000
         ]
      },
      {
         "DimensionId": "indicator",
         "Members": [
            1000010
         ]
      }
   ],
   "Frequency": [
      "A"
   ],
   "StartDate": "01/01/2002",
   "EndDate": "01/01/2012"
}
  
Output:
{
   "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":false,
         "fields":{
            "id":"17166703"
         }
      },
      {
         "key":1000020,
         "name":"Weekly",
         "level":0,
         "hasData":false,
         "fields":{
            "id":"17166713"
         }
      },
      {
         "key":1000030,
         "name":"Semimonthly",
         "level":0,
         "hasData":false,
         "fields":{
            "id":"17166723"
         }
      },
      {
         "key":1000040,
         "name":"Monthly",
         "level":0,
         "hasData":false,
         "fields":{
            "id":"17166733"
         }
      },
      {
         "key":1000050,
         "name":"Bimonthly",
         "level":0,
         "hasData":false,
         "fields":{
            "id":"17166743"
         }
      },
      {
         "key":1000060,
         "name":"Quarterly",
         "level":0,
         "hasData":false,
         "fields":{
            "id":"17166753"
         }
      },
      {
         "key":1000070,
         "name":"Biannual",
         "level":0,
         "hasData":false,
         "fields":{
            "id":"17166763"
         }
      },
      {
         "key":1000080,
         "name":"Annual",
         "level":0,
         "hasData":false,
         "fields":{
            "id":"17166773"
         }
      }
   ],
   "groups":[
 
   ]
}