Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Beskrivning
API som används framför Formpipe LTA:s WCF-baserade API som ett REST-API, för att möjliggöra för Java-baserade tjänster och klienter att långtidsarkivera dokument.
Livscykelstatus
Test
Lösningsbeskrivning
TBD
Hantering av personuppgifter
Inga personuppgifter hanteras i tjänsten.
API-specifikation
Swagger ui |
---|
• { { "x-generator": "NSwag v13.14.5.0 (NJsonSchema v10.5.2.0 (Newtonsoft.Json v12.0.0.0))", "openapi": "3.0.0", "info": { "title": "FormPipeProxy API", "version": "1.0" }, "servers": [ { "url": "http://localhost:8088" } ], "paths": { "/api/import": { "post": { "tags": [ "FormpipeProxy" ], "operationId": "import", "requestBody" "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRequest" } } }, "required": true,} "x-position": 1 }, }, "responses": { "required": true, "200": { "descriptionx-position": 1 "Successful operaiton", "content": {}, "application/jsonresponses": { "schema200": { "$ref": "#/components/schemas/ImportResponse" "description": "Successful operaiton", } } "content": { } }, "500application/json": { "description": "Import failure", "contentschema": { "application/json": { "schema$ref": {"#/components/schemas/ImportResponse" "$ref": "#/components/schemas/ImportResponse" } } } } } } } }, }, "/api/FormpipeProxy/WriteToLog": { "post500": { "tags": [ "FormpipeProxydescription": "Import failure", ], "operationId "content": "FormpipeProxy_WriteToLog", { "parametersapplication/json": [ { { "nameschema": "text", { "$ref": "#/components/schemas/ImportResponse" } } } } } } }, "/api/FormpipeProxy/WriteToLog": { "post": { "tags": [ "FormpipeProxy" ], "operationId": "FormpipeProxy_WriteToLog", "parameters": [ { "name": "text", "in": "query", "required": true, "schema": { "type": "string", "nullable": true }, "x-position": 1 } ], "requestBody": { "x-name": "ex", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Exception" } ] } } }, "x-position": 2 }, "responses": { "204": { "description": "" } } } } }, "components": { "schemas": { "ImportResponse": { "type": "object", "additionalProperties": false, "properties": { "ErrorDetails": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorDetails" } ] }, "ImportedFileSetId": { "type": "string", "nullable": true } } }, "ErrorDetails": { "type": "object", "additionalProperties": false, "properties": { "Phase": { "type": "string", "nullable": true }, "ErrorCode": { "in": "query", "requiredtype": true"integer", "schema": { "type"format": "stringint32", "nullable": true }, }, "ErrorId": { "x-position": 1 } ],"type": "integer", "requestBody": { "x-nameformat": "exint32", "content": { }, "application/json": { "schemaErrorMessage": { "nullable "type": true,"string", "oneOfnullable": [true } { } "$ref": "#/components/schemas/Exception" }, "ImportRequest": { } "type": "object", ] "additionalProperties": false, } } "properties": { }, "x-positionSubmissionAgreementId": 2{ }, "responsestype": {"string", "204": { "descriptionnullable": "" true } } , } } }, "componentsUuid": { "schemas": { "ImportResponse": { "type": "objectstring", "additionalProperties": false, "propertiesnullable": {true "ErrorDetails": { }, "nullable": true, "oneOfConfidentialityLevel": [{ { "$ref": "#/components/schemas/ErrorDetails" "type": "integer", } "format": "int32" ] }, }, "ImportedFileSetId": { "typeConfidentialityDegradationDate": "string", { "nullable": true } "type": "string", } }, "ErrorDetailsformat": {"date-time" "type": "object" }, "additionalProperties": false, "propertiesPersonalDataFlag": { "Phase": { "type": "stringboolean", "nullable": true }, }, "ErrorCodeMetadataXml": { "type": "integerstring", "format": "int32" "nullable": true }, }, "ErrorId": { "typePreservationObject": "integer",{ "format": "int32" }, "nullable": true, "ErrorMessage": { "typeoneOf": "string",[ "nullable": true } { } }, "ImportRequest": { "type$ref": "object","#/components/schemas/PreservationObject" "additionalProperties": false, "properties": { } "SubmissionAgreementId": { "type": "string", ] "nullable": true } }, "Uuid": { } "type": "string" }, "nullablePreservationObject": true{ }, "type": "ConfidentialityLevelobject":, { "typeadditionalProperties": "integer"false, "formatproperties": "int32"{ }, "ConfidentialityDegradationDateFileName": { "type": "string", "format": "date-time" "nullable": true }, "PersonalDataFlag": { }, "type": "boolean" }, "FileExtension": { "MetadataXml": { "type": "string", "nullable": true }, }, "PreservationObject": { "nullableData": true,{ "oneOf": [ "type": "string", { "$refnullable": "#/components/schemas/PreservationObject" true } } ] } } }, }, "PreservationObjectException": { "type": "object", "additionalProperties": false, "properties": { "properties": { "FileName": { "typeMessage": "string",{ "nullable": true }, "type": "string", "FileExtension": { "typenullable": "string",true "nullable": true }, }, "DataInnerException": { "type": "string", "nullable": true, } }"oneOf": [ }, "Exception": { "type": "object", { "additionalProperties": false, "properties": { "Message$ref": { "#/components/schemas/Exception" "type": "string", } "nullable": true }, ] "InnerException": { "nullable": true, }, "oneOf": [ "StackTrace": { { "$reftype": "#/components/schemas/Exception" string", } "nullable": true ] }, }, "StackTrace": { "typeSource": "string",{ "nullable": true }"type": "string", "Source": { "typenullable": "string",true "nullable": true } } } } } } } |
Säkerhetsklassning
Säkerhetsklass 0
Autentiseringsmetod: ingen
(Ref: Säkerhetsklassning av APIer)
API-ägare
<Kontaktuppgifter till den verksamhet som äger APIets livscykel>
Teknisk ägare
https://sundsvall.atlassian.net/wiki/spaces/API
För tekniska frågor:
teamdynasty@sundsvall.se
FAQ
<FAQ>