List Contracts

post/fetch/CT

Returns a list of Agreements and Promotions (formerly Contracts).

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

Example response

Response Schema: application/json
object
status
number
startRow
number
node
string non-empty
csrfToken
string
Array of objects non-empty unique
Array (non-empty)
version
number
typedId
string non-empty
uniqueName
string non-empty
label
string non-empty
targetDate
string non-empty
workflowStatus
string non-empty
lastUpdateByName
string non-empty
createdByName
string non-empty
calculationStatus
number
dirty
boolean
refreshInputs
boolean
numberOfAttachments
number
contractStatus
string non-empty
startDate
string non-empty
endDate
string non-empty
status
string non-empty
hasWorkflowHistory
boolean
createDate
string non-empty
createdBy
number
lastUpdateDate
string non-empty
lastUpdateBy
number
rootUniqueName
string non-empty
endRow
number
Request samples
application/json
{
  • "endRow": 300,
  • "oldValues": null,
  • "operationType": "fetch",
  • "startRow": 0,
  • "textMatchStyle": "exact",
  • "data": {
    • "_constructor": "AdvancedCriteria",
    • "operator": "and",
    • "criteria": [
      • {
        • "fieldName": "userGroupViewDetails",
        • "operator": "notEqual",
        • "value": "trash"
        },
      • {
        • "fieldName": "workflowStatus",
        • "operator": "equals",
        • "value": "APPROVED"
        }
      ]
    },
  • "sortBy": [
    • "-createDate"
    ]
}
Response samples
application/json
{
  • "response": {
    • "status": 0,
    • "startRow": 0,
    • "node": "<node>",
    • "csrfToken": "<token>",
    • "data": [
      • {
        • "version": 3,
        • "typedId": "170.CT",
        • "uniqueName": "C-170",
        • "label": "New Agreement & Promotion",
        • "targetDate": "2021-11-18",
        • "workflowStatus": "DRAFT",
        • "lastUpdateByName": "admin",
        • "createdByName": "admin",
        • "calculationStatus": 0,
        • "dirty": false,
        • "refreshInputs": false,
        • "numberOfAttachments": 0,
        • "contractStatus": "DRAFT",
        • "startDate": "2021-11-18",
        • "endDate": "2021-11-18",
        • "status": "DRAFT",
        • "hasWorkflowHistory": false,
        • "createDate": "2021-11-18T15:48:25",
        • "createdBy": 2147490696,
        • "lastUpdateDate": "2021-11-18T15:48:25",
        • "lastUpdateBy": 2147490696,
        • "rootUniqueName": "C-170"
        }
      ],
    • "endRow": 1
    }
}