POST api/organizations/current/users/current/modules/pipeflows

Adds a new Pipeflow.



Request Information

URI Parameters

None.



Body Parameters

An object representing the Pipeflow to add.

PostPipeflowViewModel
NameDescriptionTypeAdditional information
EntityAttributeId

integer

None.

EntityDefinitionId

integer

None.

IsPrivate

boolean

None.

Name

string

None.

Statuses

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "EntityAttributeId": 1,
  "EntityDefinitionId": 2,
  "IsPrivate": true,
  "Name": "sample string 4",
  "Statuses": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<PostPipeflowViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels.Modules.Pipeflow">
  <EntityAttributeId>1</EntityAttributeId>
  <EntityDefinitionId>2</EntityDefinitionId>
  <IsPrivate>true</IsPrivate>
  <Name>sample string 4</Name>
  <Statuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Statuses>
</PostPipeflowViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information

Resource Description

A ReadPipeflowViewModel representing the added Pipeflow.

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": "d47345c3-4903-4095-9a5d-e8a14896a40e"
}

application/xml, text/xml

Sample:
<ReadPipeflowViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels.Modules.Pipeflow">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1: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>d47345c3-4903-4095-9a5d-e8a14896a40e</UserId>
</ReadPipeflowViewModel>