GET api/PerformanceData/GetHistogramData/{name}?org={org}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
org

integer

Required

name

string

None.

Body Parameters

Collection of OrganizationsDataItemViewModel
NameDescriptionTypeAdditional information
Id

integer

None.

OrganizationId

integer

None.

ItemId

integer

None.

Year

integer

None.

Code

string

None.

Name

string

None.

City

string

None.

Value

decimal number

None.

Units

string

None.

ItemClass

string

None.

DefaultUnits

decimal number

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "OrganizationId": 2,
    "ItemId": 3,
    "Year": 4,
    "Code": "sample string 5",
    "Name": "sample string 6",
    "City": "sample string 7",
    "Value": 1.1,
    "Units": "sample string 8",
    "ItemClass": "sample string 9",
    "DefaultUnits": 1.1
  },
  {
    "Id": 1,
    "OrganizationId": 2,
    "ItemId": 3,
    "Year": 4,
    "Code": "sample string 5",
    "Name": "sample string 6",
    "City": "sample string 7",
    "Value": 1.1,
    "Units": "sample string 8",
    "ItemClass": "sample string 9",
    "DefaultUnits": 1.1
  }
]

text/html

Sample:
[{"Id":1,"OrganizationId":2,"ItemId":3,"Year":4,"Code":"sample string 5","Name":"sample string 6","City":"sample string 7","Value":1.1,"Units":"sample string 8","ItemClass":"sample string 9","DefaultUnits":1.1},{"Id":1,"OrganizationId":2,"ItemId":3,"Year":4,"Code":"sample string 5","Name":"sample string 6","City":"sample string 7","Value":1.1,"Units":"sample string 8","ItemClass":"sample string 9","DefaultUnits":1.1}]

application/xml, text/xml

Sample:
<ArrayOfOrganizationsDataItemViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBNetAPI.ViewModels">
  <OrganizationsDataItemViewModel>
    <City>sample string 7</City>
    <Code>sample string 5</Code>
    <DefaultUnits>1.1</DefaultUnits>
    <Id>1</Id>
    <ItemClass>sample string 9</ItemClass>
    <ItemId>3</ItemId>
    <Name>sample string 6</Name>
    <OrganizationId>2</OrganizationId>
    <Units>sample string 8</Units>
    <Value>1.1</Value>
    <Year>4</Year>
  </OrganizationsDataItemViewModel>
  <OrganizationsDataItemViewModel>
    <City>sample string 7</City>
    <Code>sample string 5</Code>
    <DefaultUnits>1.1</DefaultUnits>
    <Id>1</Id>
    <ItemClass>sample string 9</ItemClass>
    <ItemId>3</ItemId>
    <Name>sample string 6</Name>
    <OrganizationId>2</OrganizationId>
    <Units>sample string 8</Units>
    <Value>1.1</Value>
    <Year>4</Year>
  </OrganizationsDataItemViewModel>
</ArrayOfOrganizationsDataItemViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of HistogramPoint
NameDescriptionTypeAdditional information
ItemId

integer

None.

Number

decimal number

None.

Count

integer

None.

OwnValue

boolean

None.

Accumulated

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ItemId": 1,
    "Number": 2.1,
    "Count": 3,
    "OwnValue": true,
    "Accumulated": 5
  },
  {
    "ItemId": 1,
    "Number": 2.1,
    "Count": 3,
    "OwnValue": true,
    "Accumulated": 5
  }
]

text/html

Sample:
[{"ItemId":1,"Number":2.1,"Count":3,"OwnValue":true,"Accumulated":5},{"ItemId":1,"Number":2.1,"Count":3,"OwnValue":true,"Accumulated":5}]

application/xml, text/xml

Sample:
<ArrayOfPerformanceDataController.HistogramPoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBNetAPI.Controllers">
  <PerformanceDataController.HistogramPoint>
    <Accumulated>5</Accumulated>
    <Count>3</Count>
    <ItemId>1</ItemId>
    <Number>2.1</Number>
    <OwnValue>true</OwnValue>
  </PerformanceDataController.HistogramPoint>
  <PerformanceDataController.HistogramPoint>
    <Accumulated>5</Accumulated>
    <Count>3</Count>
    <ItemId>1</ItemId>
    <Number>2.1</Number>
    <OwnValue>true</OwnValue>
  </PerformanceDataController.HistogramPoint>
</ArrayOfPerformanceDataController.HistogramPoint>