{"source":"utdanning","operation":"get_dbh_table_data","description":"Query a DBH table and return labeled rows. Signature: get_dbh_table_data(table_id: integer, required; filters: JSON object, required; group_by: string or list of string (comma-separated), optional, default None; sort_by: string or list of string (comma-separated), optional, default None; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0).","signature":"get_dbh_table_data(table_id: integer, required; filters: JSON object, required; group_by: string or list of string (comma-separated), optional, default None; sort_by: string or list of string (comma-separated), optional, default None; limit: integer, items, optional, default 25; offset: integer, items, optional, default 0)","parameters":[{"name":"table_id","type":"integer","schema":{"type":"integer"},"required":true,"default":null,"description":"Table id from list_dbh_tables(), e.g. 123.","unit":null},{"name":"filters","type":"object","schema":{"additionalProperties":true,"type":"object"},"required":true,"default":null,"description":"Dict of {variable: [values]}, variables from get_dbh_table_info(). At least one filter is required. Values are code strings; special forms: [\"*\"] = all values, [\"TOP(2)\"] = the 2 highest (e.g. latest years), [\"BETWEEN(2020,2024)\"] = an inclusive range. Example: {\"\u00c5rstall\": [\"TOP(2)\"], \"Institusjonskode\": [\"1110\"]}","unit":null},{"name":"group_by","type":"string","schema":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"required":false,"default":null,"description":"Variables to aggregate by, as a list, a JSON array or a comma-separated string, e.g. [\"Institusjonskode\", \"\u00c5rstall\"] or \"Institusjonskode,\u00c5rstall\". Required for aggregation tables (most Studentdata tables): measure columns are summed per combination. Omit for plain/code tables (the API's error says which is needed).","unit":null},{"name":"sort_by","type":"string","schema":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"required":false,"default":null,"description":"Variables to sort by (same forms as group_by); must be among group_by when grouping.","unit":null},{"name":"limit","type":"integer","schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"display_type":"integer","required":false,"default":25,"description":"Maximum list items returned by the gateway (default 25, maximum 100).","unit":"items"},{"name":"offset","type":"integer","schema":{"type":"integer","minimum":0,"default":0},"display_type":"integer","required":false,"default":0,"description":"Number of list items to skip before returning the page.","unit":"items"}],"json_get_url_template":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning/get_dbh_table_data?table_id={table_id}&filters={filters}&group_by={group_by}&sort_by={sort_by}&limit=25&offset=0","example_url":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning/get_dbh_table_data?table_id=123&filters=%7B%22Institusjonskode%22%3A+%5B%221150%22%5D%2C+%22%C3%85rstall%22%3A+%5B%222024%22%5D%7D&group_by=Institusjonskode%2C%C3%85rstall%2CSemester","schema_scope":"#/data in the successful operation envelope","response_schema":{"type":"object","properties":{"table_id":{"type":"integer"},"rows_total":{"type":"integer"},"truncated":{"type":"boolean"},"rows":{"type":"array","items":{"type":"object","additionalProperties":{"type":["string","number","boolean","null"]}}}},"additionalProperties":false,"required":["table_id","rows_total","truncated","rows"]},"response_schema_status":{"status":"declared","codegen_safe":true,"description":"Maintained response contract."},"entity_projection":{"status":"projected","entity_types":["education_unit"],"description":"Recognized records and stable operation identifiers are projected; an empty array means the successful payload contained no recognizable entity."},"error_contract":{"scope":"top-level HTTP error response; never part of a success payload","schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"retryable":{"type":"boolean"},"details":{"type":"object"}},"additionalProperties":false,"required":["code","message","retryable"]},"suggestion":{"type":"string"},"_meta":{"type":"object","properties":{"retrieved_at":{"type":"string","format":"date-time"},"language":{"type":"string","const":"en"},"content_languages":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"type":"object"}}},"required":["retrieved_at","language","content_languages","sources"]},"_links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"api_index":{"type":"string","format":"uri"},"feedback":{"type":"string","format":"uri"}},"required":["self","api_index","feedback"],"additionalProperties":false}},"additionalProperties":false,"required":["error","suggestion","_meta","_links"]},"statuses":{"400":{"codes":["MISSING_PARAMETER","INVALID_PARAMETER","INVALID_REQUEST"],"retryable":false},"404":{"codes":["SOURCE_NOT_FOUND","OPERATION_NOT_FOUND","ENTITY_NOT_FOUND"],"retryable":false},"429":{"codes":["RATE_LIMITED","GATEWAY_RATE_LIMITED"],"retryable":true},"503":{"codes":["SOURCE_UNAVAILABLE"],"retryable":true},"500":{"codes":["INTERNAL_ERROR"],"retryable":true}}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning/get_dbh_table_data","operation":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning/get_dbh_table_data","source":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"},"output_fields":["table_id","rows_total","truncated","rows"],"output_fields_truncated":false,"canonical_field_aliases":{},"response_example":{"source":"utdanning","operation":"get_dbh_table_data","parameters":{"table_id":123,"filters":"{\"Institusjonskode\": [\"1150\"], \"\u00c5rstall\": [\"2024\"]}","group_by":"Institusjonskode,\u00c5rstall,Semester","limit":25,"offset":0},"data":{"table_id":1,"rows_total":1,"truncated":true,"rows":[{"example_key":"example value"}]},"entities":[],"_meta":{"retrieved_at":"2026-01-15T12:00:00Z","language":"en","content_languages":["en"],"sources":[{"id":"utdanning","name":"Norwegian education data","description":"Schools, kindergartens, Udir statistics and higher-education data from DBH.","cache_ttl_seconds":300,"documentation":"https://data-nsr.udir.no/"}]},"_provenance":{"data":{"source":"utdanning","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning"},"entities":{"source":"utdanning","source_api":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning","derived_from":"#/data","description":"Normalized projection of data."}},"_links":{"self":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning/get_dbh_table_data","source":"https://allemannsdata.com/wiki/api/v1/kilder/utdanning","wiki":"https://allemannsdata.com/wiki/kilder/utdanning/get_dbh_table_data/","feedback":"https://allemannsdata.com/wiki/api/v1/feedback"}}}