GET DataMartAvailability/List

Returns a list of DataMart Availability Periods the user has access to that are filterable using OData

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of DataMartAvailabilityPeriodV2DTO
NameDescriptionTypeAdditional information
DataMartID

Gets or sets the Identifier of the DataMart.

globally unique identifier

None.

DataMart

Gets or sets the Name of the DataMart.

string

None.

DataTable

Gets or sets the DataTable the Period Came from.

string

None.

PeriodCategory

Gets or sets the type of Period. Y = Yearly. Q = Quarterly.

string

None.

Period

Gets or sets the raw data outputed from the DataTable.

string

None.

Year

Gets or sets the Year of the Period.

integer

None.

Quarter

Gets or sets the Quarter of the Period if PeriodCategory = Q

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "DataMartID": "e985b22a-11f3-4751-9113-4d08be0ab8ba",
      "DataMart": "sample string 2",
      "DataTable": "sample string 3",
      "PeriodCategory": "sample string 4",
      "Period": "sample string 5",
      "Year": 6,
      "Quarter": 1
    },
    {
      "DataMartID": "e985b22a-11f3-4751-9113-4d08be0ab8ba",
      "DataMart": "sample string 2",
      "DataTable": "sample string 3",
      "PeriodCategory": "sample string 4",
      "Period": "sample string 5",
      "Year": 6,
      "Quarter": 1
    }
  ]
}

text/javascript

Sample:
{"results":[{"DataMartID":"e985b22a-11f3-4751-9113-4d08be0ab8ba","DataMart":"sample string 2","DataTable":"sample string 3","PeriodCategory":"sample string 4","Period":"sample string 5","Year":6,"Quarter":1},{"DataMartID":"e985b22a-11f3-4751-9113-4d08be0ab8ba","DataMart":"sample string 2","DataTable":"sample string 3","PeriodCategory":"sample string 4","Period":"sample string 5","Year":6,"Quarter":1}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<ArrayOfDataMartAvailabilityPeriodV2DTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <DataMartAvailabilityPeriodV2DTO>
    <DataMart>sample string 2</DataMart>
    <DataMartID>e985b22a-11f3-4751-9113-4d08be0ab8ba</DataMartID>
    <DataTable>sample string 3</DataTable>
    <Period>sample string 5</Period>
    <PeriodCategory>sample string 4</PeriodCategory>
    <Quarter>1</Quarter>
    <Year>6</Year>
  </DataMartAvailabilityPeriodV2DTO>
  <DataMartAvailabilityPeriodV2DTO>
    <DataMart>sample string 2</DataMart>
    <DataMartID>e985b22a-11f3-4751-9113-4d08be0ab8ba</DataMartID>
    <DataTable>sample string 3</DataTable>
    <Period>sample string 5</Period>
    <PeriodCategory>sample string 4</PeriodCategory>
    <Quarter>1</Quarter>
    <Year>6</Year>
  </DataMartAvailabilityPeriodV2DTO>
</ArrayOfDataMartAvailabilityPeriodV2DTO>