GET api/organizations/current/users/current/modules/pipeflow/{pipeflowId}/widget-statistics

Gets the statistics for a specific Pipeflow, to be used in the Pipeflow widget.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
pipeflowId

The id of the Pipeflow to get the statistics for.

integer

Required



Body Parameters

None.



Response Information

Resource Description

The requested Pipeflow statistics, represented as a PipeflowWidgetPipeflowViewModel.

PipeflowWidgetPipeflowViewModel

NameDescriptionTypeAdditional information
EntityAttributeId

integer

None.

EntityDefinitionId

integer

None.

PipeflowId

integer

None.

PipeflowName

string

None.

PipeflowStatuses

Collection of PipeflowWidgetPipeflowStatusViewModel

None.

TotalResultCount

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "EntityAttributeId": 1,
  "EntityDefinitionId": 2,
  "PipeflowId": 3,
  "PipeflowName": "sample string 4",
  "PipeflowStatuses": [
    {
      "HeaderColor": "sample string 1",
      "IconClass": "sample string 2",
      "Id": 3,
      "Order": 4,
      "ResultCount": 5,
      "Status": "sample string 6"
    },
    {
      "HeaderColor": "sample string 1",
      "IconClass": "sample string 2",
      "Id": 3,
      "Order": 4,
      "ResultCount": 5,
      "Status": "sample string 6"
    }
  ],
  "TotalResultCount": 5
}

application/xml, text/xml

Sample:
<PipeflowWidgetPipeflowViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels.Widgets">
  <EntityAttributeId>1</EntityAttributeId>
  <EntityDefinitionId>2</EntityDefinitionId>
  <PipeflowId>3</PipeflowId>
  <PipeflowName>sample string 4</PipeflowName>
  <PipeflowStatuses>
    <PipeflowWidgetPipeflowStatusViewModel>
      <HeaderColor>sample string 1</HeaderColor>
      <IconClass>sample string 2</IconClass>
      <Id>3</Id>
      <Order>4</Order>
      <ResultCount>5</ResultCount>
      <Status>sample string 6</Status>
    </PipeflowWidgetPipeflowStatusViewModel>
    <PipeflowWidgetPipeflowStatusViewModel>
      <HeaderColor>sample string 1</HeaderColor>
      <IconClass>sample string 2</IconClass>
      <Id>3</Id>
      <Order>4</Order>
      <ResultCount>5</ResultCount>
      <Status>sample string 6</Status>
    </PipeflowWidgetPipeflowStatusViewModel>
  </PipeflowStatuses>
  <TotalResultCount>5</TotalResultCount>
</PipeflowWidgetPipeflowViewModel>