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
TestProduktion
Lösningsbeskrivning
TBDGliffy | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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" }, "serverspaths": [ { "url": "http:/api/localhostimport":8088" { } ], "pathspost": { "/api/import": { "posttags": {[ "tags": [ "FormpipeProxy" ], "operationId": "import", "requestBody": { "requestBody": { "x-name": "request", "content": { "content": { "application/json": { "schemaapplication/json": { "$ref": "#/components/schemas/ImportRequest" "schema": { } } }, "$ref": "#/components/schemas/ImportRequest" "required": true, "x-position": 1 } }, "responses": { } "200": { "description": "Successful operaiton"}, "content": { "required": true, "application/jsonx-position": {1 "schema": { }, "$refresponses": "#/components/schemas/ImportResponse"{ } "200": { } "description": "Successful operaiton", } }, "500content": { "description": "Import failure", "contentapplication/json": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportResponse" } } } } } } } }, "/api/FormpipeProxy/WriteToLog": { "post": { }, "tags": [ "FormpipeProxy500": { ], "operationId": "FormpipeProxy_WriteToLog", "parametersdescription": ["Import failure", { "namecontent": "text",{ "in": "query", "requiredapplication/json": { true, "schema": { "typeschema": "string",{ "nullable": true }, "$ref": "#/components/schemas/ImportResponse" "x-position": 1 } ], } "requestBody": { "x-name": "ex", } "content": { "application/json": { } "schema": { } "nullable": true, } "oneOf": [ } } }, "components": { "schemas": { "$refImportResponse": "#/components/schemas/Exception" { "type": "object", } "additionalProperties": false, ] "properties": { } } "ErrorDetails": { }, "x-position": 2 "nullable": true, }, "responses": { "204oneOf": {[ "description": "" { } } } } }, "$ref": "#/components/schemas/ErrorDetails": { "schemas": { "ImportResponse": { "type": "object", } ] }, "ImportedFileSetId": { "type": "string", "format": "uuid", "nullable": true } } }, "ErrorDetails": { "type": "object", "additionalProperties": false, "properties": { "Phase": { "type": "string", "nullable": true }, "ErrorCode": { "type": "integer", "format": "int32" }, "ErrorId": { "type": "integer", "format": "int32" }, "ErrorMessage": { "type": "string", "nullable": true } } }, "ImportRequest": { "type": "object", "additionalProperties": false, "properties": { "SubmissionAgreementId": { "type": "string", "nullable": true }, "Uuid": { "type": "string", "format": "uuid", "nullable": true "additionalProperties": false, }, "properties": { "ErrorDetailsConfidentialityLevel": { "nullable "type": true"integer", "oneOf": [ "format": "int32" }, { "$refConfidentialityDegradationDate": "#/components/schemas/ErrorDetails"{ } "type": "string", ] }, "format": "date-time" "ImportedFileSetId": { "type": "string", }, "nullablePersonalDataFlag": true { } } "type": "boolean" }, "ErrorDetails": { "type": "object" }, "additionalProperties": false, "propertiesMetadataXml": { "Phase": { "type": "string", "nullable": true, }, "ErrorCodedescription": { "The metadata XML, as a BASE64-encoded string" "type": "integer", }, "format": "int32" }, "PreservationObject": { "ErrorId": { "typenullable": "integer"true, "format": "int32" }, "oneOf": [ "ErrorMessage": { "type": "string", { "nullable": true } } "$ref": "#/components/schemas/PreservationObject" }, "ImportRequest": { "type": "object", } "additionalProperties": false, "properties": { ] "SubmissionAgreementId": { } "type": "string", "nullable":} true }, "UuidPreservationObject": { "type": "stringobject", "nullableadditionalProperties": truefalse, }, "properties": { "ConfidentialityLevel": { "typeFileName": "integer",{ "formattype": "int32string", }, "ConfidentialityDegradationDatenullable": { true "type": "string", }, "format": "date-time" }, "FileExtension": { "PersonalDataFlag": { "type": "booleanstring", }, "MetadataXmlnullable": {true "type": "string", }, "nullable": true }, "Data": { "PreservationObject": { "nullabletype": true"string", "oneOf": [ "nullable": true, { "$refdescription": "#/components/schemas/PreservationObject" The preservation object data, as a BASE64-encoded string" } } ] } }, }, "Exception": { "PreservationObject": { "type": "object", "additionalProperties": false, "properties": { "FileName "Message": { "type": "string", "nullable": true"type": "string", }, "FileExtensionnullable": { true "type": "string", }, "nullable": true }, "InnerException": { "Data": { "typenullable": "string"true, "nullable": true "oneOf": [ } } }, "Exception": { "type": "object", "additionalProperties": false, "properties$ref": {"#/components/schemas/Exception" "Message": { "type": "string", } "nullable": true ] }, "InnerException": { }, "nullable": true, "oneOfStackTrace": [{ { "type": "string", "$ref": "#/components/schemas/Exception" "nullable": true } ] }, }, "StackTraceSource": { "type": "string", "type": "nullablestring":, true }, "Sourcenullable": {true "type": "string", } "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>