{"components":{"schemas":{"ClientError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Client error","type":"object"},"CommonError":{"description":"Common error","properties":{"errors":{"description":"Optional list of multiple errors occurred.\nMust not be null.","items":{"type":"object"},"type":"array"},"message":{"description":"Message describing the error.\nMust not be null.","type":"string"},"path":{"description":"URL path where the error occurred.\nMust not be null.","type":"string"},"status":{"description":"Textual representation of http status code, e.g. 'BAD_REQUEST' for status code 400.\nMust not be null.","type":"string"},"timestamp":{"description":"Timestamp in UTC when the error occurred.\nMust not be null.","format":"date-time","type":"string"},"uuid":{"description":"UUID generated by the server to identify the error occurred, should be stated in case of any inquiries.\nMust not be null.","type":"string"}},"required":["status","message","timestamp","path","uuid","errors"],"type":"object"},"Ident":{"description":"Unique identifier.","examples":["613c060c-52bc-472e-bb2f-16cd431fef7b"],"maxLength":100,"minLength":1,"pattern":"[a-zA-Z0-9_.~-]*","type":"string"},"ImageDto":{"allOf":[{"$ref":"#/components/schemas/ImageMetadataDto"}],"description":"The image","properties":{"filesize":{"description":"size of the file.\nMust not be null.","format":"int64","type":"integer"},"ident":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"the image ident.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"thumbnailBase64DataUri":{"description":"base64 encoded thumbnail data URI.\nMust not be null.","type":"string"}},"required":["ident","filesize","thumbnailBase64DataUri"],"type":"object"},"ImageMetadataDto":{"description":"Metadata of an image","properties":{"altText":{"description":"alt text which is displayed alternatively.\nMust not be null.","type":"string"},"description":{"description":"description of an image.\nMust not be null.","type":"string"},"ident":{"allOf":[{"$ref":"#/components/schemas/Ident"}],"description":"the image ident.\nMust not be null.\nMust match the regular expression [a-zA-Z0-9_.~-]*."},"name":{"description":"name of the image.\nMust not be null.","type":"string"}},"required":["ident","name","description","altText"],"type":"object"},"ImageService.PagedResponse":{"description":"List of result elements with paging metadata.","properties":{"_embedded":{"description":"Result list.\nMust not be null.","items":{"$ref":"#/components/schemas/ImageDto"},"type":"array"},"page":{"$ref":"#/components/schemas/Page"}},"required":["page","_embedded"],"type":"object"},"Page":{"description":"Pagination metadata","properties":{"number":{"description":"Page number of total pages available.\nMust not be null.","format":"uint32","type":"integer"},"size":{"description":"Size of the page as specified by the query.\nMust not be null.","format":"uint32","type":"integer"},"totalElements":{"description":"Total count of all elements available for the query.\nMust not be null.","format":"uint32","type":"integer"},"totalPages":{"description":"Total count of all pages available for the query.\nMust not be null.","format":"uint32","type":"integer"}},"required":["size","number","totalElements","totalPages"],"type":"object"},"ServerError":{"allOf":[{"$ref":"#/components/schemas/CommonError"}],"description":"Server error","type":"object"}},"securitySchemes":{"oauth2":{"flows":{"clientCredentials":{"scopes":{"document-management-read":"","document-management-write":""},"tokenUrl":"https://api.instellix.io/<tenant_short>/oauth2/token"}},"type":"oauth2"}}},"info":{"description":"Endpoints regarding document images.","title":"Document Image Service","version":"v2-0.11.2"},"openapi":"3.1.0","paths":{"/v2/document-images":{"get":{"description":"List images (paged)","operationId":"retrieveImages","parameters":[{"description":"Use RSQL query language.\nSee: https://aboullaite.me/rsql/.","explode":false,"in":"query","name":"search","schema":{"type":"string"}},{"description":"Zero-based page index (0..n). Must be greater than or equal to 0.","in":"query","name":"page","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Size of the page to be returned. Max page size allowed is 100. Must be greater than or equal to 1.","in":"query","name":"size","schema":{"default":20,"minimum":1,"type":"integer"}},{"description":"A list of one or more sorting criteria each in the format 'property(,asc|desc)' with direction being case-insensitive.","in":"query","name":"sort","schema":{"default":["name"],"items":{"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageService.PagedResponse"}}},"description":"Standard response for successful HTTP requests."},"4XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientError"}}},"description":"Client error"},"5XX":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerError"}}},"description":"Server error"}},"security":[{"oauth2":["document-management-read"]}],"summary":"Retrieve images","tags":["Document Image"]},"post":{"description":"Upload image\nmultipart/form-data:\n- meta (JSON)\n- data (binary)","operationId":"createImage","requestBody":{"content":{"multipart/form-data":{"encoding":{"meta":{"contentType":"application/json"}},"schema":{"properties":{"data":{},"meta":{"$ref":"#/components/schemas/ImageMetadataDto"}},"required":["meta","data"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageDto"}}},"description":"The request has succeeded."}},"security":[{"oauth2":["document-management-write"]}],"summary":"Create Image","tags":["Document Image"]}},"/v2/document-images/{imageIdent}":{"delete":{"description":"Delete image","operationId":"deleteImage","parameters":[{"description":"ident of requested image","in":"path","name":"imageIdent","required":true,"schema":{"$ref":"#/components/schemas/Ident"}}],"responses":{"204":{"description":"There is no content to send for this request, but the headers may be useful. "}},"security":[{"oauth2":["document-management-write"]}],"summary":"Delete an image","tags":["Document Image"]},"get":{"description":"Get image metadata","operationId":"retrieveSingleImage","parameters":[{"description":"ident of requested image","in":"path","name":"imageIdent","required":true,"schema":{"$ref":"#/components/schemas/Ident"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageDto"}}},"description":"The request has succeeded."}},"security":[{"oauth2":["document-management-read"]}],"summary":"Retrieve a single image","tags":["Document Image"]}},"/v2/document-images/{imageIdent}/data":{"get":{"description":"Get raw binary image data","operationId":"retrieveImageData","parameters":[{"description":"ident of requested image","in":"path","name":"imageIdent","required":true,"schema":{"$ref":"#/components/schemas/Ident"}}],"responses":{"200":{"content":{"image/jpeg":{"schema":{"contentMediaType":"image/jpeg"}}},"description":"a jpeg response"}},"security":[{"oauth2":["document-management-read"]}],"summary":"Retrieve image data","tags":["Document Image"]}}},"servers":[{"description":"Instellix Production","url":"https://api.instellix.io"}],"tags":[{"description":"endpoints for Document Image","externalDocs":{"url":"https://docs.nitrobox.io"},"name":"Document Image"}],"x-readme":{"explorer-enabled":false,"proxy-enabled":true}}