POST 17.0/database/propertypresentationitems/list

Description

Retrieve a list of Property Presentation Items

URI Parameters

None.

Name Description Type Additional information
Fields

Collection of string

None.

Filters

Collection of DatabaseFilter

None.

Order

string

None.

application/json, text/json

Sample:
{
  "fields": [
    "sample string 1",
    "sample string 2"
  ],
  "filters": [
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    },
    {
      "fieldName": "sample string 1",
      "value": "sample string 2",
      "operator": "sample string 3",
      "valueType": "sample string 4"
    }
  ],
  "order": "sample string 1"
}

application/xml, text/xml

Sample:
<ListOptions xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Fields>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Fields>
  <Filters>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
    <DatabaseFilter>
      <FieldName>sample string 1</FieldName>
      <Value>sample string 2</Value>
      <Operator>sample string 3</Operator>
      <ValueType>sample string 4</ValueType>
    </DatabaseFilter>
  </Filters>
  <Order>sample string 1</Order>
</ListOptions>

application/x-www-form-urlencoded

Sample:

Sample not available.

Name Description Type Additional information
ID

integer

None.

Description

string

String length: inclusive between 0 and 50

Type

byte

None.

BackColor

integer

None.

ForeColor

integer

None.

FontName

string

String length: inclusive between 0 and 50

FontSize

integer

None.

FontBold

byte

None.

FontItalic

byte

None.

FontNameAlt

string

String length: inclusive between 0 and 50

FontSizeAlt

integer

None.

FontBoldAlt

byte

None.

FontItalicAlt

byte

None.

FileName

string

String length: inclusive between 0 and 255

Duration

integer

None.

Transition

byte

None.

KeepAspectRatio

byte

None.

DisplayPropertyType

byte

None.

application/json, text/json

Sample:
[
  {
    "id": 1,
    "description": "sample string 1",
    "type": 64,
    "backColor": 1,
    "foreColor": 1,
    "fontName": "sample string 2",
    "fontSize": 1,
    "fontBold": 64,
    "fontItalic": 64,
    "fontNameAlt": "sample string 3",
    "fontSizeAlt": 1,
    "fontBoldAlt": 64,
    "fontItalicAlt": 64,
    "fileName": "sample string 4",
    "duration": 1,
    "transition": 64,
    "keepAspectRatio": 64,
    "displayPropertyType": 64
  },
  {
    "id": 1,
    "description": "sample string 1",
    "type": 64,
    "backColor": 1,
    "foreColor": 1,
    "fontName": "sample string 2",
    "fontSize": 1,
    "fontBold": 64,
    "fontItalic": 64,
    "fontNameAlt": "sample string 3",
    "fontSizeAlt": 1,
    "fontBoldAlt": 64,
    "fontItalicAlt": 64,
    "fileName": "sample string 4",
    "duration": 1,
    "transition": 64,
    "keepAspectRatio": 64,
    "displayPropertyType": 64
  }
]

application/xml, text/xml

Sample:
<ArrayOfPropertyPresentationItemsUpdate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PropertyPresentationItemsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Type>64</Type>
    <BackColor>1</BackColor>
    <ForeColor>1</ForeColor>
    <FontName>sample string 2</FontName>
    <FontSize>1</FontSize>
    <FontBold>64</FontBold>
    <FontItalic>64</FontItalic>
    <FontNameAlt>sample string 3</FontNameAlt>
    <FontSizeAlt>1</FontSizeAlt>
    <FontBoldAlt>64</FontBoldAlt>
    <FontItalicAlt>64</FontItalicAlt>
    <FileName>sample string 4</FileName>
    <Duration>1</Duration>
    <Transition>64</Transition>
    <KeepAspectRatio>64</KeepAspectRatio>
    <DisplayPropertyType>64</DisplayPropertyType>
  </PropertyPresentationItemsUpdate>
  <PropertyPresentationItemsUpdate>
    <ID>1</ID>
    <Description>sample string 1</Description>
    <Type>64</Type>
    <BackColor>1</BackColor>
    <ForeColor>1</ForeColor>
    <FontName>sample string 2</FontName>
    <FontSize>1</FontSize>
    <FontBold>64</FontBold>
    <FontItalic>64</FontItalic>
    <FontNameAlt>sample string 3</FontNameAlt>
    <FontSizeAlt>1</FontSizeAlt>
    <FontBoldAlt>64</FontBoldAlt>
    <FontItalicAlt>64</FontItalicAlt>
    <FileName>sample string 4</FileName>
    <Duration>1</Duration>
    <Transition>64</Transition>
    <KeepAspectRatio>64</KeepAspectRatio>
    <DisplayPropertyType>64</DisplayPropertyType>
  </PropertyPresentationItemsUpdate>
</ArrayOfPropertyPresentationItemsUpdate>