Common Entities

Creating an ExternalID (EksternId) linked to a CaseFile (Saksmappe)

ExternalID (EksterId) are created with the POST /transaction operation. They have two important fields which should be set - eksterntSystem and eksternID. In the same transaction creating the ExternalID (EksternId) it should be associated to another entitity in the archive structure.

  • transaction::save - new ExternalID (EksterId) for Integrating System and integrating system ID = ISID:0000004573
  • transaction::link - link the new ExternalID (EksterId) to the existing CaseFile (Saksmappe).

As a result of the transaction new ExternalID (EksternId) is created with ID = 3827083

      Request

POST https://<documaster-instance>.local.documaster.tech:8083/rms/api/public/noark5/v1/transaction HTTP/1.1
... 
Authorization: Bearer {{accessTokenIntegrator}}
Content-Type: application/json
X-Documaster-Error-Response-Type: application/json

{
    "actions": [
        {
            "action": "save",
            "type": "EksternId",
            "id": "eksternId-temp-id-1",
            "fields": {
                "eksterntSystem": "Integrating System",
                "eksternID": "ISID:0000004573"
            }
        },
        {
            "action": "link",
            "type": "EksternId",
            "id": "eksternId-temp-id-1",
            "ref": "refMappe",
            "linkToId": "633"
        }
    ]
}

      Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "saved": {
    "eksternId-temp-id-1": {
      "type": "EksternId",
      "id": "3827083",
      "version": "2",
      "fields": {
        "uuid": "8a8810a8-4b56-475e-877b-259f53d06768",
        "opprettetDato": "2022-11-08T08:12:13.785+0100",
        "opprettetAv": "Integrator",
        "opprettetAvBrukerIdent": "d730e776-c10f-4986-99d7-5fab7bf4c3ee",
        "eksterntSystem": "Integrating System",
        "eksternID": "ISID:0000004573"
      },
      "links": {
        "refMappe": 633
      }
    }
  }
}