Project

General

Profile

Actions

Feature #1402

closed

API: CSV export in API

Added by Bernhard Koschiček-Krombholz over 3 years ago. Updated about 3 years ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
Start date:
2018-11-30
Estimated time:
(Total: 0.00 h)

Description

The CSV export will move to the API, but can still be requested in the backend/UI.

It should be possible to:
  • Download the Database as it is now possible (is this really needed, if current export is working fine?)
Done:
  • export one entity
  • include types
  • include relations
  • include dates
  • include coordinates
  • export all entities from one code, system_class and cidoc_class

Subtasks 1 (0 open1 closed)

Feature #963: API: Add type of places to exportClosedBernhard Koschiček-Krombholz2018-11-30Actions

Related issues 1 (0 open1 closed)

Related to OpenAtlas - Feature #1398: Compress SQL export filesClosedAlexander Watzinger2020-10-21Actions
Actions #1

Updated by Alexander Watzinger over 3 years ago

Actions #2

Updated by Bernhard Koschiček-Krombholz about 3 years ago

  • Status changed from Assigned to In Progress
Actions #3

Updated by Bernhard Koschiček-Krombholz about 3 years ago

  • Description updated (diff)

Single entity export in csv is now possible.
The API Endpoint is /entity with the parameter ?export=csv (e.g. /api/0.2/entity/19947?export=csv)

Also a button was added for the entity view if the API module is activated.

Currently are these field available:
  • id
  • name
  • description
  • begin_from
  • begin_to
  • begin_comment
  • end_from
  • end_to
  • end_comment
  • cidoc_class
  • system_class
  • note
  • geom_type
  • coordinates
Additionally, all linked entities and types are summarized under the type name and separeted by |, e.g.:
  • has_type: Deserted Village: agridion, selište | Ethnonym of the Vlachs
  • is_identified_by: Grammos | Gramosta | Gramostea | Gramoz | Gramozi | Γραμμουστα | Γραμος | Грамос
  • is_referred_to_by: Court Register of Sicil 1622 | Register of nahie Chroupichta 1568/69 I. | Register of nahie Chroupichta 1568/69 II. | Register of nahie Chroupichta 1568/69 III

I would appreciate feedback, if this is useful and if other information should be included.

Actions #4

Updated by Bernhard Koschiček-Krombholz about 3 years ago

  • Description updated (diff)
Actions #5

Updated by Bernhard Koschiček-Krombholz about 3 years ago

  • Description updated (diff)
  • Status changed from In Progress to Resolved
  • Target version changed from 208 to 6.1.0

Now also code, system_class and cidoc_class can be exported into csv.

Next steps would be to make modifications to the UI, so a user can use the functions.

All these endpoints also supports the common API parameter, like sorting, filtering, limiting the result etc. With this it could be possible to build dropdown menus for the user to select their wishes.

Actions #6

Updated by Alexander Watzinger about 3 years ago

Can this be closed? Just asking because it's already in 6.1.0 of roadmap.

Actions #7

Updated by Bernhard Koschiček-Krombholz about 3 years ago

  • Status changed from Resolved to Closed

From the API point of view, yes, if we can agree, that the existing export stays as it is. I can make a new ticket for the UI implementation.

Actions

Also available in: Atom PDF