Get Report Groups
post
/config/sim/v1/setup/getReportGroups
Gets all the Report Groups configured
Request
Supported Media Types
- application/json
- multipart/form-data
The input Body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
Objects included in the response.Example:
hierUnitId -
includeAll:
string
This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except
Ext values. If 'detailed' is specified, The response contains all the properties of the object. Example:detailed -
languages:
string
If specified, limits the translated strings returned.Example:
en-US, es-ES, es-MX -
limit:
integer
If using paging, number of results returned in this page.Example:
10 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of Report Groups.
Root Schema : ReportGroupsGetResponsev1
Type:
Show Source
object-
count:
integer
Current response record count.Example:
9 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Report Groups objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Report Groups objects of the organization.
Show Source
-
Array of:
object ReportGroupsResponsev1
Model for Report Groups Object
Nested Schema : ReportGroupsResponsev1
Type:
objectModel for Report Groups Object
Show Source
-
hierUnitId:
integer
Unique reference of the hierarchy unit where the Report Groups is configuredExample:
3599 -
hierUnitName:
object hierUnitName
A string that contains translations of hierarchy unit name into multiple languages
-
hierUnitObjNum:
integer
Object number of the hierarchy unit where the Report Groups is configuredExample:
26 -
name:
object name
A group of string objects representing the name of the Report Group in configured languages
-
objectNum:
integer
Object Number of the Report Groups.Example:
1 -
options:
string
A string value of 0s & 1s of length 16 representing the enablement or disablement of the options associated with the Report GroupsExample:
1000000000000000 -
optionsExt:
object optionsExt
An object containing the descriptive option list
-
type:
integer
Type of the report group; 0 - None; 1 - Tender / Media; 2 - Discount; 3 - Service ChargeExample:
1
Nested Schema : hierUnitName
Type:
objectA string that contains translations of hierarchy unit name into multiple languages
Example:
{
"en-US":"Property",
"de-DE":"Eigentum",
"es-MX":"Propiedad"
}Nested Schema : name
Type:
objectA group of string objects representing the name of the Report Group in configured languages
Example:
{
"en-US":"Routing Group",
"de-DE":"Routing-Gruppe"
}Nested Schema : optionsExt
Type:
objectAn object containing the descriptive option list
Show Source
-
depositTypeOfTenderMedia:
integer
A Boolean flag indicating to prevent the deposit type of tenders in this group from appearing on reports.Applicable only if type = 1Example:
1 -
dontDisplayForBlindDropReports:
integer
A Boolean flag indicating to prevent tenders in this group from appearing on reports. Applicable only if type = 1Example:
1 -
dontIncludeInDiscountBreakdownSection:
integer
A Boolean flag indicating to omit the discount group from the Discount Breakdown section of reports.Applicable only if type = 2Example:
1 -
dontIncludeInSvcChgBreakdownSection:
integer
A Boolean flag indicating to omit the service charge group from the Service Charge Breakdown section of reports.Applicable only if type = 3Example:
1 -
dontIncludeInTenderBreakdownSection:
integer
A Boolean flag indicating to omit the tender group from the Tender Breakdown section of reports. Applicable only if type = 1Example:
1 -
includeInBankDueSection:
integer
A Boolean flag indicating to show tenders in the group in the Bank Due section of reports.Applicable only if type = 1Example:
1 -
subtractInBankDueSection:
integer
A Boolean flag indicating to subtract tenders in the group in the Bank Due section of reports. You must also select Include in Bank Due section. Applicable only if type = 1Example:
1