Update Create IO API

Author: melaniekung

dev-manual/api/create-io.rst

@@ -8,55 +8,288 @@ Create information object endpoint
 
 This endpoint will allow creating an :term:`information object`.
 
-The following fields can be in the body of the request for the information
-object to be created:
-
-  - identifier
-  - level_of_description_id
-  - title
-  - description
-  - format
-  - source
-  - rights
-  - names
-  - dates
-  - notes
-  - types
-  - level_of_description
-
-In addition, it can also accept a ``parent_id`` or a ``parent_slug`` field to
-add the new information object as a child of an existing one.
-
-The newly created information object uses the default publication status
-in the settings, unless the user for the given API key does not have the
-permissions to publish in which case the publication status will be set
-to draft.
+The fields used in the body of the request for the information object
+correspond to the header fields used in ISAD CSV imports, see :ref:`csv-import`.
+
+Field parameters
+================
+
+Parent information object
+-------------------------
+
+``parent_slug`` OR ``parent_id`` - slug or id of the parent information object
+to add the new information object as a child of an existing one. If neither is
+provided, the new information object will be created under the root.
+
+Free text fields
+----------------
+
+``title``
+``identifier``
+``level_of_description``
+``scopeAndContent``
+``extentAndMedium``
+``locationOfOriginals``
+``locationOfCopies``
+``accessConditions``
+``archivalHistory``
+``acquisition``
+``revisionHistory``
+``arrangement``
+``accruals``
+``sources``
+``appraisal``
+``reproductionConditions``
+``relatedUnitsOfDescription``
+``languageNote``
+``publicationNote``
+``generalNote``
+``archivistNote``
+``descriptionIdentifier``
+``institutionResponsibleIdentifier``
+``rules``
+``physicalCharacteristics``
+
+.. code-block:: json
+
+   "title": "Example Title"
+
+Digital objects
+---------------
+
+``digitalObjectURI`` - URL to an external digital object
+
+.. code-block:: json
+
+   "digitalObjectURI": "https://www.example.com/myfile.pdf"
+
+``digitalObjectPath`` - File system path to a local file to be imported as a
+digital object
+
+.. code-block:: json
+
+   "digitalObjectPath": "/path/to/myfile.pdf"
+
+Publication and description status
+-----------------------------------
+
+``publicationStatus`` - Set publication status: ``draft`` or ``published``
+
+.. code-block:: json
+
+   "publicationStatus": "published"
+
+``descriptionStatusId`` - Set description status: ``final``, ``draft`` or ``revised``
+
+.. code-block:: json
+
+   "descriptionStatusId": "final"
+
+``descriptionDetailId`` - Set description detail level: ``full``, ``minimal`` or
+``partial``
+
+.. code-block:: json
+
+   "descriptionDetailId": "full"
+
+Language and script fields
+---------------------------
+
+``language`` - Two-letter ISO 639-1 language code(s), pipe-separated for multiple
+values
+
+``languageOfDescription`` - Two-letter ISO 639-1 language code(s), for the
+description itself, pipe-separated for multiple values
+
+``script`` - Four-letter ISO 15924 script code(s), pipe-separated for multiple
+values
+
+``scriptOfDescription`` - Four-letter ISO 15924 script code(s), for the
+description itself, pipe-separated for multiple values
+
+.. code-block:: json
+
+    "language": "en|fr"
+    "script": "Arab|Latn"
+
+Name access points
+------------------
+
+``nameAccessPoints`` - Link actor as name access points
+
+Required fields:
+  - ``type_id`` - Event type term ID OR ``type`` - Event type name: ``corporate``,  ``family``, ``person``
+  - ``actor_id`` - Existing actor ID OR ``authorized_form_of_name`` - Name to create new actor
+
+.. code-block:: json
+
+   "nameAccessPoints": {
+     "type": "person",
+     "authorized_form_of_name": "John Smith"
+   }
+
+Access points
+-------------
+
+``placeAccessPoints`` - Array of place terms to link
+``genreAccessPoints`` - Array of genre terms to link
+``subjectAccessPoints`` - Array of subject terms to link
+
+Each item can include:
+  - ``id`` - ID of existing term
+  - ``name`` - Name of place/genre/subject (will create new term if not found)
+
+.. code-block:: json
+
+   "placeAccessPoints": [
+     {"name": "Vancouver"},
+     {"id": 234}
+   ]
+
+Dates
+-----
+
+``dates`` - Array of date information
+
+Each date object can include:
+  - ``start_date`` - Start date (optional)
+  - ``end_date`` - End date (optional)
+  - ``date`` - Display date (optional)
+  - ``type`` - Date type: ``creation`` (default) or ``accumulation``
+
+.. code-block:: json
+
+   "dates": [
+     {
+       "start_date": "2020-01-01",
+       "end_date": "2020-12-31",
+       "date": "2020",
+       "type": "creation"
+     }
+   ]
+
+Actor
+-----
+
+``actor`` - Link an actor with an event relationship
+
+Can include:
+  - ``id`` - Existing actor ID OR ``authorized_form_of_name`` - Actor name (will create new actor if not found)
+  - ``history`` - Actor history (optional)
+  - ``event_type_id`` - Event type term ID (optional, defaults to creation)
+
+.. code-block:: json
+
+   "actor": {
+     "authorized_form_of_name": "Jane Doe",
+     "history": "Photographer active 1990-2020",
+     "event_type_id": 111
+   }
+
+Repository
+----------
+
+``repository`` - Link to a repository
+
+Must include one of:
+  - ``slug`` - Slug of existing repository OR ``id`` - ID of existing repository
+  - ``name`` - Name for new repository (will always create a new repository)
+
+.. code-block:: json
+
+   "repository": {
+     "slug": "example-archives"
+   }
+
+Accession numbers
+-----------------
+
+``accessionNumber`` - Single accession number or array of accession numbers to link
+
+.. code-block:: json
+
+   "accessionNumber": "2024-001"
+
+or
+
+.. code-block:: json
+
+   "accessionNumber": ["2024-001", "2024-002"]
+
+Alternative identifiers
+-----------------------
+
+``alternativeIds`` - Object with alternative identifier values as keys and labels as values
+
+.. code-block:: json
+
+   "alternativeIds": {
+     "alternativeId":"alternativeLabel",
+     "XYZ789": "Legacy identifier"
+   }
+
+Level of description
+--------------------
+
+``level_of_description_id`` - Term ID for level of description
+
+.. code-block:: json
+
+   "level_of_description_id": 123
+
+OR
+
+``level_of_description`` - Level of description name (will be matched against existing terms)
+
+.. code-block:: json
+
+   "level_of_description": "Item"
 
 .. _create-io-ex-req:
 
 Example request
 ===============
 
-.. code-block:: none
+.. code-block:: bash
 
-   curl -v -X POST http://localhost:63001/api/informationobjects -H 'Content-Type: application/json' -H 'REST-API-Key: 3e136949f7b9b915' -d '{"parent_slug": "example-fonds","title": "Test API Fonds","identifier": "I1","description": "Example description","level_of_description": "Item"}'
+   curl -v -X POST http://localhost:63001/api/informationobjects \
+     -H 'Content-Type: application/json' \
+     -H 'REST-API-Key: 3e136949f7b9b915' \
+     -d '{
+       "parent_slug": "example-fonds",
+       "title": "Test API Fonds",
+       "identifier": "I1",
+       "scopeAndContent": "Example description",
+       "level_of_description": "Item",
+       "dates": [
+         {
+           "start_date": "2024-01-01",
+           "end_date": "2024-12-31",
+           "type": "creation"
+         }
+       ],
+       "subjectAccessPoints": [
+         {"name": "History"}
+       ]
+     }'
 
 .. _create-io-ex-resp:
 
 Example response
 ================
 
-Example response is truncated and edited for readability.
-
-.. code-block:: none
+.. code-block:: bash
 
    HTTP/1.1 201 Created
    Content-Type: application/json; charset=utf-8
    Transfer-Encoding: chunked
    Connection: keep-alive
    Cache-Control: private
 
-   {"id": 2004281, "slug": "test-api-fonds", "parent_id": 2004230}
-
+   {
+     "id": 2004281,
+     "slug": "test-api-fonds",
+     "parent_id": 2004230
+   }
 
-:ref:`Back to top <api-create-io>`
+:ref:`Back to top <api-create-io>`