added new parameter page

craws · Aug 8, 2023 · 2337976 · 2337976
1 parent 29605c8
commit 2337976
Show file tree

Hide file tree

Showing 3 changed files with 386 additions and 185 deletions.
diff --git a/sphinx/source/admin/arche.rst b/sphinx/source/admin/arche.rst
@@ -64,9 +64,9 @@ All necessary new types, persons etc. will be automatically created or added dur
 
 :doc:`/entity/type`
 ^^^^^^^^^^^^^^^^^^^
-* Custom hierarchy **Relevance** for :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`)
-* **Involvement** for :cidoc_entity:`E65 Creation<e65-creation>` and p:cidoc_entity:`E12 Production<e12-production>` event
-* Additional **License** :doc:`/entity/type` -> EXIF:Copyright
+- Custom hierarchy **Relevance** for :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`)
+- **Involvement** for :cidoc_entity:`E65 Creation<e65-creation>` and p:cidoc_entity:`E12 Production<e12-production>` event
+- Additional **License** :doc:`/entity/type` -> EXIF:Copyright
 
 :doc:`/entity/reference_system`
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -75,10 +75,10 @@ New :doc:`/entity/reference_system` named **ARCHE** is created with data provide
 
 :doc:`/entity/index`
 ^^^^^^^^^^^^^^^^^^^^
-* :doc:`/entity/artifact` (:cidoc_entity:`E22 Human-Made Object<e22-human-made-object>`): Graffito, name (IPTC:ObjectName), description (XMP:Description), linked (:cidoc_property:`P67<p67-refers-to>`) to **ARCHE** :doc:`/entity/reference_system` (:cidoc_entity:`E32<e32-Authority-Document>`)
-* :cidoc_entity:`E53 Place<e53-place>`: Location of Graffito, linked (:cidoc_property:`P53<p53-has-former-or-current-location>`) to :doc:`/entity/artifact` (EXIF:GPSLatitude, EXIF:GPSLongitude)
-* :doc:`/entity/event` (:cidoc_entity:`E12 Production<e12-production>`): Date (EXIF:CreateDate) linked (:cidoc_property:`P11<p11-had-participant>`) to :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`) and linked (:cidoc_property:`P108<p108-has-produced>`) to :doc:`/entity/artifact`
-* :doc:`/entity/event` (:cidoc_entity:`E65 Creation<e65-creation>`): Date (EXIF:CreateDate) linked (:cidoc_property:`P14<p14-carried-out-by>`) to :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`) and linked (:cidoc_property:`P92<p92-brought-into-existence>`) to :doc:`/entity/file`
-* :doc:`/entity/file` (:cidoc_entity:`E31 Document<e31-document>`): linked (:cidoc_property:`P2<p2-has-type>`) to **License** :doc:`/entity/type` (EXIF:Copyright), linked (:cidoc_property:`P67<p67-refers-to>`) to :doc:`/entity/artifact`
-* :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`): name (EXIF:Artist, etc.), linked (:cidoc_property:`P2<p2-has-type>`) to :doc:`/entity/type` **Relevance**
+- :doc:`/entity/artifact` (:cidoc_entity:`E22 Human-Made Object<e22-human-made-object>`): Graffito, name (IPTC:ObjectName), description (XMP:Description), linked (:cidoc_property:`P67<p67-refers-to>`) to **ARCHE** :doc:`/entity/reference_system` (:cidoc_entity:`E32<e32-Authority-Document>`)
+- :cidoc_entity:`E53 Place<e53-place>`: Location of Graffito, linked (:cidoc_property:`P53<p53-has-former-or-current-location>`) to :doc:`/entity/artifact` (EXIF:GPSLatitude, EXIF:GPSLongitude)
+- :doc:`/entity/event` (:cidoc_entity:`E12 Production<e12-production>`): Date (EXIF:CreateDate) linked (:cidoc_property:`P11<p11-had-participant>`) to :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`) and linked (:cidoc_property:`P108<p108-has-produced>`) to :doc:`/entity/artifact`
+- :doc:`/entity/event` (:cidoc_entity:`E65 Creation<e65-creation>`): Date (EXIF:CreateDate) linked (:cidoc_property:`P14<p14-carried-out-by>`) to :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`) and linked (:cidoc_property:`P92<p92-brought-into-existence>`) to :doc:`/entity/file`
+- :doc:`/entity/file` (:cidoc_entity:`E31 Document<e31-document>`): linked (:cidoc_property:`P2<p2-has-type>`) to **License** :doc:`/entity/type` (EXIF:Copyright), linked (:cidoc_property:`P67<p67-refers-to>`) to :doc:`/entity/artifact`
+- :doc:`/entity/actor` (:cidoc_entity:`E21 Person<e21-person>`): name (EXIF:Artist, etc.), linked (:cidoc_property:`P2<p2-has-type>`) to :doc:`/entity/type` **Relevance**
 
diff --git a/sphinx/source/technical/api.rst b/sphinx/source/technical/api.rst
@@ -244,8 +244,8 @@ Endpoint definition
 
 Two different methods are provided to access the OpenAtlas API:
 
-* Access via an OpenAtlas instance's user interface
-* Access via another application if settings allow for it
+- Access via an OpenAtlas instance's user interface
+- Access via another application if settings allow for it
 
 Endpoints provide information about one or more entities in the OpenAtlas
 instance. The requested information is provided in Linked Places format
@@ -263,181 +263,18 @@ GeoJSON or RDFs, derived from the LPF data, can be accessed.
 Parameter definition
 --------------------
 
-.. list-table::
-   :widths: 20 15 45 20
-   :header-rows: 1
+Used to structure additional information for any endpoint.
+They are added to the end of an URL after the "**?**" symbol
+(demo.openatlas.eu/api/0.3/entity/5117?download=true) and are connected with the "**&**" sign.
+For more information see this
+`article <https://www.botify.com/learn/basics/what-are-url-parameters#:~:text=URL%20parameters%20(also%20known%20as,by%20the%20'%26'%20symbol.>`_.
+
+
+.. toctree::
+   :maxdepth: 1
+
+   api_parameter
 
-   * - Parameter
-     - Format
-     - Description
-     - Values
-   * - cidoc_class/cidoc_classes/cidoc-class/cidoc-classes
-     - string
-     - CIDOC CRM class code (e.g. E21)
-     -
-   * - column
-     - string
-     - Results will be sorted by the given column
-     - * ID
-       * classCode
-       * name
-       * description
-       * created
-       * modified
-       * systemClass
-       * beginFrom
-       * beginTo
-       * endFrom
-       * endTo
-   * - count
-     - boolean
-     - Returns the total count of results as integer
-     - True/False
-   * - download
-     - boolean
-     - Triggers file download of the requested data in a file
-     - True/False
-   * - entities
-     - integer
-     - Specific entity ID
-     -
-   * - export
-     - string
-     - Results will be downloaded in the given format
-     - * csv
-       * csvNetwork
-   * - first
-     - integer
-     - List of results starting with given ID
-     -
-   * - format
-     - string
-     - Select a preferred output format
-     -  * lp
-        * geojson
-        * geojson-v2
-        * pretty-xml
-        * n3
-        * turtle
-        * nt
-        * xml (subunits endpoint can only handle xml)
-   * - geometry
-     - string
-     - Select a preferred geometry
-     -  * gisAll
-        * gisPointAll
-        * gisPointSupers
-        * gisPointSubs
-        * gisPointSibling
-        * gisLineAll
-        * gisPolygonAll
-   * - id
-     - integer
-     - Specific entity ID in OpenAtlas instance
-     -
-   * - image-size/image_size
-     - string
-     - Select the size category for the displayed image (can be modified in production.py)
-     - * thumbnail
-       * table
-   * - lang
-     - string
-     - Select an output language
-     - * en
-       * de
-   * - last
-     - integer
-     - JSON list of results start with entity after given ID
-     -
-   * - latest
-     - integer
-     - Number of last database entries to be returned; only numbers between 1 and 100 are valid
-     - 1 - 100
-   * - limit
-     - integer
-     - Number of entities returned per page
-     - * 0 corresponds to "no limit set"
-       * Default is set to 20 entities
-   * - none
-     -
-     - No parameters are required
-     -
-   * - page
-     - integer
-     - Jump to chosen page
-     -
-   * - relation_type/relation-type
-     - string
-     - Select which relations are shown
-     - E.g. P53
-   * - search
-     - string
-     - Search request with AND/OR logic
-     -
-   * - show
-     - string
-     - Select a key to be shown. If using "not", no other keys will be displayed.
-     -  * description
-        * depictions
-        * geometry
-        * links
-        * names
-        * none
-        * relations
-        * types
-        * when
-   * - sort
-     - string
-     - Results will be sorted asc/desc (default column is name)
-     -  * asc
-        * desc
-   * - system_class/system_classes/system-class/system-classes
-     - string
-     - Needs to be one of the OpenAtlas system classes
-     -  * all
-        * administrative_unit
-        * type
-        * acquisition
-        * activity
-        * actor_actor_relation
-        * actor_function
-        * appellation
-        * artifact
-        * bibliography
-        * edition
-        * external_reference
-        * feature
-        * file
-        * group
-        * human_remains
-        * involvement
-        * move
-        * object_location
-        * person
-        * place
-        * production
-        * reference_system
-        * source
-        * source_translation
-        * stratigraphic_unit
-   * - type_id/type-id
-     - integer
-     - Output will be filtered by chosen type ID and only entities with this type ID will be displayed; the relation is in logical OR
-     -
-   * - view_class/view_classes/view-class/view-classes
-     - string
-     - Needs to be one of the OpenAtlas menu items
-     -  * actor
-        * all
-        * artifact
-        * event
-        * file
-        * object
-        * place
-        * reference
-        * source
-        * source_translation
-        * type
 
 
 Error handling