{"openapi":"3.1.0","info":{"title":"Archiv API","description":"","version":"1.0.0"},"servers":[{"url":"https:\/\/api.wirtschaftscompass.at\/archive","description":"Generated server url"}],"security":[{"compass-api-token":[]}],"tags":[{"name":"V1","description":"Archiv Version 1"}],"paths":{"\/v1\/document\/{document-reference}":{"get":{"tags":["V1"],"summary":"Meta-Informationen eines archivierten Dokuments als XML oder JSON","description":"Mit der [reference]-ID k\u00f6nnen Meta-Informationen eines archivierten Dokuments abgerufen werden.<br \/>\u00dcber den \"response content type\" kann zwischen XML oder JSON unterschieden werden.","operationId":"documentDetails","parameters":[{"name":"document-reference","in":"path","description":"[reference]-ID eines archivierten Dokuments","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"400":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentDetailsType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/DocumentDetailsType"}}}}}},"delete":{"tags":["V1"],"summary":"L\u00f6schen eines archivierten Dokuments","description":"Mit der [reference]-ID kann ein Dokument aus dem Archiv entfernt werden. Die L\u00f6schung ist nicht revidierbar.","operationId":"deleteDocument","parameters":[{"name":"document-reference","in":"path","description":"[reference]-ID eines archivierten Dokuments","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"400":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentDetailsType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/DocumentDetailsType"}}}}}}},"\/v1\/document\/{document-reference}\/xml":{"get":{"tags":["V1"],"summary":"Archiviertes Dokument als XML","description":"Mit der [reference]-ID kann ein archiviertes Dokument in strukturierter Form abgerufen werden, sofern die Grundlage des abgefragten Dokuments ein XML ist.<br \/>Beispiel: Ein amtlicher Firmenbuchauszug steht nur als PDF zur Verf\u00fcgung und kann daher im Archiv nicht als XML abgefragt werden. Dieser Endpoint w\u00fcrde somit in diesem Fall einen Fehler liefern.","operationId":"xmlDocumentContent","parameters":[{"name":"document-reference","in":"path","description":"[reference]-ID eines archivierten Dokuments","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"400":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/xml":{"schema":{"type":"string","format":"byte"}}}}}}},"\/v1\/document\/{document-reference}\/svg":{"get":{"tags":["V1"],"summary":"Archiviertes Dokument als SVG","description":"Mit der [reference]-ID kann ein archiviertes Organigramm als SVG angefragt werden.","operationId":"documentSvg","parameters":[{"name":"document-reference","in":"path","description":"[reference]-ID eines archivierten Dokuments","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"400":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"image\/svg+xml":{"schema":{"type":"string","format":"byte"}}}}}}},"\/v1\/document\/{document-reference}\/pdf":{"get":{"tags":["V1"],"summary":"Archiviertes Dokument als PDF","description":"Mit der [reference]-ID kann ein archiviertes Dokument als PDF abgerufen werden.","operationId":"documentContent","parameters":[{"name":"document-reference","in":"path","description":"[reference]-ID eines archivierten Dokuments","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"400":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/pdf":{"schema":{"type":"string","format":"byte"}}}}}}},"\/v1\/":{"get":{"tags":["V1"],"summary":"Suche nach archivierten Dokumenten","description":"Suche nach archivierten Dokumenten, um die [reference]-ID eines bestimmten Objekts im Archiv zu identifizieren und in weiterer Folge mit der ID das Dokument abfragen.<br \/>Die Suche kann mit Hilfe von verschiedenen Attributen eingeschr\u00e4nkt werden, wobei jedoch zumindest die [domain] (Dom\u00e4ne) angegeben werden muss.<br \/>Die Dom\u00e4ne (Quelle) beschreibt eine spezifisiche Einschr\u00e4nkung auf einen Teilbereich von Dokumenten, wie etwa Firmenbuchausz\u00fcge, WiEReG-Ausz\u00fcge, GISA-Ausz\u00fcge etc.<br \/>Mit den beiden Parameter [storage-start-date] und [storage-end-date] kann der Suchzeitraum eingeschr\u00e4nkt werden.<br \/><br \/>Der Bearer Token (API Key), der im Rahmen jeder Abfrage als Authorization Header verwendet wird, ist immer einem eindeutigen Benutzer in Ihrem Unternehmen zugeordnet.<br \/>Ausgehend davon definiert das Attribut [scope] den Umfang der Suche in Ihrem Unternehmen auf Basis des Bearer Tokens - respektive dem Benutzer, dem der Bearer Token zugeordnet ist.<br \/>Bei dieser Option k\u00f6nnen daher folgende Abfrageparameter angewendet werden:<br \/>- ORGANISATION: Abfragen in der gesamten Unternehmensgruppe des Benutzers durchsuchen.<br \/>- ORGANISATIONAL_UNIT: Abfragen innerhalb der Organisationseinheit, die der Benutzer angeh\u00f6rt, durchsuchen.<br \/>- ORGANISATION_CLIENT: Nur die pers\u00f6nlichen Abfragen des Benutzers durchsuchen.","operationId":"search","parameters":[{"name":"wico-id","in":"query","description":"[wicoId] des Objekts","required":false,"schema":{"type":"string"}},{"name":"domain","in":"query","description":"Einschr\u00e4nken auf eine spezifische Dom\u00e4ne\/Quelle (Firmenbuchausz\u00fcge, WiEReG-Ausz\u00fcge, GISA-Ausz\u00fcge, ...)","required":true,"schema":{"type":"string","enum":["BUSINESS_REGISTER_EXCERPT","WIEREG","ZMR","LAND_REGISTER","DOMAIN_ORG","GISA","ZVR","COMPLIANCE"]}},{"name":"scope","in":"query","description":"Umfang der Suche in Ihrer Unternehmensgruppe (standardm\u00e4\u00dfig werden alle Dokumente Ihrer Unternehmensgruppe durchsucht)","required":false,"schema":{"type":"string","default":"ORGANISATION","enum":["ORGANISATION_CLIENT","ORGANISATION","ORGANISATIONAL_UNIT","USER"]}},{"name":"from","in":"query","description":"Von-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Bis-Datum (YYYY-MM-DD)","required":false,"schema":{"type":"string","format":"date"}},{"name":"term","in":"query","description":"Titel des Dokuments","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Seitenverwaltung\/Paginierung (0...N)","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"Anzahl an Ergebnissen pro Seite","schema":{"type":"integer","format":"int32","default":10}},{"name":"sort","in":"query","description":"Sortierkriterium im Format: feld(,asc|desc)?, z.B. \"name,asc\"; Standardsortierung ist aufsteigend (asc), Parameter kann mehrmals angegeben werden f\u00fcr mehr als ein Sortierkriterium. Erlaubte Werte f\u00fcr \"feld\" sind: name,storage-date","schema":{"type":"array","default":[],"items":{"type":"string"}}}],"responses":{"404":{"description":"Not Found","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceNotFoundException"]},"400":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/DocumentArchiveType"}},"application\/xml":{"schema":{"$ref":"#\/components\/schemas\/DocumentArchiveType"}}}}}}},"\/health":{"get":{"tags":["X"],"summary":"","description":"","operationId":"getPing","responses":{"404":{"description":"Not Found","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.ExternalServiceNotFoundException"]},"400":{"description":"Bad Request","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["at.compass.api.shared.exception.InvalidParameterException"]},"500":{"description":"Internal Server Error","content":{"*\/*":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}},"x-exception-class":["java.lang.Exception"]},"401":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"403":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Failure"}}}},"200":{"description":"OK","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ResponseString"}}}}}}}},"components":{"schemas":{"Failure":{"properties":{"message":{"type":"string"},"stacktrace":{"type":"string"}},"required":["message","stacktrace"],"xml":{"name":"failure","namespace":"urn:compass:wico:api:1.0"}},"Api":{"type":"object","properties":{"domain":{"type":"string","description":""},"version":{"type":"string","description":""}},"required":["domain","version"],"xml":{"name":"api","namespace":"urn:compass:wico:api:1.0"}},"ChildDocument":{"type":"object","properties":{"reference":{"type":"string","description":""},"documentTitle":{"type":"string","description":""},"documentType":{"type":"string","description":""},"contentType":{"type":"string","description":""}},"required":["contentType","documentTitle","documentType","reference"]},"ChildDocuments":{"type":"object","properties":{"childDocument":{"type":"array","description":"","items":{"$ref":"#\/components\/schemas\/ChildDocument"}}}},"DocumentDetailsType":{"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta","description":""},"data":{"$ref":"#\/components\/schemas\/DocumentType","description":""}},"required":["data","meta"]},"DocumentType":{"type":"object","properties":{"timeOfCreation":{"type":"string","description":"","xml":{"name":"time-of-creation"}},"wicoId":{"type":"string","description":"","xml":{"name":"wico-id"}},"domain":{"type":"string","description":""},"documentType":{"type":"string","description":"","xml":{"name":"document-type"}},"documentTitle":{"type":"string","description":"","xml":{"name":"document-title"}},"additionalInformation":{"type":"string","description":"","xml":{"name":"additional-information"}},"registerId":{"type":"string","description":"","xml":{"name":"register-id"}},"referenceDate":{"type":"string","description":"","xml":{"name":"reference-date"}},"contentType":{"type":"string","description":"","xml":{"name":"content-type"}},"contentSize":{"type":"string","description":"","xml":{"name":"content-size"}},"owner":{"type":"string","description":""},"childDocuments":{"$ref":"#\/components\/schemas\/ChildDocuments","description":""}},"required":["additionalInformation","childDocuments","contentSize","contentType","documentTitle","documentType","domain","owner","referenceDate","registerId","timeOfCreation","wicoId"]},"Meta":{"type":"object","properties":{"api":{"$ref":"#\/components\/schemas\/Api","description":""},"user":{"$ref":"#\/components\/schemas\/User","description":""},"cost":{"type":"string","description":""},"lastUpdate":{"type":"string","description":""},"generationDate":{"type":"string","description":""}},"required":["api","cost","generationDate","lastUpdate","user"],"xml":{"name":"meta","namespace":"urn:compass:wico:api:1.0"}},"User":{"type":"object","properties":{"organisation":{"type":"string","description":""},"username":{"type":"string","description":""},"clientInfo":{"type":"string","description":""}},"required":["clientInfo","organisation","username"],"xml":{"name":"user","namespace":"urn:compass:wico:api:1.0"}},"Pageable":{"type":"object","properties":{"page":{"type":"integer","format":"int32","description":"","minimum":0},"size":{"type":"integer","format":"int32","description":"","minimum":1},"sort":{"type":"array","description":"","items":{"type":"string"}}}},"ArchiveData":{"type":"object","properties":{"numberOfDocuments":{"type":"integer","format":"int64","description":"","xml":{"name":"number-of-documents"}},"searchResults":{"$ref":"#\/components\/schemas\/SearchResults","description":""}},"required":["searchResults"]},"DocumentArchiveType":{"type":"object","properties":{"meta":{"$ref":"#\/components\/schemas\/Meta","description":""},"data":{"$ref":"#\/components\/schemas\/ArchiveData","description":""}},"required":["data","meta"]},"ResultEntry":{"type":"object","properties":{"reference":{"type":"string","description":""},"documentType":{"type":"string","description":"","xml":{"name":"document-type"}},"wicoId":{"type":"string","description":"","xml":{"name":"wico-id"}},"name":{"type":"string","description":""},"additionalInformation":{"type":"string","description":"","xml":{"name":"additional-information"}},"restricted":{"type":"boolean","description":""},"storageDate":{"type":"string","description":"","xml":{"name":"storage-date"}},"referenceDate":{"type":"string","description":"","xml":{"name":"reference-date"}},"numberOfChildDocuments":{"type":"integer","format":"int64","description":"","xml":{"name":"number-of-child-documents"}}},"required":["additionalInformation","documentType","name","reference","referenceDate","storageDate","wicoId"]},"SearchResults":{"type":"object","properties":{"resultEntry":{"type":"array","description":"","items":{"$ref":"#\/components\/schemas\/ResultEntry"}}},"xml":{"name":"searchResults","namespace":"urn:compass:wico:api:1.0"}},"ResponseString":{"type":"object","properties":{"status":{"type":"string","description":"","enum":["OK","ERROR"]},"message":{"type":"string","description":""},"data":{"type":"string","description":""}}}},"securitySchemes":{"compass-api-token":{"type":"apiKey","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}}}}