POST v6/summary/download

Request Information

URI Parameters

None.

Body Parameters

SummaryInputModelv6
NameDescriptionTypeAdditional information
ModuleId

integer

None.

GridId

integer

None.

RecordId

integer

None.

FilterId

string

None.

PageNumber

integer

None.

RowsPerPage

integer

None.

InitialRequest

boolean

None.

FilterCriteria

Collection of SummaryFilterCriteriaModelv6

None.

SortCriteria

Collection of SummarySortCriteriaModelv6

None.

Request Formats

application/json, text/json

Sample:
{
  "moduleId": 1,
  "gridId": 1,
  "recordId": 1,
  "filterId": "sample string 2",
  "pageNumber": 3,
  "rowsPerPage": 4,
  "initialRequest": true,
  "filterCriteria": [
    {
      "columnName": "sample string 1",
      "operator": "sample string 2",
      "searchValue": "sample string 3",
      "combinationLogic": "sample string 4"
    },
    {
      "columnName": "sample string 1",
      "operator": "sample string 2",
      "searchValue": "sample string 3",
      "combinationLogic": "sample string 4"
    }
  ],
  "sortCriteria": [
    {
      "columnName": "sample string 1",
      "sortDirection": "sample string 2"
    },
    {
      "columnName": "sample string 1",
      "sortDirection": "sample string 2"
    }
  ]
}

Response Information

Resource Description

SummaryDownloadModelv6
NameDescriptionTypeAdditional information
Config

SummaryDownloadConfigModelv6

None.

Data

Collection of Object

None.

Response Formats

application/json, text/json

Sample:
{
  "config": {
    "idColumn": "sample string 1",
    "columns": [
      {
        "columnName": "sample string 1",
        "columnFormat": "sample string 2",
        "columnOrder": 3,
        "columnWidth": 4,
        "fieldName": "sample string 5",
        "isPrimaryDisplay": true,
        "isVisible": true,
        "isPrivate": true
      },
      {
        "columnName": "sample string 1",
        "columnFormat": "sample string 2",
        "columnOrder": 3,
        "columnWidth": 4,
        "fieldName": "sample string 5",
        "isPrimaryDisplay": true,
        "isVisible": true,
        "isPrivate": true
      }
    ]
  },
  "data": [
    {},
    {}
  ]
}