Project

General

Profile

Actions

Feature #2681

closed

API: Additional columns for sorting

Added by Bernhard Koschiček-Krombholz about 1 month ago. Updated 29 days ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
Start date:
2025-11-18
Estimated time:

Description

For #2300 we need to add more column options for sorting asc/desc.

The following columns are allowed in the table:

All done and working
Need opinion
Need review/additional work
Not needed to filter in my opinion
table_columns Notes / Errors
activity Not relevant (only used for user views)
begin Done
checkbox Done
class Done (also available under 'system_class')
created Done
creator Done
content / description Done
count Works, but is currently not triggered by the API call. Find use case except Ext. Reference System
default_precision Not relevant (only used at reference system overview)
end Done
example_id Not relevant (only used at reference system overview)
extension Done
external_reference_match Find use case
icon Done
license holder Done
main image Does not need a filter
name Done
page Needs a link
overlay Does not need a filter
public Done
range Ignore it for now (usage is situation dependent but it's always an entity)
remove Does not need a filter
set logo Does not need a filter
size Done
type / license Done
type_link Need to handle links first (is for actors)
update Does not need a filter
resolver_url / website_url Not relevant (only used at reference system overview)
value Needs a link

Related issues 3 (1 open2 closed)

Related to OpenAtlas - Feature #2300: Load form tables dynamicallyIn ProgressKatharina Wünsche2025-01-27Actions
Related to OpenAtlas - Feature #2478: API: Format for tablesClosedBernhard Koschiček-Krombholz2025-02-12Actions
Related to OpenAtlas - Feature #2657: API: 4.11.0ClosedBernhard Koschiček-Krombholz2025-10-28Actions
Actions #1

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)

I have problems getting all the data needed for the reference systems table in a good way. But since this data is never large, we can stay at this table with the normal call.

Actions #2

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)
Actions #3

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)

The table column which only appears at links need to be handled somewhat separately. I think a new parameter is needed, like origin. So if you want to have the sources of a person with the id=1234, you need to call something like: /api/table_rows/system_classes=source?origin=1234. But thinking about this, this will not work, because we have now split everything into separated tabs. Okay, I have to think about this....

Actions #4

Updated by Bernhard Koschiček-Krombholz about 1 month ago

Actions #5

Updated by Alexander Watzinger about 1 month ago

Thank you @Bernhard Koschiček-Krombholz for this nice overview. I try to comment on some but please keep in mind that relations are still in development and things might change.
Also I just pushed an updated feature/new_classes branch with 99.76% coverage and updated the demo-dev with it for testing.

  • activity - this was an artifact of the former system (see https://demo.openatlas.eu/entity/6458#tab-actor) and is not needed anymore.
  • checkbox - I don't think we have cases where a mix of checked and unchecked are shown initially when loading a form. But, as discussed, manually checked boxes shouldn't get lost when navigating a table.
  • count - it might have no API use but being able to sort according to count has definitely value for users
  • domain - this is part of the actor/actor relation functions and will certainly be rewritten. Better ignore for now.
  • default_precision, example_id - these are only used at the reference system overview (see e.g. https://demo-dev.openatlas.eu/index/reference_system) and I'm not sure how relevant this is.
Actions #6

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)

Thank you, @Alexander Watzinger, for the clarification.

  • checkbox - e.g. the artifacts of a movement, if some artifacts are prefilled there will be a mix. There will be additional parameter for the table_rows call, to get the checked IDs first. The question is, if you can filter in the table if the checkbox is checked or if the checked ones are always the first ones.
  • count - yes, I just wanted to mark, that no table call currently fill the count, because of the generic way how the entities are requested. There is still work to be done.
Actions #7

Updated by Alexander Watzinger about 1 month ago

checkbox - e.g. the artifacts of a movement, if some artifacts are prefilled there will be a mix

You are right and thanks for that input. I was wondering about it but didn't thought of that use case.

Actions #8

Updated by Alexander Watzinger about 1 month ago

Update from side:
  • domain was removed. It's now just name like with other link tables.
  • involvement / function / relation was replaced with a more generic type_link column.
Actions #9

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)

Thank you for your update. I updated the table to the new cases.

Actions #10

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)

Updated table. We will keep the tab tables static, so no need to include the relations.

And set default filter to checkbox and then name, if checkbox is available.

Actions #11

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)
Actions #12

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)
Actions #13

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)
Actions #14

Updated by Bernhard Koschiček-Krombholz about 1 month ago

Actions #15

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)
Actions #16

Updated by Bernhard Koschiček-Krombholz about 1 month ago

  • Description updated (diff)
  • Status changed from Acknowledged to Closed

I scratched multiple parameters. The default is always name, so if it is sorted by type, the entities of one type will be sorted by name.

Actions #17

Updated by Bernhard Koschiček-Krombholz 29 days ago

Actions #18

Updated by Bernhard Koschiček-Krombholz 29 days ago

  • Target version changed from 9.2.0 to 9.0.0
Actions #19

Updated by Alexander Watzinger 29 days ago

About:

'count' Works, but is currently not triggered by the API call. Find use case except Ext. Reference System

Another use case would be a type view, see e.g. https://demo-dev.openatlas.eu/entity/26324#tab-subs.
It is also used at the start page for classes and in model views, e.g OpenAtlas class view (https://demo-dev.openatlas.eu/overview/model/openatlas_class_index), but I'm not sure how relevant they are for this issues.

Actions #20

Updated by Alexander Watzinger 29 days ago

  • Subject changed from API: additional columns for sorting to API: Additional columns for sorting
  • Description updated (diff)
Actions

Also available in: Atom PDF