openapi2402.json

{"openapi":"3.0.1","info":{"title":"Goobi workflow REST API.","description":"This documentation describes the Goobi workflow REST API.","contact":{"email":"info@intranda.com"},"license":{"name":"GPL2 or later","url":"https://github.com/intranda/goobi-workflow/blob/master/LICENSE"}},"servers":[{"url":"/goobi"}],"security":[{"query":[],"header":[]}],"paths":{"/api/currentusers":{"get":{"summary":"Returns a list of the current users","description":"Returns a list with all users that are currently connected to this server","operationId":"getCurrentUsers","responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/metadata/lido/{projectName}/{templateName}/{processTitle}":{"post":{"summary":"Create a process with given lido file","description":"Create a new process, get metadata from content of the lido file ","operationId":"createNewProcess","parameters":[{"name":"projectName","in":"path","required":true,"schema":{"type":"string"}},{"name":"templateName","in":"path","required":true,"schema":{"type":"string"}},{"name":"processTitle","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Project not found or process template not found."},"409":{"description":"The process title is already used."},"500":{"description":"Internal error"}}}},"/api/metadata/lido/{processid}":{"post":{"summary":"Replace existing metadata with the content of the lido file","description":"Replace existing metadata with the content of the lido file","operationId":"replaceMetadata","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/login/header":{"get":{"tags":["login"],"summary":"Header login","description":"Checks a configurable header for a username and logs in the user if it is found in the DB","operationId":"apacheHeaderLogin","responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/login/openid/implicitflow":{"post":{"tags":["login"],"summary":"OpenID connect callback","description":"Verifies an openID claim and starts a session for the user","operationId":"openIdLogin","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id_token":{"type":"string"}}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"500":{"description":"Internal error"}}}},"/api/login/openid/authorizationcodeflow":{"post":{"tags":["login"],"summary":"OpenID connect callback","description":"Verifies an openID claim and starts a session for the user","operationId":"openIdLoginAuthFlow","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"error":{"type":"string"},"code":{"type":"string"},"state":{"type":"string"}}}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"500":{"description":"Internal error"}}}},"/api/metadata/marc/{projectName}/{templateName}/{processTitle}":{"post":{"summary":"Create a process with given marc file","description":"Create a new process, get metadata from content of the marc file ","operationId":"createNewProcess_1","parameters":[{"name":"projectName","in":"path","required":true,"schema":{"type":"string"}},{"name":"templateName","in":"path","required":true,"schema":{"type":"string"}},{"name":"processTitle","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Project not found or process template not found."},"409":{"description":"The process title is already used."},"500":{"description":"Internal error"}}}},"/api/metadata/marc/{processid}":{"post":{"summary":"Replace existing metadata with the content of the marc file","description":"Replace existing metadata with the content of the marc file","operationId":"replaceMetadata_1","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/view/media/{process}/{folder}/{filename}":{"get":{"summary":"Serves a media resource","description":"Serves a media resource consisting of a process name, a directory name and a resource name","operationId":"serveMediaContent","parameters":[{"name":"process","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/swagger/openapi.json":{"get":{"summary":"Returns the API description","description":"Returns the description about all services in the API","operationId":"getOpenApi","responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/metadata/pica/{projectName}/{templateName}/{processTitle}":{"post":{"summary":"Create a process with given pica file","description":"Create a new process, get metadata from content of the pica file ","operationId":"createNewProcess_2","parameters":[{"name":"projectName","in":"path","required":true,"schema":{"type":"string"}},{"name":"templateName","in":"path","required":true,"schema":{"type":"string"}},{"name":"processTitle","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Project not found or process template not found."},"409":{"description":"The process title is already used."},"500":{"description":"Internal error"}}}},"/api/metadata/pica/{processid}":{"post":{"summary":"Replace existing metadata with the content of the pica file","description":"Replace existing metadata with the content of the pica file","operationId":"replaceMetadata_2","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"*/*":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/plugins":{"get":{"summary":"Returns the list of plugins","description":"Returns a list with all plugins, containing information about these plugins","operationId":"getPlugins","responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/step/{stepid}/close":{"put":{"tags":["process"],"summary":"Close a step","description":"Close a step","operationId":"closeStep","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}},{"name":"stepid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/step/close":{"put":{"tags":["process"],"summary":"Close the first step matching the given name","description":"Close the first step matching the given name","operationId":"closeStepGivenName","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestStepQueryResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestStepQueryResource"}}}},"responses":{"200":{"description":"OK"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/journal":{"get":{"tags":["process"],"summary":"Get the journal for a process resource","description":"Get a list of all journal entries for a given process","operationId":"getJournal","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"put":{"tags":["process"],"summary":"Update a journal entry","description":"Update an existing journal entry for a given process","operationId":"updateJournalEntry","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestJournalResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"post":{"tags":["process"],"summary":"Create a new journal entry","description":"Create a new journal entry for a given process","operationId":"createJournalEntry","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestJournalResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"delete":{"tags":["process"],"summary":"Delete an existing journal entry","description":"Delete an existing journal entry","operationId":"deleteJournalEntry","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestJournalResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Journal entry not found"},"409":{"description":"Journal entry belongs to a different process."},"500":{"description":"Internal error"}}}},"/api/process/{processid}/metadata":{"get":{"tags":["process"],"summary":"Get metadata for a process resource","description":"Get a list of metadata for a given process","operationId":"getMetadata","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"put":{"tags":["process"],"summary":"Update a metadata","description":"Update an existing metadata for a given process","operationId":"updateMetadata","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestMetadataResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"post":{"tags":["process"],"summary":"Add metadata to a docstruct","description":"Create a new metadata field and add it to the given docstruct","operationId":"createMetadata","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestMetadataResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"delete":{"tags":["process"],"summary":"Add metadata to a docstruct","description":"Create a new metadata field and add it to the given docstruct","operationId":"deleteMetadata","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestMetadataResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process":{"put":{"tags":["process"],"summary":"Update an existing process","description":"Update an existing process, set new name, project, ....","operationId":"updateProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestProcessResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestProcessResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"403":{"description":"Forbidden - some requirements are not fulfilled."},"404":{"description":"Process not found"},"406":{"description":"New process title contains invalid character."},"409":{"description":"New process title already exists."},"500":{"description":"Internal error"}}},"post":{"tags":["process"],"summary":"Create a new process","description":"Create a new process","operationId":"createProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestProcessResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestProcessResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request - required data is missing"},"403":{"description":"Forbidden - some requirements are not fulfilled."},"404":{"description":"Data not found"},"406":{"description":"New process title contains invalid character."},"409":{"description":"New process title already exists."},"500":{"description":"Internal error"}}},"delete":{"tags":["process"],"summary":"Delete an existing process","description":"Delete an existing process and all its content","operationId":"deleteProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestProcessResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestProcessResource"}}}},"responses":{"200":{"description":"OK"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/property":{"put":{"tags":["process"],"summary":"Update a property","description":"Update an existing property for a given process","operationId":"updateProperty","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestPropertyResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"post":{"tags":["process"],"summary":"Create a property","description":"Create a new property for a given process","operationId":"createProperty","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestPropertyResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}},"delete":{"tags":["process"],"summary":"Delete a property","description":"Delete a property from a given process","operationId":"deleteProperty","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestPropertyResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/step":{"put":{"tags":["process"],"summary":"Update an existing step","description":"Update an existing step","operationId":"updateStep","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestStepResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestStepResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"403":{"description":"Forbidden - some requirements are not fulfilled."},"404":{"description":"Process not found"},"406":{"description":"New process title contains invalid character."},"409":{"description":"New process title already exists."},"500":{"description":"Internal error"}}},"post":{"tags":["process"],"summary":"Add a new step","description":"Add a new step to an existing process","operationId":"createStep","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestStepResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestStepResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"403":{"description":"Forbidden - some requirements are not fulfilled."},"404":{"description":"Process not found"},"406":{"description":"New process title contains invalid character."},"409":{"description":"New process title already exists."},"500":{"description":"Internal error"}}},"delete":{"tags":["query"],"summary":"Delete a step","description":"Delete a step","operationId":"deleteStep","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestStepResource"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestStepResource"}}}},"responses":{"200":{"description":"OK"},"404":{"description":"Process not found"},"409":{"description":"Step belongs to a different process."},"500":{"description":"Internal error"}}}},"/api/process/{processid}":{"get":{"tags":["process"],"summary":"Serves a process resource","description":"Serves a process resource consisting of a process name, id, project name","operationId":"getProcessData","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/properties":{"get":{"tags":["process"],"summary":"Get all properties for a process resource","description":"Get a list of all properties for a given process","operationId":"getProperties","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/property/{propertyid}":{"get":{"tags":["process"],"summary":"Get the property for a process resource","description":"Get a property for a given process","operationId":"getProperty","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}},{"name":"propertyid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/step/{stepid}":{"get":{"tags":["process"],"summary":"Serves a step resource","description":"Get a specific step","operationId":"getStep","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}},{"name":"stepid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/{processid}/steps":{"get":{"tags":["process"],"summary":"Serves a step list resource","description":"Get a list of all steps for a given process","operationId":"getStepList","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"404":{"description":"Process not found"},"500":{"description":"Internal error"}}}},"/api/process/query":{"put":{"tags":["process"],"summary":"Retrieve ids of processes satisfying the input condition.","description":"retrieve ids of processes satisfying the input condition","operationId":"retrieveProcessesSatisfyingCondition","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/RestProcessQueryResource"}}}},"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"403":{"description":"Forbidden - some requirements are not fulfilled."},"500":{"description":"Internal error"}}}},"/api/process/{processid}/startsteps":{"put":{"tags":["process"],"summary":"Start open automatic steps of a process","description":"start open automatic steps of this process","operationId":"startOpenAutomaticStepsOfTheProcess","parameters":[{"name":"processid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad request"},"403":{"description":"Forbidden - some requirements are not fulfilled."},"404":{"description":"Process not found"},"406":{"description":"New process title contains invalid character."},"409":{"description":"New process title already exists."},"500":{"description":"Internal error"}}}},"/api/processes":{"post":{"summary":"Creates a new process","description":"Creates a new process with given metadata and process properties.","operationId":"createProcess_1","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProcessCreationRequest"}}}},"responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/vocabulary/{vocabulary}/{searchvalue}":{"get":{"tags":["vocabulary"],"summary":"Searches for a term within all fields of a vocabulary","description":"Searches for a term within all fields of a vocabulary","operationId":"findRecords","parameters":[{"name":"vocabulary","in":"path","required":true,"schema":{"type":"string"}},{"name":"searchvalue","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal error"}}}},"/api/vocabulary/{vocabulary}/{fieldname}/{searchvalue}":{"get":{"tags":["vocabulary"],"summary":"Searches for a term within all fields of a vocabulary","description":"Searches for a term within all fields of a vocabulary","operationId":"findRecords_1","parameters":[{"name":"vocabulary","in":"path","required":true,"schema":{"type":"string"}},{"name":"fieldname","in":"path","required":true,"schema":{"type":"string"}},{"name":"searchvalue","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal error"}}}},"/api/vocabulary/records/{vocabulary}/{record}":{"get":{"tags":["vocabulary"],"summary":"Returns a vocabulary from URL","description":"Returns a vocabulary from URL","operationId":"getRecord","parameters":[{"name":"vocabulary","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"record","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal error"}}}},"/api/vocabulary/records/jskos/{vocabulary}/{record}":{"get":{"tags":["vocabulary"],"summary":"Returns a jskos vocabulary","description":"Returns a jskos vocabulary from URL and an ID","operationId":"getRecordAsJskos","parameters":[{"name":"vocabulary","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"record","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal error"}}}},"/api/vocabulary/{vocabulary}":{"get":{"tags":["vocabulary"],"summary":"Returns a complete vocabulary including all records","description":"Returns a complete vocabulary including all records. Can be used to display drop down lists in mets editor.","operationId":"getVocabularyByName","parameters":[{"name":"vocabulary","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"500":{"description":"Internal error"}}}},"/api/dummy/path/to/avoid/resource/configuration/errors/info.json":{"get":{"summary":"Returns information about an image","description":"Returns information about the image in JSON or JSONLD format","operationId":"getInfoAsJson","responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal error"}}}},"/api/image/{process}/{folder}/list":{"get":{"summary":"Returns information about image directories","description":"Returns information about image directories in JSON or JSONLD format","operationId":"getListAsJson","parameters":[{"name":"process","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/process/image/{process}/{folder}/{filename}/info.json":{"get":{"summary":"Returns information about an image","description":"Returns information about an image in JSON or JSONLD format","operationId":"getInfoAsJson_1","parameters":[{"name":"process","in":"path","required":true,"schema":{"type":"string"}},{"name":"folder","in":"path","required":true,"schema":{"type":"string"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"500":{"description":"Internal error"}}}},"/api/tmp/image/{foldername}/{filename}/info.json":{"get":{"summary":"Returns information about an image","description":"Returns information about the image in JSON or JSONLD format","operationId":"getInfoAsJson_2","parameters":[{"name":"foldername","in":"path","required":true,"schema":{"type":"string"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal error"}}}},"/api/process/thumbs/{processId}/{foldername}/{filename}/info.json":{"get":{"summary":"Returns information about an image","description":"Returns information about the image in JSON or JSONLD format","operationId":"getInfoAsJson_3","parameters":[{"name":"processId","in":"path","required":true,"schema":{"type":"string"}},{"name":"foldername","in":"path","required":true,"schema":{"type":"string"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal error"}}}}},"components":{"schemas":{"SessionInfo":{"type":"object","properties":{"sessionCreatedFormatted":{"type":"string"},"lastAccessFormatted":{"type":"string"},"userIpAddress":{"type":"string"},"userName":{"type":"string"},"browserName":{"type":"string"}}},"ApiResponse":{"type":"object","properties":{"description":{"type":"string"},"headers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Header"}},"content":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/MediaType"}},"links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"get$ref":{"type":"string"}}},"ApiResponses":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"default":{"$ref":"#/components/schemas/ApiResponse"},"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/ApiResponse"}},"Callback":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"get$ref":{"type":"string"},"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/PathItem"}},"Components":{"type":"object","properties":{"schemas":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Schema"}},"responses":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ApiResponse"}},"parameters":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Parameter"}},"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Example"}},"requestBodies":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/RequestBody"}},"headers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Header"}},"securitySchemes":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/SecurityScheme"}},"links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Link"}},"callbacks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Callback"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Contact":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"email":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Content":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/MediaType"}},"Discriminator":{"type":"object","properties":{"propertyName":{"type":"string"},"mapping":{"type":"object","additionalProperties":{"type":"string"}}}},"Encoding":{"type":"object","properties":{"contentType":{"type":"string"},"headers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Header"}},"style":{"type":"string","enum":["form","spaceDelimited","pipeDelimited","deepObject"]},"explode":{"type":"boolean"},"allowReserved":{"type":"boolean"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Example":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"value":{"type":"object"},"externalValue":{"type":"string"},"get$ref":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"ExternalDocumentation":{"type":"object","properties":{"description":{"type":"string"},"url":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Header":{"type":"object","properties":{"description":{"type":"string"},"get$ref":{"type":"string"},"required":{"type":"boolean"},"deprecated":{"type":"boolean"},"style":{"type":"string","enum":["simple"]},"explode":{"type":"boolean"},"schema":{"$ref":"#/components/schemas/Schema"},"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Example"}},"example":{"type":"object"},"content":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/MediaType"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Info":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"termsOfService":{"type":"string"},"contact":{"$ref":"#/components/schemas/Contact"},"license":{"$ref":"#/components/schemas/License"},"version":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"License":{"type":"object","properties":{"name":{"type":"string"},"url":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Link":{"type":"object","properties":{"operationRef":{"type":"string"},"operationId":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"requestBody":{"type":"object"},"headers":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Header"}},"description":{"type":"string"},"get$ref":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"server":{"$ref":"#/components/schemas/Server"}}},"MediaType":{"type":"object","properties":{"schema":{"$ref":"#/components/schemas/Schema"},"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Example"}},"example":{"type":"object"},"encoding":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Encoding"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"OAuthFlow":{"type":"object","properties":{"authorizationUrl":{"type":"string"},"tokenUrl":{"type":"string"},"refreshUrl":{"type":"string"},"scopes":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"OAuthFlows":{"type":"object","properties":{"implicit":{"$ref":"#/components/schemas/OAuthFlow"},"password":{"$ref":"#/components/schemas/OAuthFlow"},"clientCredentials":{"$ref":"#/components/schemas/OAuthFlow"},"authorizationCode":{"$ref":"#/components/schemas/OAuthFlow"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"OpenAPI":{"type":"object","properties":{"openapi":{"type":"string"},"info":{"$ref":"#/components/schemas/Info"},"externalDocs":{"$ref":"#/components/schemas/ExternalDocumentation"},"servers":{"type":"array","items":{"$ref":"#/components/schemas/Server"}},"security":{"type":"array","items":{"$ref":"#/components/schemas/SecurityRequirement"}},"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"paths":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/PathItem"}},"components":{"$ref":"#/components/schemas/Components"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"jsonSchemaDialect":{"type":"string"}}},"Operation":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"string"}},"summary":{"type":"string"},"description":{"type":"string"},"externalDocs":{"$ref":"#/components/schemas/ExternalDocumentation"},"operationId":{"type":"string"},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}},"requestBody":{"$ref":"#/components/schemas/RequestBody"},"responses":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"default":{"$ref":"#/components/schemas/ApiResponse"},"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/ApiResponse"}},"callbacks":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Callback"}},"deprecated":{"type":"boolean"},"security":{"type":"array","items":{"$ref":"#/components/schemas/SecurityRequirement"}},"servers":{"type":"array","items":{"$ref":"#/components/schemas/Server"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Parameter":{"type":"object","properties":{"name":{"type":"string"},"in":{"type":"string"},"description":{"type":"string"},"required":{"type":"boolean"},"deprecated":{"type":"boolean"},"allowEmptyValue":{"type":"boolean"},"get$ref":{"type":"string"},"style":{"type":"string","enum":["matrix","label","form","simple","spaceDelimited","pipeDelimited","deepObject"]},"explode":{"type":"boolean"},"allowReserved":{"type":"boolean"},"schema":{"$ref":"#/components/schemas/Schema"},"examples":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Example"}},"example":{"type":"object"},"content":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/MediaType"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"PathItem":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"get":{"$ref":"#/components/schemas/Operation"},"put":{"$ref":"#/components/schemas/Operation"},"post":{"$ref":"#/components/schemas/Operation"},"delete":{"$ref":"#/components/schemas/Operation"},"options":{"$ref":"#/components/schemas/Operation"},"head":{"$ref":"#/components/schemas/Operation"},"patch":{"$ref":"#/components/schemas/Operation"},"trace":{"$ref":"#/components/schemas/Operation"},"servers":{"type":"array","items":{"$ref":"#/components/schemas/Server"}},"parameters":{"type":"array","items":{"$ref":"#/components/schemas/Parameter"}},"get$ref":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Paths":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/PathItem"}},"RequestBody":{"type":"object","properties":{"description":{"type":"string"},"content":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/MediaType"}},"required":{"type":"boolean"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"get$ref":{"type":"string"}}},"Schema":{"type":"object","properties":{"title":{"type":"string"},"multipleOf":{"type":"number"},"maximum":{"type":"number"},"exclusiveMaximum":{"type":"boolean"},"minimum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"maxLength":{"type":"integer","format":"int32"},"minLength":{"type":"integer","format":"int32"},"pattern":{"type":"string"},"maxItems":{"type":"integer","format":"int32"},"minItems":{"type":"integer","format":"int32"},"uniqueItems":{"type":"boolean"},"maxProperties":{"type":"integer","format":"int32"},"minProperties":{"type":"integer","format":"int32"},"required":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"not":{"$ref":"#/components/schemas/Schema"},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Schema"}},"additionalProperties":{"type":"object"},"description":{"type":"string"},"format":{"type":"string"},"get$ref":{"type":"string"},"nullable":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"example":{"type":"object"},"externalDocs":{"$ref":"#/components/schemas/ExternalDocumentation"},"deprecated":{"type":"boolean"},"xml":{"$ref":"#/components/schemas/XML"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}},"items":{"$ref":"#/components/schemas/SchemaObject"},"get$vocabulary":{"type":"string"},"get$dynamicAnchor":{"type":"string"},"enum":{"type":"array","items":{"type":"object"}},"default":{"type":"object"}}},"SchemaObject":{"type":"object","properties":{"title":{"type":"string"},"multipleOf":{"type":"number"},"maximum":{"type":"number"},"exclusiveMaximum":{"type":"boolean"},"minimum":{"type":"number"},"exclusiveMinimum":{"type":"boolean"},"maxLength":{"type":"integer","format":"int32"},"minLength":{"type":"integer","format":"int32"},"pattern":{"type":"string"},"maxItems":{"type":"integer","format":"int32"},"minItems":{"type":"integer","format":"int32"},"uniqueItems":{"type":"boolean"},"maxProperties":{"type":"integer","format":"int32"},"minProperties":{"type":"integer","format":"int32"},"required":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"not":{"$ref":"#/components/schemas/Schema"},"properties":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Schema"}},"additionalProperties":{"type":"object"},"description":{"type":"string"},"format":{"type":"string"},"get$ref":{"type":"string"},"nullable":{"type":"boolean"},"readOnly":{"type":"boolean"},"writeOnly":{"type":"boolean"},"example":{"type":"object"},"externalDocs":{"$ref":"#/components/schemas/ExternalDocumentation"},"deprecated":{"type":"boolean"},"xml":{"$ref":"#/components/schemas/XML"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"discriminator":{"$ref":"#/components/schemas/Discriminator"},"allOf":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}},"anyOf":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}},"oneOf":{"type":"array","items":{"$ref":"#/components/schemas/Schema"}},"items":{"$ref":"#/components/schemas/SchemaObject"},"get$vocabulary":{"type":"string"},"get$dynamicAnchor":{"type":"string"},"enum":{"type":"array","items":{"type":"object"}},"default":{"type":"object"}}},"Scopes":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"type":"string"}},"SecurityRequirement":{"type":"object","properties":{"empty":{"type":"boolean"}},"additionalProperties":{"type":"array","items":{"type":"string"}}},"SecurityScheme":{"type":"object","properties":{"type":{"type":"string","enum":["apiKey","http","oauth2","openIdConnect","mutualTLS"]},"description":{"type":"string"},"name":{"type":"string"},"get$ref":{"type":"string"},"in":{"type":"string","enum":["cookie","header","query"]},"scheme":{"type":"string"},"bearerFormat":{"type":"string"},"flows":{"$ref":"#/components/schemas/OAuthFlows"},"openIdConnectUrl":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"Server":{"type":"object","properties":{"url":{"type":"string"},"description":{"type":"string"},"variables":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/ServerVariable"}},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"ServerVariable":{"type":"object","properties":{"description":{"type":"string"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"enum":{"type":"array","items":{"type":"string"}},"default":{"type":"string"}}},"ServerVariables":{"type":"object","properties":{"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true},"empty":{"type":"boolean"}},"additionalProperties":{"$ref":"#/components/schemas/ServerVariable"}},"Tag":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"externalDocs":{"$ref":"#/components/schemas/ExternalDocumentation"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"XML":{"type":"object","properties":{"name":{"type":"string"},"namespace":{"type":"string"},"prefix":{"type":"string"},"attribute":{"type":"boolean"},"wrapped":{"type":"boolean"},"extensions":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}}},"PluginInfo":{"type":"object","properties":{"filename":{"type":"string"},"buildDate":{"type":"string","format":"date-time"},"gitHash":{"type":"string"},"goobiVersion":{"type":"string"},"containedPlugins":{"type":"array","items":{"type":"string"}},"pluginsUsedInWorkflows":{"type":"array","items":{"type":"string"}}}},"RestStepQueryResource":{"type":"object","properties":{"stepname":{"type":"string"}},"xml":{"name":"step"}},"RestJournalResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"processId":{"type":"integer","format":"int32"},"creationDate":{"type":"string","format":"date-time"},"userName":{"type":"string"},"type":{"type":"string"},"message":{"type":"string"},"filename":{"type":"string"}},"xml":{"name":"journal"}},"RestMetadataResource":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"metadataLevel":{"type":"string"},"authorityValue":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"}},"xml":{"name":"metadata"}},"RestProcessResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"title":{"type":"string"},"projectName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"status":{"type":"string"},"numberOfImages":{"type":"integer","format":"int32"},"numberOfMetadata":{"type":"integer","format":"int32"},"numberOfDocstructs":{"type":"integer","format":"int32"},"rulesetName":{"type":"string"},"batchNumber":{"type":"integer","format":"int32"},"docketName":{"type":"string"},"processTemplateName":{"type":"string"},"documentType":{"type":"string"},"propertiesList":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"metadataList":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"metadataLevel":{"type":"string"}},"xml":{"name":"process"}},"RestPropertyResource":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"value":{"type":"string"},"creationDate":{"type":"string","format":"date-time"}},"xml":{"name":"property"}},"RestStepResource":{"type":"object","properties":{"stepId":{"type":"integer","format":"int32"},"steptitle":{"type":"string"},"processId":{"type":"integer","format":"int32"},"processName":{"type":"string"},"status":{"type":"string"},"priority":{"type":"integer","format":"int32"},"order":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"finishDate":{"type":"string","format":"date-time"},"properties":{"type":"object","additionalProperties":{"type":"boolean"}},"scripts":{"type":"object","additionalProperties":{"type":"string"}},"httpStepConfiguration":{"type":"object","additionalProperties":{"type":"string"}},"plugin":{"type":"string"},"validationPlugin":{"type":"string"},"queueType":{"type":"string"},"usergroups":{"type":"array","items":{"type":"string"}}},"xml":{"name":"step"}},"RestProcessQueryResource":{"type":"object","properties":{"filter":{"type":"string"},"conditions":{"type":"array","items":{"type":"string"}}},"xml":{"name":"query"}},"OpacConfig":{"type":"object","properties":{"opacName":{"type":"string"},"searchField":{"type":"string"}}},"ProcessCreationRequest":{"type":"object","properties":{"identifier":{"type":"string"},"processtitle":{"type":"string"},"logicalDSType":{"type":"string"},"templateId":{"type":"integer","format":"int32"},"templateName":{"type":"string"},"opacConfig":{"$ref":"#/components/schemas/OpacConfig"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"xml":{"wrapped":true}},"properties":{"type":"object","additionalProperties":{"type":"string"},"xml":{"wrapped":true}}},"xml":{"name":"record"}},"IiifProfile":{"type":"object"},"ImageInformation":{"type":"object","properties":{"@context":{"type":"string","format":"uri"},"@id":{"type":"string","format":"uri"},"protocol":{"type":"string"},"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"attribution":{"type":"string"},"license":{"type":"string"},"logo":{"type":"string"},"sizes":{"type":"array","items":{"$ref":"#/components/schemas/ImageSize"}},"tiles":{"type":"array","items":{"$ref":"#/components/schemas/ImageTile"}},"profile":{"type":"array","items":{"$ref":"#/components/schemas/IiifProfile"}},"service":{"type":"array","items":{"$ref":"#/components/schemas/Service"}},"sizesFromDimensions":{"type":"array","writeOnly":true,"items":{"type":"object","properties":{"width":{"type":"number","format":"double"},"height":{"type":"number","format":"double"}}}}}},"ImageSize":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"}}},"ImageTile":{"type":"object","properties":{"width":{"type":"integer","format":"int32"},"height":{"type":"integer","format":"int32"},"scaleFactors":{"type":"array","items":{"type":"integer","format":"int32"}}}},"Service":{"type":"object","properties":{"@context":{"type":"string","format":"uri"}}}},"securitySchemes":{"query":{"type":"apiKey","name":"token","in":"query"},"header":{"type":"apiKey","name":"token","in":"header"},"basic":{"type":"apiKey","name":"Authorization","in":"header"}}}}