GET api/organizations/current/users/current/modules/pipeflows

Gets a collection of Pipeflows, with their related Pipeflow_Statuses, for the current User of the current UserCompany.



Request Information

URI Parameters

None.



Body Parameters

None.



Response Information

Resource Description

The requested collection of Pipeflows.

Collection of ReadPipeflowViewModel

NameDescriptionTypeAdditional information
DefaultCardState

ExpandedState

None.

DefaultFilters

Collection of PipeflowFilterViewModel

None.

DetailEntityAttributeIds

Collection of integer

None.

EntityAttributeId

integer

None.

EntityDefinitionId

integer

None.

Id

integer

None.

IsPrivate

boolean

None.

Name

string

None.

PipeflowStatuses

Collection of ReadPipeflowStatusViewModel

None.

SubjectEntityAttributeId

integer

None.

UserCompanyId

integer

None.

UserId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DefaultCardState": 1,
    "DefaultFilters": [
      {
        "EntityAttributeId": 1,
        "Value": "sample string 2"
      },
      {
        "EntityAttributeId": 1,
        "Value": "sample string 2"
      }
    ],
    "DetailEntityAttributeIds": [
      1,
      2
    ],
    "EntityAttributeId": 1,
    "EntityDefinitionId": 2,
    "Id": 3,
    "IsPrivate": true,
    "Name": "sample string 5",
    "PipeflowStatuses": [
      {
        "HeaderColor": "sample string 1",
        "IconClass": "sample string 2",
        "Id": 3,
        "Order": 4,
        "Status": "sample string 5"
      },
      {
        "HeaderColor": "sample string 1",
        "IconClass": "sample string 2",
        "Id": 3,
        "Order": 4,
        "Status": "sample string 5"
      }
    ],
    "SubjectEntityAttributeId": 1,
    "UserCompanyId": 6,
    "UserId": "98dcdaf7-452b-4deb-94a0-7539fde1627c"
  },
  {
    "DefaultCardState": 1,
    "DefaultFilters": [
      {
        "EntityAttributeId": 1,
        "Value": "sample string 2"
      },
      {
        "EntityAttributeId": 1,
        "Value": "sample string 2"
      }
    ],
    "DetailEntityAttributeIds": [
      1,
      2
    ],
    "EntityAttributeId": 1,
    "EntityDefinitionId": 2,
    "Id": 3,
    "IsPrivate": true,
    "Name": "sample string 5",
    "PipeflowStatuses": [
      {
        "HeaderColor": "sample string 1",
        "IconClass": "sample string 2",
        "Id": 3,
        "Order": 4,
        "Status": "sample string 5"
      },
      {
        "HeaderColor": "sample string 1",
        "IconClass": "sample string 2",
        "Id": 3,
        "Order": 4,
        "Status": "sample string 5"
      }
    ],
    "SubjectEntityAttributeId": 1,
    "UserCompanyId": 6,
    "UserId": "98dcdaf7-452b-4deb-94a0-7539fde1627c"
  }
]

application/xml, text/xml

Sample:
<ArrayOfReadPipeflowViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels.Modules.Pipeflow">
  <ReadPipeflowViewModel>
    <DefaultCardState>Collapsed</DefaultCardState>
    <DefaultFilters>
      <PipeflowFilterViewModel>
        <EntityAttributeId>1</EntityAttributeId>
        <Value>sample string 2</Value>
      </PipeflowFilterViewModel>
      <PipeflowFilterViewModel>
        <EntityAttributeId>1</EntityAttributeId>
        <Value>sample string 2</Value>
      </PipeflowFilterViewModel>
    </DefaultFilters>
    <DetailEntityAttributeIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </DetailEntityAttributeIds>
    <EntityAttributeId>1</EntityAttributeId>
    <EntityDefinitionId>2</EntityDefinitionId>
    <Id>3</Id>
    <IsPrivate>true</IsPrivate>
    <Name>sample string 5</Name>
    <PipeflowStatuses>
      <ReadPipeflowStatusViewModel>
        <HeaderColor>sample string 1</HeaderColor>
        <IconClass>sample string 2</IconClass>
        <Id>3</Id>
        <Order>4</Order>
        <Status>sample string 5</Status>
      </ReadPipeflowStatusViewModel>
      <ReadPipeflowStatusViewModel>
        <HeaderColor>sample string 1</HeaderColor>
        <IconClass>sample string 2</IconClass>
        <Id>3</Id>
        <Order>4</Order>
        <Status>sample string 5</Status>
      </ReadPipeflowStatusViewModel>
    </PipeflowStatuses>
    <SubjectEntityAttributeId>1</SubjectEntityAttributeId>
    <UserCompanyId>6</UserCompanyId>
    <UserId>98dcdaf7-452b-4deb-94a0-7539fde1627c</UserId>
  </ReadPipeflowViewModel>
  <ReadPipeflowViewModel>
    <DefaultCardState>Collapsed</DefaultCardState>
    <DefaultFilters>
      <PipeflowFilterViewModel>
        <EntityAttributeId>1</EntityAttributeId>
        <Value>sample string 2</Value>
      </PipeflowFilterViewModel>
      <PipeflowFilterViewModel>
        <EntityAttributeId>1</EntityAttributeId>
        <Value>sample string 2</Value>
      </PipeflowFilterViewModel>
    </DefaultFilters>
    <DetailEntityAttributeIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:long>1</d3p1:long>
      <d3p1:long>2</d3p1:long>
    </DetailEntityAttributeIds>
    <EntityAttributeId>1</EntityAttributeId>
    <EntityDefinitionId>2</EntityDefinitionId>
    <Id>3</Id>
    <IsPrivate>true</IsPrivate>
    <Name>sample string 5</Name>
    <PipeflowStatuses>
      <ReadPipeflowStatusViewModel>
        <HeaderColor>sample string 1</HeaderColor>
        <IconClass>sample string 2</IconClass>
        <Id>3</Id>
        <Order>4</Order>
        <Status>sample string 5</Status>
      </ReadPipeflowStatusViewModel>
      <ReadPipeflowStatusViewModel>
        <HeaderColor>sample string 1</HeaderColor>
        <IconClass>sample string 2</IconClass>
        <Id>3</Id>
        <Order>4</Order>
        <Status>sample string 5</Status>
      </ReadPipeflowStatusViewModel>
    </PipeflowStatuses>
    <SubjectEntityAttributeId>1</SubjectEntityAttributeId>
    <UserCompanyId>6</UserCompanyId>
    <UserId>98dcdaf7-452b-4deb-94a0-7539fde1627c</UserId>
  </ReadPipeflowViewModel>
</ArrayOfReadPipeflowViewModel>