POST workflow/BuildQuery

Request Information

URI Parameters

None.

Body Parameters

WorkFlowBuilderQuery
NameDescriptionTypeAdditional information
MainObjectTypeId

integer

None.

LinkedObjectIds

Collection of integer

None.

QueryFields

Collection of QueryField

None.

TenantId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "MainObjectTypeId": 1,
  "LinkedObjectIds": [
    1,
    2
  ],
  "QueryFields": [
    {
      "FieldName": "sample string 1",
      "DisplayFieldAs": "sample string 2"
    },
    {
      "FieldName": "sample string 1",
      "DisplayFieldAs": "sample string 2"
    }
  ],
  "TenantId": 2
}

text/html

Sample:
{"MainObjectTypeId":1,"LinkedObjectIds":[1,2],"QueryFields":[{"FieldName":"sample string 1","DisplayFieldAs":"sample string 2"},{"FieldName":"sample string 1","DisplayFieldAs":"sample string 2"}],"TenantId":2}

application/xml, text/xml

Sample:
<WorkFlowBuilderQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Workflow">
  <LinkedObjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LinkedObjectIds>
  <MainObjectTypeId>1</MainObjectTypeId>
  <QueryFields>
    <QueryField>
      <DisplayFieldAs>sample string 2</DisplayFieldAs>
      <FieldName>sample string 1</FieldName>
    </QueryField>
    <QueryField>
      <DisplayFieldAs>sample string 2</DisplayFieldAs>
      <FieldName>sample string 1</FieldName>
    </QueryField>
  </QueryFields>
  <TenantId>2</TenantId>
</WorkFlowBuilderQuery>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'WorkFlowBuilderQuery'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.