PUT api/dashboard/{tabType}/{id}

Request Information

URI Parameters

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

Body Parameters

DashDetailModel

Name	Type	Additional information
Aspects	Collection of ChartAspectModel	None.
GlobalFilter	Collection of GlobalFilter	None.
ProjectId	globally unique identifier	None.
DashboardId	globally unique identifier	None.
Name	string	None.
Description	string	None.
Show	boolean	None.
Order	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "aspects": [
    {
      "chartId": "6b21b16d-1ef8-41f6-af9f-004a9522a5ce",
      "title": "sample string 2",
      "sizeX": 1,
      "sizeY": 1,
      "minSizeX": 1,
      "minSizeY": 1,
      "row": 1,
      "col": 1
    },
    {
      "chartId": "6b21b16d-1ef8-41f6-af9f-004a9522a5ce",
      "title": "sample string 2",
      "sizeX": 1,
      "sizeY": 1,
      "minSizeX": 1,
      "minSizeY": 1,
      "row": 1,
      "col": 1
    }
  ],
  "globalFilter": [
    {
      "name": "sample string 1",
      "dataType": "number",
      "charts": [
        "abc5f469-f282-42f7-b235-f80d37a7ef1c",
        "2e02f130-e3af-4de3-a68f-bf959f974866"
      ],
      "tables": [
        {
          "dataSourceId": "65ba00a7-6bd9-47f1-9742-1c22fed2d137",
          "field": {
            "name": "sample string 1",
            "dataType": "number",
            "title": "sample string 2",
            "expression": "sample string 3"
          }
        },
        {
          "dataSourceId": "65ba00a7-6bd9-47f1-9742-1c22fed2d137",
          "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": [
        "abc5f469-f282-42f7-b235-f80d37a7ef1c",
        "2e02f130-e3af-4de3-a68f-bf959f974866"
      ],
      "tables": [
        {
          "dataSourceId": "65ba00a7-6bd9-47f1-9742-1c22fed2d137",
          "field": {
            "name": "sample string 1",
            "dataType": "number",
            "title": "sample string 2",
            "expression": "sample string 3"
          }
        },
        {
          "dataSourceId": "65ba00a7-6bd9-47f1-9742-1c22fed2d137",
          "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"
    }
  ],
  "projectId": "3f18c41c-5093-4341-b7be-c8fdf6f8484d",
  "dashboardId": "79d16ffe-ebdd-4a50-a87d-6a5ea513398c",
  "name": "sample string 3",
  "description": "sample string 4",
  "show": true,
  "order": 6.0
}

application/xml, text/xml

Sample:

<DashDetailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Margin.Models">
  <DashboardId>79d16ffe-ebdd-4a50-a87d-6a5ea513398c</DashboardId>
  <Description>sample string 4</Description>
  <Name>sample string 3</Name>
  <Order>6</Order>
  <ProjectId>3f18c41c-5093-4341-b7be-c8fdf6f8484d</ProjectId>
  <Show>true</Show>
  <Aspects>
    <ChartAspectModel>
      <ChartId>6b21b16d-1ef8-41f6-af9f-004a9522a5ce</ChartId>
      <Col>1</Col>
      <MinSizeX>1</MinSizeX>
      <MinSizeY>1</MinSizeY>
      <Row>1</Row>
      <SizeX>1</SizeX>
      <SizeY>1</SizeY>
      <Title>sample string 2</Title>
    </ChartAspectModel>
    <ChartAspectModel>
      <ChartId>6b21b16d-1ef8-41f6-af9f-004a9522a5ce</ChartId>
      <Col>1</Col>
      <MinSizeX>1</MinSizeX>
      <MinSizeY>1</MinSizeY>
      <Row>1</Row>
      <SizeX>1</SizeX>
      <SizeY>1</SizeY>
      <Title>sample string 2</Title>
    </ChartAspectModel>
  </Aspects>
  <GlobalFilter 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>abc5f469-f282-42f7-b235-f80d37a7ef1c</d4p1:guid>
        <d4p1:guid>2e02f130-e3af-4de3-a68f-bf959f974866</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>65ba00a7-6bd9-47f1-9742-1c22fed2d137</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>65ba00a7-6bd9-47f1-9742-1c22fed2d137</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>abc5f469-f282-42f7-b235-f80d37a7ef1c</d4p1:guid>
        <d4p1:guid>2e02f130-e3af-4de3-a68f-bf959f974866</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>65ba00a7-6bd9-47f1-9742-1c22fed2d137</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>65ba00a7-6bd9-47f1-9742-1c22fed2d137</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>
  </GlobalFilter>
</DashDetailModel>

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>