Typové příklady rozšířeného dotazování Web API (JSON Object)

Výběr kolekce faktur, každý objekt faktury bude obsahovat ID, částku (Amount) a DisplayName, které je složené pomocí polí načtených z provázaných objektů. Jedná se o rychlejší variantu než je uvedena v prvním příkladu, ve kterém je použita nepersistentní položka (DisplayName); jak již bylo zmíněno výše, nepersistentní položky znamenají degradaci výkonu.

Klauzule select je v rozšířené variantě dotazování reprezentována JSON polem obsahujícím jednotlivé požadované fieldy. Fieldy samotné jsou reprezentovány buď řetězcem obsahujícím výraz nebo výrazovým objektem.

POST http://localhost:81/data/query

Tělo požadavku:

{
  "class": "issuedinvoices",
  "select": [
	"ID",
	"Amount",
	{ "name": "DocNumber", "value": "DocQueue_ID.Code || '-' || OrdNumber || '/' || Period_ID.Code" }
  ]
}

Výběr z agendy Adresář firem, pro výběr fieldu FirmOffices je využit výrazový objekt, pro výběr bankovních účtů (field BankAccounts, na BO firmy jsou bank. účty vedeny jako řádky Rows) je navíc použit specifikační objekt.

POST http://localhost:81/data/query

Tělo požadavku:

{
  "class": "firms",
  "select": [
	"ID",
	"Code",
	"Name",
	{ "name": "FirmOffices",
	  "value": ["Name"]
	},
	{ "name": "BankAccounts",
	  "value": {
	  "field": "Rows",
	  "query": {
		"select": ["ID", "Name", "BankAccount"]
	  }
	}
  }
 ]
}

Výběr kolekce ceníků, ke každému ceníku je ve výsledku dotazu zahrnut seznam firem, které jej mají nastavený. Jedná se o ukázku použití výrazového objektu v rámci selectu, možnosti využitelné pouze v rozšířené variantě dotazování. Všimněte si v klauzuli where vnořeného výrazového objektu použití :ID - reference na field nadřazeného BO v poddotazu. Pomocí takovéto syntaxe (:{název fieldu BO z nadřízeného dotazu}) lze do omezení (where) poddotazu dosazovat kontextuálně hodnoty z nadřazeného dotazu (pouze z nadřazeného dotazu). Tato možnost je důležitá ve chvíli, kdy je potřeba filtrovat za předem neznámé hodnoty. (Více viz Klauzule where s kontextuálními parametry.)

POST http://localhost:81/data/query

Tělo požadavku:

{
  "class": "pricelists",
  "select": [
	"ID", 
	"Code", 
	"Name",
	{
	  "name": "Firms",
	  "value":
	  {
		"class": "firms",
		"select": ["ID", "Code", "Name"],
		"where": "PriceList_ID = :ID"
	 }
     }
  ]
}

Výběr kolekce objednávek přijatých s použitím hodnoty ID, kdy vráceným objektem bude ID záznamu.

POST http://localhost:81/data/query

Tělo požadavku:

{
  "class": "receivedorders",
  "selectschema": "id"
}

Výběr z agendy objednávek přijatých za použití zpracování požadavků v mezipaměti (serverstate) a hodnoty expanded.

POST http://localhost:81/data/serverstate

Tělo požadavku:

{
    "cacheid": "",
    "type": "load",
    "data": {
        "class": "receivedorders",
        "object_id": "26W0000101",
        "query": {
            "selectschema": "expanded"
        }
    }
}

Výběr kolekce faktur vydaných, každý objekt faktury obsahuje částku (Amount) a objekt firmy, na kterou je faktura vystavena (Firm_ID). Faktury jsou řazeny dle kódu firmy, na kterou jsou vystaveny vzestupně, a následně podle částky sestupně.

POST http://localhost:81/data/query

Tělo požadavku:

{
  "class": "issuedinvoices",
  "select": [
	"Amount", 
	{
	  "name": "Firm_ID",
	  "value":
	  {
		"select": ["ID", "Code", "Name"]
	  }
   }
],
	"orderby": [
	  "Firm_ID.Code",
	  { "value": "Amount", "desc": true }
]
}

Získání trojice firem s největší celkovou fakturovanou částkou (Amount). Firmy jsou seřazeny podle této celkové částky sestupně (ukázka použití kombinace klauzulí orderby, groupby a take).

POST http://localhost:81/data/issuedinvoices/query

Tělo požadavku:

{
	"select": [
		{ "name": "Amount", "value": "Sum(Amount)" },
		{
			"name": "Firm_ID",
			"value":
				{
					"select": ["ID", "Code", "Name"]
				}
		}
	],
	"orderby": [
		{ "value": "Sum(Amount)", "desc": true }
	],
	"groupby": [
		"Firm_ID"
	],
	"take": 3
}

Ukázka použití funkce Floor, dotažení hodnoty amount na dokladu faktury vydané pro rok 2025 seskupený podle dní:

GET http://localhost:80/demo/issuedinvoices?select=floor(createdat$date), sum(amount), avg(amount), min(amount), max(amount)&where=CreatedAt$DATE+ge+'2025-01-01' and CreatedAt$DATE+le+'2025-12-31'&groupby=floor(createdat$date)"

Odpověď:

[
{
	"floor(createdat$date)": "2025-03-24T23:00:00.000Z",
	"sum(amount)": 154002.02,
	"avg(amount)": 77001.01,
	"min(amount)": 22014.01,
	"max(amount)": 131988.01
	},
	{
	"floor(createdat$date)": "2025-03-30T22:00:00.000Z",
	"sum(amount)": 32234.92,
	"avg(amount)": 16117.46,
	"min(amount)": 0,
	"max(amount)": 32234.92
	}
]