List Live Price Grids

post/fetch/PG

Retrieves all Price Grids based on filter settings.


Filter example:

Returns only Price Grids where status = CANCELLED.

{
   "data":{
      "_constructor":"AdvancedCriteria",
      "operator":"and",
      "criteria":[
         {
            "fieldName":"status",
            "operator":"equals",
            "value":"CANCELLED"
         }
      ]
   }
}

Securitybasic or X-PriceFx-jwt
Request
Request Body schema: application/json
endRow
number
Default: 300

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

oldValues
any
operationType
string non-empty
startRow
number

The number of the first row that defines the start of the result set's returned objects. Use this parameter if you want to implement paging for results.

textMatchStyle
string non-empty
object
_constructor
string non-empty
operator
string non-empty
Array of objects non-empty unique
Array (non-empty)
fieldName
string non-empty
operator
string non-empty

Specify an operator of the filter criteria.

Possible values: "equals" "iEquals" "notEqual" "iNotEqual" "isNull" "notNull" "contains" "iContains" "containsPattern" "iContainsPattern" "notContains" "iNotContains" "startsWith" "iStartsWith" "notStartsWith" "iNotStartsWith" "endsWith" "iEndsWith" "notEndsWith" "iNotEndsWith" … 4 more
value
string non-empty
Responses
200

OK

Response Schema: application/json
object
status
number
startRow
number
node
string non-empty
csrfToken
string non-empty
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
label
string non-empty
calculationMessages
string non-empty
numberOfItems
number
keepManualOverrides
boolean
writeOnlyChangedItems
boolean
configuration
string non-empty
numberOfApprovedItems
number
numberOfOpenItems
number
numberOfDeniedItems
number
numberOfSubmittedItems
number
numberOfAutoApprovedItems
number
priceGridType
string non-empty
createdByName
string non-empty
lastUpdateByName
string non-empty
updateDate
string non-empty
updatedBy
number
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
status
string non-empty
calculationStartDate
string non-empty
calculationDate
string non-empty
partialCalculationDate
string non-empty
id
number
endRow
number
Default: 300

The number of the end row that defines the end of the result set's returned objects. Use this parameter if you want to implement paging for results.

Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "status",
        • "operator": "equals",
        • "value": "READY"
        }
      ]
    }
}
Response samples
application/json
{
  • "response": {
    • "status": 0,
    • "startRow": 0,
    • "node": "string",
    • "csrfToken": "string",
    • "data": [
      • {
        • "version": 0,
        • "typedId": "string",
        • "label": "string",
        • "calculationMessages": "string",
        • "numberOfItems": 0,
        • "keepManualOverrides": true,
        • "writeOnlyChangedItems": true,
        • "configuration": "string",
        • "numberOfApprovedItems": 0,
        • "numberOfOpenItems": 0,
        • "numberOfDeniedItems": 0,
        • "numberOfSubmittedItems": 0,
        • "numberOfAutoApprovedItems": 0,
        • "priceGridType": "string",
        • "createdByName": "string",
        • "lastUpdateByName": "string",
        • "updateDate": "string",
        • "updatedBy": 0,
        • "createDate": "string",
        • "createdBy": 0,
        • "lastUpdateDate": "string",
        • "lastUpdateBy": 0,
        • "status": "string",
        • "calculationStartDate": "string",
        • "calculationDate": "string",
        • "partialCalculationDate": "string",
        • "id": 0
        }
      ],
    • "endRow": 300
    }
}