swagger.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "Organisation Registry Backend API",
    "description": "Organisation Registry Backend API",
    "version": "1.0.0"
  },
  "paths": {
    "/api/hierarchy/types": {
      "get": {
        "summary": "GET hierarchy/types",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/hierarchyFilters": {
      "get": {
        "summary": "GET hierarchyFilters",
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "put": {
        "summary": "PUT api/hierarchyfilters",
        "operationId": "updateHierarchyFilter",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HierarchyFilter"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HierarchyFilter"
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "POST api/hierarchyfilters",
        "operationId": "addHierarchyFilter",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/HierarchyFilter"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/HierarchyFilter"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "DELETE api/hierarchyfilters",
        "operationId": "deleteHierarchyFilter",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HierarchyFilter"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/HierarchyFilter"
                }
              }
            }
          }
        }
      }
    },
    "/api/hierarchyFilters/{date}": {
      "get": {
        "summary": "GET hierarchyFilters/{date}",
        "parameters": [
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/{id}": {
      "get": {
        "summary": "GET node/{id}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/{id}/{date}/{selectedHierarchy}/attributes": {
      "get": {
        "summary": "GET node/{id}/{date}/{selectedHierarchy}/attributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          },
          {
            "name": "selectedHierarchy",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/addNewUpperUnit": {
      "post": {
        "summary": "POST api/node/addNewUpperUnit",
        "operationId": "addNewUpperUnit",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/EdgeWrapper"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/EdgeWrapper"
                }
              }
            }
          }
        }
      }
    },
    "/api/node/all/children/{id}/{date}": {
      "get": {
        "summary": "GET node/all/children/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/all/parents/{id}/{date}": {
      "get": {
        "summary": "GET node/all/parents/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/children/{id}/{date}": {
      "get": {
        "summary": "GET node/children/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/fullname/{id}/{date}": {
      "get": {
        "summary": "GET node/fullname/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/fullname/favorable/{id}/{date}": {
      "get": {
        "summary": "GET node/fullname/favorable/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/fullname/futureandcurrent/{id}/{date}": {
      "get": {
        "summary": "GET node/fullname/futureandcurrent/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/fullname/historyandcurrent/{id}/{date}": {
      "get": {
        "summary": "GET node/fullname/historyandcurrent/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/futureandcurrent/{id}/{date}/{selectedHierarchy}/attributes": {
      "get": {
        "summary": "GET node/futureandcurrent/{id}/{date}/{selectedHierarchy}/attributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          },
          {
            "name": "selectedHierarchy",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/futureandcurrent/children/{id}/{date}": {
      "get": {
        "summary": "GET node/futureandcurrent/children/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/futureandcurrent/parents/{id}/{date}": {
      "get": {
        "summary": "GET node/futureandcurrent/parents/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/historyandcurrent/{id}/{date}/{selectedHierarchy}/attributes": {
      "get": {
        "summary": "GET node/historyandcurrent/{id}/{date}/{selectedHierarchy}/attributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          },
          {
            "name": "selectedHierarchy",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/historyandcurrent/children/{id}/{date}": {
      "get": {
        "summary": "GET node/historyandcurrent/children/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/historyandcurrent/parents/{id}/{date}": {
      "get": {
        "summary": "GET node/historyandcurrent/parents/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/parentUnit/properties": {
      "put": {
        "summary": "PUT api/node/parentUnit/properties",
        "operationId": "updateParentUnitProperties",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/EdgeWrapper"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EdgeWrapper"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/parents/update": {
      "put": {
        "summary": "PUT api/node/parents/update",
        "operationId": "updateParentUnits",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/EdgeWrapper"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EdgeWrapper"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/children/update": {
      "put": {
        "summary": "PUT api/node/children/update",
        "operationId": "updateChildUnits",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/EdgeWrapperChild"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/EdgeWrapperChild"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/parents/{id}/{date}": {
      "get": {
        "summary": "GET node/parents/{id}/{date}",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": false
          },
          {
            "name": "date",
            "in": "path",
            "required": false
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/{id}/attributes/names": {
      "put": {
        "summary": "PUT api/node/{id}/attributes/names",
        "operationId": "updateNameAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            },
            "description": "organisation unit unique id",
            "example": "59457884"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/NameAttribute"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuccessResponseEntity"
                }
              }
            }
          },
          "422": {
            "description": "Bad request. Validation error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseEntity"
                },
                "examples": {
                  "validation error no value" : {
                    "$ref": "#/components/examples/ex1"
                  },
                  "validation error in dates" : {
                    "$ref":"#/components/examples/ex2"
                  },
                  "validation error value too long" : {
                    "$ref":"#/components/examples/ex3"
                  },
                  "validation error no id" : {
                    "$ref":"#/components/examples/ex4"
                  },
                  "validation error no start date" : {
                    "$ref":"#/components/examples/ex5"
                  },
                  "validation error no key" : {
                    "$ref":"#/components/examples/ex6"
                  },
                  "validation error invalid type" : {
                    "$ref":"#/components/examples/ex7"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Unauthorized access. You do not have required permissions to api"
          }
        }
      },
      "get": {
        "summary": "GET api/node/{id}/attributes/names",
        "operationId": "getNodeNameAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            },
            "description": "organisation unit unique id",
            "example": "59457884"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntity"
                }
              }
            }
          }
        }
      }
    },
    "/api/node/{id}/attributes/types": {
      "put": {
        "summary": "PUT api/node/{id}/attributes/types",
        "operationId": "updateTypeAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            },
            "description": "organisation unit unique id",
            "example": "59457884"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TypeAttribute"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuccessResponseEntity"
                }
              }
            }
          },
          "422": {
            "description": "Bad request. Validation error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseEntity"
                },
                "examples": {
                  "validation error no value" : {
                    "$ref": "#/components/examples/ex1"
                  },
                  "validation error in dates" : {
                    "$ref":"#/components/examples/ex2"
                  },
                  "validation error value too long" : {
                    "$ref":"#/components/examples/ex3"
                  },
                  "validation error no id" : {
                    "$ref":"#/components/examples/ex4"
                  },
                  "validation error no start date" : {
                    "$ref":"#/components/examples/ex5"
                  },
                  "validation error no key" : {
                    "$ref":"#/components/examples/ex6"
                  },
                  "validation error invalid type" : {
                    "$ref":"#/components/examples/ex7"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Unauthorized access. You do not have required permissions to api"
          }
        }
      },
      "get": {
        "summary": "GET api/node/{id}/attributes/types",
        "operationId": "getNodeTypeAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "description": "organisation unit unique id",
            "example": "59457884"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TypeAttribute"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/{id}/attributes/codes": {
      "put": {
        "summary": "PUT api/node/{id}/attributes/codes",
        "operationId": "updateCodeAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            },
            "description": "organisation unit unique id",
            "example": "59457884"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/CodeAttribute"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuccessResponseEntity"
                }
              }
            }
          },
          "422": {
            "description": "Bad request. Validation error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseEntity"
                },
                "examples": {
                  "validation error no value" : {
                    "$ref": "#/components/examples/ex1"
                  },
                  "validation error in dates" : {
                    "$ref":"#/components/examples/ex2"
                  },
                  "validation error value too long" : {
                    "$ref":"#/components/examples/ex3"
                  },
                  "validation error no id" : {
                    "$ref":"#/components/examples/ex4"
                  },
                  "validation error no start date" : {
                    "$ref":"#/components/examples/ex5"
                  },
                  "validation error no key" : {
                    "$ref":"#/components/examples/ex6"
                  },
                  "validation error invalid type" : {
                    "$ref":"#/components/examples/ex7"
                  }
                }
              }
            }
          }
        }
      },
      "get": {
        "summary": "GET api/node/{id}/attributes/codes",
        "operationId": "getNodeCodeAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "description": "organisation unit unique id",
            "example": "59457884"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CodeAttribute"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/{id}/attributes/others": {
      "put": {
        "summary": "PUT api/node/{id}/attributes/others",
        "operationId": "updateNodeOtherAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer"
            },
            "description": "organisation unit unique id",
            "example": "95511199"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OtherAttribute"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SuccessResponseEntity"
                }
              }
            }
          },
          "422": {
            "description": "Bad request. Validation error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseEntity"
                },
                "examples": {
                  "validation error no value" : {
                    "$ref": "#/components/examples/ex1"
                  },
                  "validation error in dates" : {
                    "$ref":"#/components/examples/ex2"
                  },
                  "validation error value too long" : {
                    "$ref":"#/components/examples/ex3"
                  },
                  "validation error no id" : {
                    "$ref":"#/components/examples/ex4"
                  },
                  "validation error no start date" : {
                    "$ref":"#/components/examples/ex5"
                  },
                  "validation error no key" : {
                    "$ref":"#/components/examples/ex6"
                  },
                  "validation error invalid type" : {
                    "$ref":"#/components/examples/ex7"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/{id}/attributes/others/hierarchies/{hierarchies}": {
      "get": {
        "summary": "GET api/node/{id}/attributes/others/hierarchies/{hierarchies}",
        "operationId": "getNodeOtherAttributes",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "example": "95511199"
          },
          {
            "name": "hierarchies",
            "in": "path",
            "description": "hierarchies in which organisation unit is located",
            "example": "tutkimus,opetus,henkilosto,toiminnanohjaus",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OtherAttribute"
                },
                "examples": {
                  "type text" : {
                    "$ref": "#/components/examples/ex9"
                  },
                  "type dropdown" : {
                    "$ref": "#/components/examples/ex10"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/attributes/distinctattributes": {
      "get": {
        "summary": "GET api/node/attributes/distinctattributes",
        "operationId": "getDistinctNodeAttrs",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DistinctSection"
                },
                "examples": {
                  "type text" : {
                    "$ref": "#/components/examples/ex11"
                  },
                  "type dropdown" : {
                    "$ref": "#/components/examples/ex10"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/attributes/distinctattributes": {
      "get": {
        "summary": "GET api/node/attributes/distinctattributes",
        "operationId": "getDistinctNodeAttrs",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DistinctAttributes"
                },
                "examples": {
                  "type text" : {
                    "$ref": "#/components/examples/ex11"
                  },
                  "type dropdown" : {
                    "$ref": "#/components/examples/ex10"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/section/alldistinct": {
      "get": {
        "summary": "GET api/node/section/alldistinct",
        "operationId": "getDistinctSectionAttributes",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/DistinctSection"
                },
                "examples": {
                  "type text" : {
                    "$ref": "#/components/examples/ex11"
                  },
                  "type dropdown" : {
                    "$ref": "#/components/examples/ex10"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hierarchyFilters/{hierarchies}/{sections}/{attributes}/attributes/keys": {
      "get": {
        "summary": "GET api/hierarchyFilters/:selectedHierarchies/:sections/:attributes/attributes/keys",
        "operationId": "gethierarchiesBySections",
        "parameters": [
          {
            "name": "hierarchies",
            "in": "path",
            "description": "hierarchies in which organisation unit is located",
            "example": "talous,tutkimus,opetus,henkilosto,toiminnanohjaus",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sections",
            "in": "path",
            "description": "sections",
            "example": "other_attributes, codes",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "attributes",
            "in": "path",
            "description": "attributes",
            "example": "publicity, iam-henkilostoryhma, iam-johtoryhma",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OtherAttribute"
                },
                "examples": {
                  "type text" : {
                    "$ref": "#/components/examples/ex9"
                  },
                  "type dropdown" : {
                    "$ref": "#/components/examples/ex10"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/section/{sectionType}/attributes": {
      "get": {
        "summary": "GET node/section/{sectionType}/attributes",
        "parameters": [
          {
            "name": "sectionType",
            "in": "path",
            "required": false,
            "description": "section type attributes",
            "example": "names"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/api/node/{id}/parents/hierarchies/{hierarchies}": {
      "get": {
        "summary": "GET api/node/{id}/parents/{rawHierarchies}",
        "operationId": "getAllParentsBySelectedHierarchies",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "organisation unit unique id",
            "example": "95511199",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "hierarchies",
            "in": "path",
            "description": "hierarchies in which parent unit is located",
            "example": "tutkimus,opetus,henkilosto,toiminnanohjaus",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/RelationDTO"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/{id}/update": {
      "put": {
        "summary": "PUT api/node/{id}/update",
        "operationId": "updateNode",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "description": "organisation unit unique id",
            "example": "94998996",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Node"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntity"
                }
              }
            }
          },
          "422": {
            "description": "Bad request. Validation error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseEntity"
                },
                "examples": {
                  "validation error in dates" : {
                    "$ref":"#/components/examples/ex8"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/successor": {
      "put": {
        "summary": "PUT api/node/successor",
        "operationId": "modifySuccessors",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Successor"
                }
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Successor"
                  }
                }
              }
            }
          },
          "422": {
            "description": "Bad request. Validation error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ErrorResponseEntity"
                  }
                },
                "examples": {
                  "validation error in dates": {
                    "$ref": "#/components/examples/ex8"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/node/successors/{id}": {
      "get": {
        "description": "GETs node's successors as a list.",
        "parameters": [
          {
            "name": "id",
            "example": 69246922,
            "description": "Node unique id",
            "required": true,
            "in": "path"
          }],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/NodeSuccessor"
                }
              }
            }
          }
        }
      }
    },
    "/api/node/{id}/insert": {
      "post": {
        "summary": "POST api/node/{id}/insert",
        "operationId": "insertNode",
        "parameters": [
          {
            "name": "id",
            "description": "Parent node's unique id.",
            "example" : "42785051",
            "required": true,
            "in": "path",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewNodeDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/NewNode"
                }
              }
            }
          }
        }
      }
    },
    "/api/section/all": {
      "get": {
        "summary": "GET api/section/all",
        "operationId": "getSectionAttributes",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntity"
                }
              }
            }
          }
        }
      }
    },
    "/api/section/update": {
      "put": {
        "summary": "PUT api/section/update",
        "operationId": "updateSectionAttribute",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SectionAttribute"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntityObject"
                }
              }
            }
          },
          "400" : {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntityObject"
                }
              }
            }
          }
        }
      }
    },
    "/api/section/insert": {
      "post": {
        "summary": "POST api/section/insert",
        "operationId": "insertSectionAttribute",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewSectionAttribute"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SectionAttribute"
                }
              }
            }
          },
          "400" : {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntityObject"
                }
              }
            }
          }
        }
      }
    },
    "/api/section/{id}/delete": {
      "delete": {
        "summary": "DELETE api/section/{id}/delete",
        "operationId": "deleteSectionAttribute",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntityObject"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntityObject"
                }
              }
            }
          }
        }
      }
    },
    "/api/hierarchy/publicityList": {
      "get": {
        "summary": "GET api/hierarchy/publicityList",
        "operationId": "getHierarchyPublicityList",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/HierarchyPublicity"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/api/hierarchy/updatePublicity": {
      "put": {
        "summary": "PUT api/hierarchy/updatePublicity",
        "operationId": "updatePublicity",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/HierarchyPublicity"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntityObject"
                }
              }
            }
          },
          "422": {
            "description": "Bad request. Validation error occurred.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseEntity"
                },
                "examples": {
                  "validation error hierarchy name do not match" : {
                    "$ref": "#/components/examples/ex11"
                  },
                  "validation error hierarchy name is null" : {
                    "$ref": "#/components/examples/ex12"
                  }
                }
              }
            }
          },
          "403": {
            "description": "Unauthorized access. You do not have required permissions to api"
          }
        }
      }
    },
    "/api/hierarchy/insertPublicity": {
      "post": {
        "summary": "POST api/hierarchy/insertPublicity",
        "operationId": "insertPublicity",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/NewHierarchyPublicityDTO"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseEntity"
                }
              }
            }
          }
        }
      }
    },
    "/api/attributeorder": {
      "get": {
        "summary": "Fetch all AttributeOrder rows",
        "operationId": "attributeOrders",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AttributeOrder"
                  }
                }
              }
            }
          }
        }
      },
      "post": {
        "summary": "Insert attribute order",
        "operationId": "insertAttributeOrder",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeOrder"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/AttributeOrder"
                  }
                }
              }
            }
          }
        }
      },
      "delete": {
        "summary": "Delete attribute order row",
        "operationId": "deleteAttributeOrder",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeOrder"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeOrder"
                }
              }
            }
          }
        }
      },
      "put": {
        "summary": "Update attribute order row",
        "operationId": "updateAttributeOrder",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AttributeOrder"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AttributeOrder"
                }
              }
            }
          }
        }
      }
    },
    "/api/node/attributes/sortable": {
      "get": {
        "summary": "Fetch all sortable attributes",
        "operationId": "attributeOrders",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "key": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "examples": {
      "ex1": {
        "value": {
          "id": 32032,
          "nodeId": "5283",
          "errorMessage": "error_value_is_mandatory"
        }
      },
      "ex2": {
        "value": {
          "id": 32032,
          "nodeId": "5283",
          "errorMessage": "attribute_start_date_after_end_date"
        }
      },
      "ex3": {
        "value": {
          "id": 32032,
          "nodeId": "5283",
          "errorMessage": "attribute_value_is_too_long"
        }
      },
      "ex4": {
        "value": {
          "id": 0,
          "nodeId": null,
          "errorMessage": "attribute_id_is_mandatory"
        }
      },
      "ex5": {
        "value": {
          "id": 32032,
          "nodeId": "5283",
          "errorMessage": "attribute_start_date_is_mandatory"
        }
      },
      "ex6": {
        "value": {
          "id": 32032,
          "nodeId": "5283",
          "errorMessage": "attribute_key_is_mandatory"
        }
      },
      "ex7": {
        "value": {
          "id": 32032,
          "nodeId": "5283",
          "errorMessage": "attribute_type_invalid"
        }
      },
      "ex8": {
        "value": {
          "id": 32032,
          "nodeId": "5283",
          "errorMessage": "node_start_date_after_end_date"
        }
      },
      "ex9": {
        "value": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32172,
            "description": "attribute unique id",
            "required": true
          },
          "key": {
            "type": "string",
            "example": "iam-johtoryhma",
            "description": "attribute type",
            "required": true
          },
          "value": {
            "type": "string",
            "example": "hy-ypa-toimi-jory",
            "description": "value of the attribute",
            "required": true
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-02T00:00:00.000+00:00",
            "description": "start date of the attribute"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "null",
            "description": "end date of the attribute"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          },
          "type": {
            "type": "text",
            "example": "text",
            "description": "input field type"
          }
        }
      },
      "ex10": {
        "value": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32172,
            "description": "attribute unique id",
            "required": true
          },
          "key": {
            "type": "string",
            "example": "iam-johtoryhma",
            "description": "attribute type",
            "required": true
          },
          "value": {
            "type": "string",
            "example": "hy-ypa-toimi-jory",
            "description": "value of the attribute",
            "required": true
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-02T00:00:00.000+00:00",
            "description": "start date of the attribute"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "null",
            "description": "end date of the attribute"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          },
          "type": {
            "type": "options",
            "example": "options",
            "description": "input field type"
          },
          "optionValues": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "option values for input field"
          }
        }
      },
      "ex11": {
        "value": {
          "id": 32579,
          "errorMessage": "hierarchy_publicity_name_not_matching"
        }
      },
      "ex12": {
        "value": {
          "id": 32579,
          "errorMessage": "hierarchy_publicity_name_is_empty"
        }
      }
    },
    "schemas": {
      "NewSectionAttribute": {
        "type": "object",
        "properties": {
          "section": {
            "type": "string",
            "example": "codes"
          },
          "attr": {
            "type": "string",
            "example": "emo_lyhenne"
          }
        }
      },
      "SectionAttribute": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": "1"
          },
          "section": {
            "type": "string",
            "example": "codes"
          },
          "attr": {
            "type": "string",
            "example": "emo_lyhenne"
          }
        }
      },
      "NewNodeDTO": {
        "type": "object",
        "properties": {
          "hierarchies": {
            "type": "array",
            "example": [
              "talous",
              "opetus"
            ],
            "items": {
              "type": "string"
            }
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-02T00:00:00.000+00:00"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-12T00:00:00.000+00:00"
          },
          "nameFi": {
            "type": "string",
            "example": "uusi yksikkö"
          },
          "nameSv": {
            "type": "string",
            "example": "ny enhet"
          },
          "nameEn": {
            "type": "string",
            "example": "new organisation unit"
          }
        }
      },
      "NewNode": {
        "type": "object",
        "properties": {
          "hierarchies": {
            "type": "array",
            "example": [
              "talous",
              "opetus"
            ],
            "items": {
              "type": "string"
            }
          },
          "parentNodeId": {
            "type": "string",
            "example": "123456"
          },
          "childNodeId": {
            "type": "string",
            "example": "123456"
          },
          "childUniqueId": {
            "type": "string",
            "example": "100000012"
          },
          "startDate": {
            "type": "string",
            "format": "date",
            "example": "1800-12-02"
          },
          "endDate": {
            "type": "string",
            "format": "date",
            "example": "1800-12-12"
          },
          "nameFi": {
            "type": "string",
            "example": "uusi yksikkö"
          },
          "nameSv": {
            "type": "string",
            "example": "ny enhet"
          },
          "nameEn": {
            "type": "string",
            "example": "new organisation unit"
          }
        }
      },
      "NameAttribute": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32032,
            "description": "attribute unique id",
            "required": true
          },
          "key": {
            "type": "string",
            "example": "name_fi",
            "description": "attribute language key",
            "required": true
          },
          "value": {
            "type": "string",
            "example": "Forest Economics and  Management",
            "description": "value of the attribute",
            "required": true
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-02T00:00:00.000+00:00",
            "description": "start date of the attribute"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "null",
            "description": "end date of the attribute"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          }
        }
      },
      "TypeAttribute": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 5289,
            "description": "attribute unique id",
            "required": true
          },
          "key": {
            "type": "string",
            "example": "type",
            "description": "attribute type",
            "required": true
          },
          "value": {
            "type": "string",
            "example": "tulosyksikko",
            "description": "value of the attribute",
            "required": true
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-02T00:00:00.000+00:00",
            "description": "start date of the attribute"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "null",
            "description": "end date of the attribute"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          }
        }
      },
      "CodeAttribute": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32082,
            "description": "attribute unique id",
            "required": true
          },
          "key": {
            "type": "string",
            "example": "hr_tunnus",
            "description": "attribute type",
            "required": true
          },
          "value": {
            "type": "string",
            "example": "HR-TST",
            "description": "value of the attribute",
            "required": true
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-02T00:00:00.000+00:00",
            "description": "start date of the attribute"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "null",
            "description": "end date of the attribute"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          }
        }
      },
      "OtherAttribute": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32172,
            "description": "attribute unique id",
            "required": true
          },
          "key": {
            "type": "string",
            "example": "iam-johtoryhma",
            "description": "attribute type",
            "required": true
          },
          "value": {
            "type": "string",
            "example": "hy-ypa-toimi-jory",
            "description": "value of the attribute",
            "required": true
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "1800-12-02T00:00:00.000+00:00",
            "description": "start date of the attribute"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "null",
            "description": "end date of the attribute"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          },
          "type": {
            "type": "string",
            "example": "text",
            "description": "input field type"
          }
        }
      },
      "DistinctAttribute": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "example": "name_fi",
            "description": "attribute key",
            "required": true
          },
          "value": {
            "type": "string",
            "example": "Erilliset laitokset",
            "description": "value of the attribute",
            "required": true
          }
        }
      },
      "DistinctAttributes": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "example": {
          "oppiaine_tunnus": [
            "875804",
            "872802",
            "4246",
            "62022",
            "H5298",
            "871805",
            "104",
            "370056",
            "H72531",
            "Research Group Räsänen",
            "Research Group XX"
          ],
          "maxItems": 0
        }
      },
      "DistinctSection": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "example": {
          "attr": [
            "name_sv",
            "iam_ryhma",
            "name_en",
            "iam-johtoryhma",
            "iam-henkilostoryhma",
            "tutkimus_tunnus",
            "emo_lyhenne",
            "laskutus_tunnus"
          ],
          "maxItems": 0
        }
      },
      "ErrorResponseNameAttribute": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32032,
            "description": "attribute unique id",
            "required": true
          },
          "nodeId": {
            "type": "string",
            "example": "5283",
            "description": "organisation unit id",
            "required": true
          },
          "errorMessage": {
            "type": "string",
            "example": "error_name_is_mandatory",
            "description": "error text key ready to be translated"
          }
        }
      },
      "SuccessResponseEntity": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "example": [],
        "maxItems": 0
      },
      "ResponseEntityObject": {
        "type": "object",
        "example": {}
      },
      "ErrorResponseEntity": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/ErrorResponseNameAttribute"
        }
      },
      "ResponseEntity": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/NameAttribute"
        }
      },
      "EdgeWrapper": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32212
          },
          "parentUniqueId": {
            "type": "integer",
            "example": 32800844
          },
          "childUniqueId": {
            "type": "integer",
            "format": "int32",
            "example": 90111204
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "2023-05-04T00:00:00.000+00:00"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "2024-05-14T00:00:00.000+00:00"
          },
          "hierarchy": {
            "type": "string",
            "example": "henkilosto"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          }
        }
      },
      "EdgeWrapperChild": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 9185
          },
          "parentUniqueId": {
            "type": "integer",
            "example": 95888394
          },
          "childUniqueId": {
            "type": "integer",
            "format": "int32",
            "example": 46149454
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "2021-02-12T00:00:00.000+00:00"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "2022-03-17T00:00:00.000+00:00"
          },
          "hierarchy": {
            "type": "string",
            "example": "henkilosto"
          },
          "isNew" : {
            "type" : "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted" : {
            "type" : "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          }
        }
      },

      "Successor": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": 32382,
            "description": "edge id"
          },
          "parentUniqueId": {
            "type": "integer",
            "example": 54835083,
            "description": "successor unique id"
          },
          "childUniqueId": {
            "type": "integer",
            "example": 69246922,
            "description": "node id"
          },
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "2023-05-04T10:45:53.145Z"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "2024-05-14T10:45:53.145Z"
          },
          "hierarchy": {
            "type": "string",
            "example": "history",
            "description": "hierarchy is always history for successors"
          },
          "isNew": {
            "type": "boolean",
            "example": false,
            "description": "is new attribute"
          },
          "deleted": {
            "type": "boolean",
            "example": false,
            "description": "is attribute marked for deletion"
          }
        }
      },
      "HierarchyFilter": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "hierarchy": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "startDate": {
            "type": "string",
            "format": "date-time"
          },
          "endDate": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "HierarchyDTO": {
        "type": "object",
        "properties": {
          "hierarchy": {
            "type": "string"
          },
          "startDate": {
            "type": "string",
            "format": "date-time"
          },
          "endDate": {
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "FullNameDTO": {
        "type": "object",
        "properties": {
          "language": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "RelationDTO": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "uniqueId": {
            "type": "integer",
            "format": "int32"
          },
          "startDate": {
            "type": "string",
            "format": "date-time"
          },
          "endDate": {
            "type": "string",
            "format": "date-time"
          },
          "hierarchies": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/HierarchyDTO"
            }
          },
          "deleted": {
            "type": "boolean"
          },
          "fullNames": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FullNameDTO"
            }
          }
        }
      },
      "Node": {
        "type": "object",
        "properties": {
          "startDate": {
            "type": "string",
            "format": "date-time",
            "description": "node start date"
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "description": "node end date"
          }
        }
      },
      "NodeSuccessor": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "example": 69246922,
            "description": "Node unique id"
          }
        }
      },
      "Relative": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the node. Not: not a unique id."
          },
          "uniqueId": {
            "type": "integer",
            "description": "Unique ID of the node."
          },
          "startDate": {
            "type": "string",
            "format": "YYYY-MM-DD"
          },
          "endDate": {
            "type": "string",
            "format": "YYYY-MM-DD"
          },
          "edgeId": {
            "type": "integer",
            "description": "ID of an edge depicting this successors relation."
          },
          "edgeStartDate": {
            "type": "string",
            "format": "YYYY-MM-DD"
          },
          "edgeEndDate": {
            "type": "string",
            "format": "YYYY-MM-DD"
          },
          "fullName": {
            "type": "string",
            "description": "Full name of the node."
          },
          "language": {
            "type": "string",
            "format": "fi|sv|en",
            "description": "Language of the full name."
          }
        }
      },
      "HierarchyPublicity": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "example": "32579"
          },
          "hierarchy": {
            "type": "string",
            "example": "tutkimus"
          },
          "publicity": {
            "type": "boolean",
            "example": "false"
          }
        }
      },
      "NameLanguageWrapper": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "language": {
            "type": "string"
          }
        }
      },
      "NewHierarchyPublicityDTO": {
        "type": "object",
        "properties": {
          "childId": {
            "type": "string"
          },
          "hierarchy": {
            "type": "string"
          },
          "publicity": {
            "type": "boolean"
          },
          "names": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NameLanguageWrapper"
            }
          }
        }
      },
      "AttributeOrder": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "value": {
            "type": "string"
          },
          "order": {
            "type": "integer"
          }
        }
      }
    }
  }
}