POST api/appdashboardwidget/select

Request Information

URI Parameters

None.

Body Parameters

AppDashboardWidgetSelect
NameDescriptionTypeAdditional information
Id

integer

None.

Active

integer

None.

Title

string

None.

WidgetType

integer

None.

ContentHeaderTitle

string

None.

ContentHeaderSubtitle

string

None.

ContentHeaderIcon

string

None.

ContentData

string

None.

Width

integer

None.

Height

integer

None.

PositionX

integer

None.

PositionY

integer

None.

MinWidth

integer

None.

MaxWidth

integer

None.

MinHeight

integer

None.

MaxHeight

integer

None.

IsCustom

integer

None.

LockedHeaderData

integer

None.

LockedConfig

integer

None.

LockedRestrictions

integer

None.

LockedPosition

integer

None.

LockedSize

integer

None.

LockedActive

integer

None.

Zusatzfeld1

string

None.

Zusatzfeld2

string

None.

Bemerkung

string

None.

ForUserId

integer

None.

PageSize

integer

Required

PageIndex

integer

Required

SortField

string

None.

SortFieldDefault

string

None.

Quicksearch

string

None.

filterIsSet

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Active": 1,
  "Title": "sample string 1",
  "WidgetType": 1,
  "ContentHeaderTitle": "sample string 2",
  "ContentHeaderSubtitle": "sample string 3",
  "ContentHeaderIcon": "sample string 4",
  "ContentData": "sample string 5",
  "Width": 1,
  "Height": 1,
  "PositionX": 1,
  "PositionY": 1,
  "MinWidth": 1,
  "MaxWidth": 1,
  "MinHeight": 1,
  "MaxHeight": 1,
  "IsCustom": 1,
  "LockedHeaderData": 1,
  "LockedConfig": 1,
  "LockedRestrictions": 1,
  "LockedPosition": 1,
  "LockedSize": 1,
  "LockedActive": 1,
  "Zusatzfeld1": "sample string 6",
  "Zusatzfeld2": "sample string 7",
  "Bemerkung": "sample string 8",
  "ForUserId": 1,
  "PageSize": 9,
  "PageIndex": 10,
  "SortField": "sample string 11",
  "SortFieldDefault": "sample string 12",
  "Quicksearch": "sample string 13",
  "filterIsSet": true
}

application/xml, text/xml

Sample:
<AppDashboardWidgetSelect xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IWeb.App.Models">
  <PageIndex>10</PageIndex>
  <PageSize>9</PageSize>
  <Quicksearch>sample string 13</Quicksearch>
  <SortField>sample string 11</SortField>
  <SortFieldDefault>sample string 12</SortFieldDefault>
  <filterIsSet>true</filterIsSet>
  <Active>1</Active>
  <Bemerkung>sample string 8</Bemerkung>
  <ContentData>sample string 5</ContentData>
  <ContentHeaderIcon>sample string 4</ContentHeaderIcon>
  <ContentHeaderSubtitle>sample string 3</ContentHeaderSubtitle>
  <ContentHeaderTitle>sample string 2</ContentHeaderTitle>
  <ForUserId>1</ForUserId>
  <Height>1</Height>
  <Id>1</Id>
  <IsCustom>1</IsCustom>
  <LockedActive>1</LockedActive>
  <LockedConfig>1</LockedConfig>
  <LockedHeaderData>1</LockedHeaderData>
  <LockedPosition>1</LockedPosition>
  <LockedRestrictions>1</LockedRestrictions>
  <LockedSize>1</LockedSize>
  <MaxHeight>1</MaxHeight>
  <MaxWidth>1</MaxWidth>
  <MinHeight>1</MinHeight>
  <MinWidth>1</MinWidth>
  <PositionX>1</PositionX>
  <PositionY>1</PositionY>
  <Title>sample string 1</Title>
  <WidgetType>1</WidgetType>
  <Width>1</Width>
  <Zusatzfeld1>sample string 6</Zusatzfeld1>
  <Zusatzfeld2>sample string 7</Zusatzfeld2>
</AppDashboardWidgetSelect>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AppDashboardWidgetSelect'.

Response Information

Resource Description

AppDashboardWidgetQueryResult
NameDescriptionTypeAdditional information
Entries

Collection of AppDashboardWidgetDisplay

None.

RecordsTotal

integer

Required

PageSize

integer

Required

PageIndex

integer

Required

SortField

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Entries": [
    {
      "WidgetTypeDisplay": "sample string 1",
      "DisplayField": "sample string 2",
      "Id": 3,
      "RowGuid": "a5e8f1cb-f98f-4c46-b8b5-d286b5ff18a1",
      "Active": 5,
      "Title": "sample string 6",
      "WidgetType": 7,
      "ContentHeaderTitle": "sample string 8",
      "ContentHeaderSubtitle": "sample string 9",
      "ContentHeaderIcon": "sample string 10",
      "ContentData": "sample string 11",
      "Width": 1,
      "Height": 1,
      "PositionX": 1,
      "PositionY": 1,
      "MinWidth": 1,
      "MaxWidth": 1,
      "MinHeight": 1,
      "MaxHeight": 1,
      "IsCustom": 12,
      "LockedHeaderData": 13,
      "LockedConfig": 14,
      "LockedRestrictions": 15,
      "LockedPosition": 16,
      "LockedSize": 17,
      "LockedActive": 18,
      "Zusatzfeld1": "sample string 19",
      "Zusatzfeld2": "sample string 20",
      "Bemerkung": "sample string 21"
    },
    {
      "WidgetTypeDisplay": "sample string 1",
      "DisplayField": "sample string 2",
      "Id": 3,
      "RowGuid": "a5e8f1cb-f98f-4c46-b8b5-d286b5ff18a1",
      "Active": 5,
      "Title": "sample string 6",
      "WidgetType": 7,
      "ContentHeaderTitle": "sample string 8",
      "ContentHeaderSubtitle": "sample string 9",
      "ContentHeaderIcon": "sample string 10",
      "ContentData": "sample string 11",
      "Width": 1,
      "Height": 1,
      "PositionX": 1,
      "PositionY": 1,
      "MinWidth": 1,
      "MaxWidth": 1,
      "MinHeight": 1,
      "MaxHeight": 1,
      "IsCustom": 12,
      "LockedHeaderData": 13,
      "LockedConfig": 14,
      "LockedRestrictions": 15,
      "LockedPosition": 16,
      "LockedSize": 17,
      "LockedActive": 18,
      "Zusatzfeld1": "sample string 19",
      "Zusatzfeld2": "sample string 20",
      "Bemerkung": "sample string 21"
    }
  ],
  "RecordsTotal": 1,
  "PageSize": 2,
  "PageIndex": 3,
  "SortField": "sample string 4"
}