XaitCPQ API

GET data/list/{name}/{section}

Get paginated list of data for a section.

Request Information

URI

https://ofd-api.blueprintcpq.net/data/list/{name}/{section}?filters[0]={filters[0]}&filters[1]={filters[1]}&operators[0]={operators[0]}&operators[1]={operators[1]}&values[0]={values[0]}&values[1]={values[1]}&groups[0]={groups[0]}&groups[1]={groups[1]}&pageNumber={pageNumber}&pageSize={pageSize}&sortField={sortField}&sortDirection={sortDirection}&baseRecord={baseRecord}&share={share}

URI Parameters

NameDescriptionTypeAdditional information
name

Page name.

 string

Required
section

Section Name or Id.

 string

Required
filters

The filters.

 Collection of string

Required
operators

Filter operators.

 Collection of Operator

Required
values

Filter values.

 Collection of string

Required
groups

Collection of integer

Required
pageNumber

Page number.

 integer

Default value is 1
pageSize

Maximum number of rows to return.

 integer

Default value is 20
sortField

Field to sort by.

 string

None.
sortDirection

Direction to sort (asc or desc)

 SortDirection

None.
baseRecord

Base record Id

 string

None.
share

Optional share identifier.

 globally unique identifier

None.

Body Parameters

None.

Response Information

Resource Description

List of Data.

RowDataContainer
NameDescriptionTypeAdditional information
IdField

globally unique identifier

None.
CurrencyField

globally unique identifier

None.
LinkTableName

string

None.
Data

Collection of RowData

None.
TotalRecords

integer

None.
PageNumber

integer

None.
PageSize

integer

None.
SortBy

string

None.
SortDirection

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "IdField": "9b70d1b9-026f-40aa-aabb-68c60357453d",
  "CurrencyField": "f5d1e243-fb44-4a6f-bb50-7fef95e75e4c",
  "LinkTableName": "sample string 2",
  "Data": null,
  "TotalRecords": 3,
  "PageNumber": 4,
  "PageSize": 5,
  "SortBy": "sample string 6",
  "SortDirection": "sample string 7"
}

text/html

Sample: 
{"IdField":"9b70d1b9-026f-40aa-aabb-68c60357453d","CurrencyField":"f5d1e243-fb44-4a6f-bb50-7fef95e75e4c","LinkTableName":"sample string 2","Data":null,"TotalRecords":3,"PageNumber":4,"PageSize":5,"SortBy":"sample string 6","SortDirection":"sample string 7"}

application/xml, text/xml

Sample: 
<RowDataContainer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Shared.Models.DataModels">
  <PageNumber>4</PageNumber>
  <PageSize>5</PageSize>
  <SortBy>sample string 6</SortBy>
  <SortDirection>sample string 7</SortDirection>
  <TotalRecords>3</TotalRecords>
  <CurrencyField>f5d1e243-fb44-4a6f-bb50-7fef95e75e4c</CurrencyField>
  <Data i:nil="true" />
  <IdField>9b70d1b9-026f-40aa-aabb-68c60357453d</IdField>
  <LinkTableName>sample string 2</LinkTableName>
</RowDataContainer>