Project

General

Profile

Feature #1402

API: CSV export in API

Added by Bernhard Koschicek 7 months ago. Updated about 1 month ago.

Status:
Closed
Priority:
Low
Assignee:
Bernhard Koschicek
Category:
API
Target version:
6.1.0
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

Feature #963: API: Add type of places to exportClosedBernhard KoschicekActions

Related issues

Related to Feature #1398: Compress SQL export filesClosed2020-10-21Actions

History

#1

Updated by Alexander Watzinger 7 months ago

#2

Updated by Bernhard Koschicek about 2 months ago

  • Status changed from Assigned to In Progress
#3

Updated by Bernhard Koschicek about 2 months 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.

#4

Updated by Bernhard Koschicek about 2 months ago

  • Description updated (diff)
#5

Updated by Bernhard Koschicek about 2 months ago

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

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.

#6

Updated by Alexander Watzinger about 2 months ago

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

#7

Updated by Bernhard Koschicek about 2 months 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.

Also available in: Atom PDF