ASP.NET Web API Help Page

PATCH pico/queue-views/{id}

Updates a queue view.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The queue view identifier.	integer	Required

Body Parameters

The queue view.

Pico.QueueView

Name	Description	Type	Additional information
organization	Gets or sets the organization identifier.	integer	None.
id	Gets or sets the queue view identifier.	integer	None.
user	Gets or sets the user identifier.	integer	None.
baseConditions	Gets or sets the base conditions.	string	None.
classifications	Gets or sets the classifications.	string	None.
columns	Gets or sets the columns.	string	None.
description	Gets or sets the description.	string	None.
externalParties	Gets or sets the external parties.	string	None.
isFilteredByProcessorAssistantOrg	Gets or sets a value indicating whether this is filtered by processor assistant org.	boolean	None.
groupBy	Gets or sets the group by.	string	None.
isActive	Gets or sets a value indicating whether this is active.	boolean	None.
roles	Gets or sets the roles.	string	None.
sortBy	Gets or sets the sort by.	string	None.
sortByDirection	Gets or sets the sort by direction.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "organization": "1",
  "id": "1",
  "user": "1",
  "baseConditions": "sample String 2",
  "classifications": "sample String 3",
  "columns": "sample String 4",
  "description": "sample String 5",
  "externalParties": "sample String 6",
  "isFilteredByProcessorAssistantOrg": true,
  "groupBy": "sample String 8",
  "isActive": true,
  "roles": "sample String 10",
  "sortBy": "sample String 11",
  "sortByDirection": "sample String 12"
}

text/html

Sample:

{"organization":"1","id":"1","user":"1","baseConditions":"sample String 2","classifications":"sample String 3","columns":"sample String 4","description":"sample String 5","externalParties":"sample String 6","isFilteredByProcessorAssistantOrg":true,"groupBy":"sample String 8","isActive":true,"roles":"sample String 10","sortBy":"sample String 11","sortByDirection":"sample String 12"}

application/xml, text/xml

Sample:

<QueueView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrganizationId>1</OrganizationId>
  <QueueViewId>1</QueueViewId>
  <UserId>1</UserId>
  <BaseConditions>sample String 2</BaseConditions>
  <Classifications>sample String 3</Classifications>
  <Columns>sample String 4</Columns>
  <Description>sample String 5</Description>
  <ExternalParties>sample String 6</ExternalParties>
  <IsFilteredByProcessorAssistantOrg>true</IsFilteredByProcessorAssistantOrg>
  <GroupBy>sample String 8</GroupBy>
  <IsActive>true</IsActive>
  <Roles>sample String 10</Roles>
  <SortBy>sample String 11</SortBy>
  <SortByDirection>sample String 12</SortByDirection>
</QueueView>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated queue view.

Pico.QueueView

Name	Description	Type	Additional information
organization	Gets or sets the organization identifier.	integer	None.
id	Gets or sets the queue view identifier.	integer	None.
user	Gets or sets the user identifier.	integer	None.
baseConditions	Gets or sets the base conditions.	string	None.
classifications	Gets or sets the classifications.	string	None.
columns	Gets or sets the columns.	string	None.
description	Gets or sets the description.	string	None.
externalParties	Gets or sets the external parties.	string	None.
isFilteredByProcessorAssistantOrg	Gets or sets a value indicating whether this is filtered by processor assistant org.	boolean	None.
groupBy	Gets or sets the group by.	string	None.
isActive	Gets or sets a value indicating whether this is active.	boolean	None.
roles	Gets or sets the roles.	string	None.
sortBy	Gets or sets the sort by.	string	None.
sortByDirection	Gets or sets the sort by direction.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "organization": "1",
  "id": "1",
  "user": "1",
  "baseConditions": "sample String 2",
  "classifications": "sample String 3",
  "columns": "sample String 4",
  "description": "sample String 5",
  "externalParties": "sample String 6",
  "isFilteredByProcessorAssistantOrg": true,
  "groupBy": "sample String 8",
  "isActive": true,
  "roles": "sample String 10",
  "sortBy": "sample String 11",
  "sortByDirection": "sample String 12"
}

text/html

Sample:

{"organization":"1","id":"1","user":"1","baseConditions":"sample String 2","classifications":"sample String 3","columns":"sample String 4","description":"sample String 5","externalParties":"sample String 6","isFilteredByProcessorAssistantOrg":true,"groupBy":"sample String 8","isActive":true,"roles":"sample String 10","sortBy":"sample String 11","sortByDirection":"sample String 12"}

application/xml, text/xml

Sample:

<QueueView xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrganizationId>1</OrganizationId>
  <QueueViewId>1</QueueViewId>
  <UserId>1</UserId>
  <BaseConditions>sample String 2</BaseConditions>
  <Classifications>sample String 3</Classifications>
  <Columns>sample String 4</Columns>
  <Description>sample String 5</Description>
  <ExternalParties>sample String 6</ExternalParties>
  <IsFilteredByProcessorAssistantOrg>true</IsFilteredByProcessorAssistantOrg>
  <GroupBy>sample String 8</GroupBy>
  <IsActive>true</IsActive>
  <Roles>sample String 10</Roles>
  <SortBy>sample String 11</SortBy>
  <SortByDirection>sample String 12</SortByDirection>
</QueueView>