POST api/dashboard/chart/{tabType}/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
tabType		string	Required
id		globally unique identifier	Required

Body Parameters

ChartRequest

Name	Type	Additional information
IsFirstRequest	boolean	None.
IsFullScreen	boolean	None.
InnerFilters	Collection of InnerFilterField	None.
ChartId	globally unique identifier	None.
GlobalFilters	Collection of GlobalFilter	None.
DataSourceId	globally unique identifier	None.
DetailFilter	DetailFilter	None.
Remark	string	None.

Request Formats

application/json, text/json

Sample:

{
  "isFirstRequest": true,
  "isFullScreen": true,
  "innerFilters": [
    {
      "showAll": true,
      "defaultName": "sample string 2",
      "granularity": "normal",
      "aggregator": "sample string 3",
      "numberOption": "all",
      "range": [
        "sample string 1",
        "sample string 2"
      ],
      "rangeType": "in",
      "id": "k-353244789",
      "name": "sample string 4",
      "title": "sample string 5",
      "dataType": "number",
      "width": 1.0
    },
    {
      "showAll": true,
      "defaultName": "sample string 2",
      "granularity": "normal",
      "aggregator": "sample string 3",
      "numberOption": "all",
      "range": [
        "sample string 1",
        "sample string 2"
      ],
      "rangeType": "in",
      "id": "k-353244789",
      "name": "sample string 4",
      "title": "sample string 5",
      "dataType": "number",
      "width": 1.0
    }
  ],
  "chartId": "8ba1b5f1-d01c-42b3-8f80-11939f00e678",
  "globalFilters": [
    {
      "name": "sample string 1",
      "dataType": "number",
      "charts": [
        "d877d43a-d521-4dcf-87b2-936d5bb74952",
        "8c7a8d3a-1e77-4068-b87c-2c073abe309a"
      ],
      "tables": [
        {
          "dataSourceId": "d68e139c-ac5c-4570-b2ea-1c175cebae29",
          "field": {
            "name": "sample string 1",
            "dataType": "number",
            "title": "sample string 2",
            "expression": "sample string 3"
          }
        },
        {
          "dataSourceId": "d68e139c-ac5c-4570-b2ea-1c175cebae29",
          "field": {
            "name": "sample string 1",
            "dataType": "number",
            "title": "sample string 2",
            "expression": "sample string 3"
          }
        }
      ],
      "granularity": "normal",
      "range": [
        {},
        {}
      ],
      "showAll": true,
      "defaultSelect": true,
      "defaultName": "sample string 4",
      "id": "2049089713",
      "rangeType": "in"
    },
    {
      "name": "sample string 1",
      "dataType": "number",
      "charts": [
        "d877d43a-d521-4dcf-87b2-936d5bb74952",
        "8c7a8d3a-1e77-4068-b87c-2c073abe309a"
      ],
      "tables": [
        {
          "dataSourceId": "d68e139c-ac5c-4570-b2ea-1c175cebae29",
          "field": {
            "name": "sample string 1",
            "dataType": "number",
            "title": "sample string 2",
            "expression": "sample string 3"
          }
        },
        {
          "dataSourceId": "d68e139c-ac5c-4570-b2ea-1c175cebae29",
          "field": {
            "name": "sample string 1",
            "dataType": "number",
            "title": "sample string 2",
            "expression": "sample string 3"
          }
        }
      ],
      "granularity": "normal",
      "range": [
        {},
        {}
      ],
      "showAll": true,
      "defaultSelect": true,
      "defaultName": "sample string 4",
      "id": "2049089713",
      "rangeType": "in"
    }
  ],
  "dataSourceId": "4792c375-c085-4b7c-8614-39a221ffa0ed",
  "detailFilter": {
    "logic": 1,
    "filterItems": [
      {
        "field": {
          "name": "sample string 1",
          "dataType": "number",
          "title": "sample string 2",
          "expression": "sample string 3"
        },
        "compare": 0,
        "compareValue": "sample string 1",
        "compareValueLeft": "sample string 2",
        "compareValueRight": "sample string 3"
      },
      {
        "field": {
          "name": "sample string 1",
          "dataType": "number",
          "title": "sample string 2",
          "expression": "sample string 3"
        },
        "compare": 0,
        "compareValue": "sample string 1",
        "compareValueLeft": "sample string 2",
        "compareValueRight": "sample string 3"
      }
    ]
  },
  "remark": "sample string 5"
}

application/xml, text/xml

Sample:

<ChartRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Margin.Models">
  <ChartId>8ba1b5f1-d01c-42b3-8f80-11939f00e678</ChartId>
  <DataSourceId>4792c375-c085-4b7c-8614-39a221ffa0ed</DataSourceId>
  <DetailFilter>
    <FilterItems>
      <FilterItem>
        <Compare>GreaterThan</Compare>
        <CompareValue>sample string 1</CompareValue>
        <CompareValueLeft>sample string 2</CompareValueLeft>
        <CompareValueRight>sample string 3</CompareValueRight>
        <Field>
          <dataType>Number</dataType>
          <expression>sample string 3</expression>
          <name>sample string 1</name>
          <title>sample string 2</title>
        </Field>
      </FilterItem>
      <FilterItem>
        <Compare>GreaterThan</Compare>
        <CompareValue>sample string 1</CompareValue>
        <CompareValueLeft>sample string 2</CompareValueLeft>
        <CompareValueRight>sample string 3</CompareValueRight>
        <Field>
          <dataType>Number</dataType>
          <expression>sample string 3</expression>
          <name>sample string 1</name>
          <title>sample string 2</title>
        </Field>
      </FilterItem>
    </FilterItems>
    <Logic>1</Logic>
  </DetailFilter>
  <GlobalFilters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Margin.Core.Data.Entities">
    <d2p1:GlobalFilter>
      <d2p1:Charts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>d877d43a-d521-4dcf-87b2-936d5bb74952</d4p1:guid>
        <d4p1:guid>8c7a8d3a-1e77-4068-b87c-2c073abe309a</d4p1:guid>
      </d2p1:Charts>
      <d2p1:DataType>Number</d2p1:DataType>
      <d2p1:DefaultName>sample string 4</d2p1:DefaultName>
      <d2p1:DefaultSelect>true</d2p1:DefaultSelect>
      <d2p1:Granularity>Normal</d2p1:Granularity>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Range xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </d2p1:Range>
      <d2p1:RangeType>In</d2p1:RangeType>
      <d2p1:ShowAll>true</d2p1:ShowAll>
      <d2p1:Tables>
        <d2p1:GlobalFilter.Table>
          <d2p1:DataSourceId>d68e139c-ac5c-4570-b2ea-1c175cebae29</d2p1:DataSourceId>
          <d2p1:Field>
            <dataType>Number</dataType>
            <expression>sample string 3</expression>
            <name>sample string 1</name>
            <title>sample string 2</title>
          </d2p1:Field>
        </d2p1:GlobalFilter.Table>
        <d2p1:GlobalFilter.Table>
          <d2p1:DataSourceId>d68e139c-ac5c-4570-b2ea-1c175cebae29</d2p1:DataSourceId>
          <d2p1:Field>
            <dataType>Number</dataType>
            <expression>sample string 3</expression>
            <name>sample string 1</name>
            <title>sample string 2</title>
          </d2p1:Field>
        </d2p1:GlobalFilter.Table>
      </d2p1:Tables>
    </d2p1:GlobalFilter>
    <d2p1:GlobalFilter>
      <d2p1:Charts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>d877d43a-d521-4dcf-87b2-936d5bb74952</d4p1:guid>
        <d4p1:guid>8c7a8d3a-1e77-4068-b87c-2c073abe309a</d4p1:guid>
      </d2p1:Charts>
      <d2p1:DataType>Number</d2p1:DataType>
      <d2p1:DefaultName>sample string 4</d2p1:DefaultName>
      <d2p1:DefaultSelect>true</d2p1:DefaultSelect>
      <d2p1:Granularity>Normal</d2p1:Granularity>
      <d2p1:Name>sample string 1</d2p1:Name>
      <d2p1:Range xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </d2p1:Range>
      <d2p1:RangeType>In</d2p1:RangeType>
      <d2p1:ShowAll>true</d2p1:ShowAll>
      <d2p1:Tables>
        <d2p1:GlobalFilter.Table>
          <d2p1:DataSourceId>d68e139c-ac5c-4570-b2ea-1c175cebae29</d2p1:DataSourceId>
          <d2p1:Field>
            <dataType>Number</dataType>
            <expression>sample string 3</expression>
            <name>sample string 1</name>
            <title>sample string 2</title>
          </d2p1:Field>
        </d2p1:GlobalFilter.Table>
        <d2p1:GlobalFilter.Table>
          <d2p1:DataSourceId>d68e139c-ac5c-4570-b2ea-1c175cebae29</d2p1:DataSourceId>
          <d2p1:Field>
            <dataType>Number</dataType>
            <expression>sample string 3</expression>
            <name>sample string 1</name>
            <title>sample string 2</title>
          </d2p1:Field>
        </d2p1:GlobalFilter.Table>
      </d2p1:Tables>
    </d2p1:GlobalFilter>
  </GlobalFilters>
  <InnerFilters xmlns:d2p1="http://schemas.datacontract.org/2004/07/Margin.Core.Data.Entities">
    <d2p1:InnerFilterField>
      <d2p1:DataType>Number</d2p1:DataType>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Title>sample string 5</d2p1:Title>
      <d2p1:Width>1</d2p1:Width>
      <d2p1:Aggregator>sample string 3</d2p1:Aggregator>
      <d2p1:DefaultName>sample string 2</d2p1:DefaultName>
      <d2p1:Granularity>Normal</d2p1:Granularity>
      <d2p1:NumberOption>All</d2p1:NumberOption>
      <d2p1:Range xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Range>
      <d2p1:RangeType>In</d2p1:RangeType>
      <d2p1:ShowAll>true</d2p1:ShowAll>
    </d2p1:InnerFilterField>
    <d2p1:InnerFilterField>
      <d2p1:DataType>Number</d2p1:DataType>
      <d2p1:Name>sample string 4</d2p1:Name>
      <d2p1:Title>sample string 5</d2p1:Title>
      <d2p1:Width>1</d2p1:Width>
      <d2p1:Aggregator>sample string 3</d2p1:Aggregator>
      <d2p1:DefaultName>sample string 2</d2p1:DefaultName>
      <d2p1:Granularity>Normal</d2p1:Granularity>
      <d2p1:NumberOption>All</d2p1:NumberOption>
      <d2p1:Range xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </d2p1:Range>
      <d2p1:RangeType>In</d2p1:RangeType>
      <d2p1:ShowAll>true</d2p1:ShowAll>
    </d2p1:InnerFilterField>
  </InnerFilters>
  <IsFirstRequest>true</IsFirstRequest>
  <IsFullScreen>true</IsFullScreen>
  <Remark>sample string 5</Remark>
</ChartRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult

Name	Type	Additional information
Status	ApiResultStatus	None.
Data	Object	None.
Message	string	None.
Code	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "success",
  "data": {},
  "message": "sample string 2",
  "code": 1
}

application/xml, text/xml

Sample:

<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Margin.Models">
  <Code>1</Code>
  <Data />
  <Message>sample string 2</Message>
  <Status>Success</Status>
</ApiResult>