V3.0

openapi: 3.0.1 x-jh: publishing: type: Integration stage: prod isPublic: true group: Synergy name: Document Archiving docURL: https://jkhy.github.io/synergyintegration info: title: SynergyECM Document Filing description: APIs for Cross-Indexing and Refiling contact: email: SynergyOpenAPI@jackhenry.com version: v3 security: - BearerAuth: [] servers: - url: 'http:/jx-r.jhacorp.com/api' paths: '/v2/{InstitutionUniversalId}/{ProductId}/storage/api-versions': get: tags: - ApiVersions summary: The API Version supported by this instance. operationId: StorageApiVersionsGet parameters: - name: InstitutionUniversalId in: path required: true schema: type: string - name: ProductId in: path required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: text/plain: schema: $ref: '#/components/schemas/ApiVersionsResponseBody' application/json: schema: $ref: '#/components/schemas/ApiVersionsResponseBody' text/json: schema: $ref: '#/components/schemas/ApiVersionsResponseBody' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/archive-transactions': post: tags: - ArchiveTransactions summary: Begins an archive transaction for the purpose of importing a new document into Synergy. description: "### Begin Archive Transaction\r\nBegins an archive transaction for the purpose of importing a new document into Synergy.<br/><br/>All metadata for the document is supplied at this stage.\r\nFile data is provided in subsequent operations, in one of two modes: *ad hoc* or *pre-registered*.\r\n- Ad hoc<br/>\r\n If no file information is provided in this call, then one or more files can be uploaded to the \".../files\"\r\n collection before the archive transaction is committed.\r\n- Pre-registered<br/>\r\n An array of file names with their respective sizes can be provided on this initial call. If so,\r\n an array of *file Ids* will be returned, and files may then be uploaded (in chunks if necessary)\r\n to the.../files/{fileId} route. File data for *all* file Ids must be uploaded prior to committing the archive transaction.\r\n\r\nNote that the two methods of uploading files are not interchangeable. It is an error to call the ad hoc route when\r\nfiles were pre-registered in the initial call.<br/><br/>\r\nFinally, after the file(s) data is uploaded, the archive transaction must be committed before it will be filed into Synergy.\r\nUpon a successful commit, a unique item Id is returned, and the document is available for immediate retrieval in Synergy." operationId: ArchiveTransactionsBeginDocument parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveDocumentInfo' responses: '201': description: 'Created: Returns a transaction ID used for subsequent calls to the archive API.' content: application/json: schema: $ref: '#/components/schemas/ArchiveTransactionBeginResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/archive-transactions/{documentTransactionId}/files': put: tags: - ArchiveTransactions summary: Adds a new file to a previously created archive transaction (Ad hoc). description: "### Add Archive File (Ad hoc)\r\nAdds a new file to a previously created archive transaction.\r\n\r\nThis route is intended for simple uploading of small files in a single operation.\r\nUse it when adding files to a document where file info was not\r\npre-registered in the `Files` property of the document's metadata.\r\n\r\nIf a file Id was acquired when beginning the archive transaction, *do not* use this route to upload it.\r\nInstead, use the \".../files/{fileId}\" route.\r\n\r\nOne of the following parameters is required when calling this route to determine a file's type:\r\n - The `filename` query parameter, from which the file extension will be used.\r\n - The `Content-Type` header, which will be coerced into a file extension.\r\n\r\nThe above is used to determine if the file type (by extension) has been configured in Synergy's\r\nupload allow list. If both are provided, the filename extension takes precedence. If neither is \r\nprovided, or the extension is not in the allow list, an error will result. " operationId: ArchiveTransactionsAddFile parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: documentTransactionId in: path description: The transaction Id acquired when beginning the archive transaction. required: true schema: type: string format: uuid - name: fileNumber in: query description: "Used as a sorting key when multiple files are added. \r\nDefaults to 0, in which case files are added in the order received." schema: type: integer format: int32 default: 0 - name: isAttachment in: query description: "If true, this indicates the file should be treated as an attachment, and not part of the page data.\r\nThere are limited use-cases for this feature, and it should be used only when required." schema: type: boolean default: false - name: attachmentAudience in: query description: "This specifies the use-case for the attachment. \r\nThis must be provided for an attachment and must match a predefined value." schema: type: string - name: filename in: query description: "Optional filename with extension. \r\nIf provided, this will be used to determine the file type." schema: type: string - name: Digest in: header description: "The optional expected sha-256 `Digest` header. \r\nIf this header is populated, it will be used for server-side validation, and will result in an error if it does not match the received file data.\r\nOn success, the computed sha-256 digest is always returned in the Digest response header for client-side validation.\r\n\r\nExample: `sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0=`" schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/octet-stream: schema: type: string description: File to upload. format: binary image/tiff: schema: type: string description: File to upload. format: binary image/jpeg: schema: type: string description: File to upload. format: binary image/png: schema: type: string description: File to upload. format: binary application/pdf: schema: type: string description: File to upload. format: binary responses: '200': description: Success '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The archive transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/archive-transactions/{documentTransactionId}/files/{FileId}': put: tags: - ArchiveTransactions summary: Adds data to a file previously declared when creating an archive transaction. description: "### Add Archive File (Pre-registered)\r\nAdds data to a file that was previously declared when creating an archive transaction.\r\nThe file Id in the route is obtained from the `FileResponse` array that is returned\r\nwhen creating the archive transaction with pre-registered file info (the `Files` array property).<br/><br/>It is possible to upload partial data, such that a single file can be divided and\r\nuploaded over multiple calls. However, the back-end implementation requires that data\r\nbe uploaded synchronously in consecutive chunks. i.e., you cannot upload two halves of a\r\ngiven file in two concurrent calls. Data arriving out of order will result in an error.<br/><br/><br/>If the `Content-Range` header is present, it must be expressed in bytes. \r\n> Example: `Content-Range: bytes 0-10000/50000`<br/>" operationId: ArchiveTransactionsAddRegisteredFile parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: documentTransactionId in: path description: The transaction Id acquired when beginning the archive transaction. required: true schema: type: string - name: FileId in: path description: The file Id obtained from the `FileResponse` array when creating the archive transaction. required: true schema: type: string - name: Digest in: header description: "The optional expected sha-256 `Digest` header. \r\nIf this header is populated, it will be used for server-side validation, and will result in an error if it does not match the received file data.\r\nOn success, the computed sha-256 digest is always returned in the Digest response header for client-side validation.\r\n\r\nExample: `sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0=`" schema: type: string - name: Content-Range in: header description: "Optional `Content-Range` header for uploading part of a file. \r\nExample, put the first MB: `bytes 0-999999/*`" schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/octet-stream: schema: type: string description: File to upload. format: binary image/tiff: schema: type: string description: File to upload. format: binary image/jpeg: schema: type: string description: File to upload. format: binary image/png: schema: type: string description: File to upload. format: binary application/pdf: schema: type: string description: File to upload. format: binary responses: '200': description: Success '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The archive transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/archive-transactions/{documentTransactionId}/state': post: tags: - ArchiveTransactions summary: ' Transitions an archive transaction to either the `Commit` or `Rollback` state.' description: "### Commit or Rollback Archive Transaction\r\n\r\nIf successfully committed, a unique item Id is returned for a new document that has\r\njust been filed into Synergy, and is available for retrieval.\r\n\r\nIf the transaction is rolled back, the archive transaction, along with any files that have\r\nbeen uploaded for it, are deleted.\r\n\r\nIn either case, the archive transaction is removed and the archive transaction Id\r\nbecomes invalid." operationId: ArchiveTransactionsStateTransition parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: documentTransactionId in: path description: The transaction Id acquired when beginning the archive transaction. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveTransactonStateTransition' responses: '201': description: 'Created: Returned when successfully committed. A new Synergy document has been created using the transaction data and the response contains the unique item ID for the new Synergy document.' content: application/json: schema: $ref: '#/components/schemas/ArchiveTransactionCommitResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The archive transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '200': description: 'Success: Returned on a successful roll back of the archive transaction.' '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/batch-transactions': post: tags: - BatchTransactions summary: Begins a batch transaction for the purpose of submitting one or more documents into Synergy for subsequent processing. description: "### Begin Batch Transaction\r\nBegins a batch transaction for the purpose of submitting one or more documents into Synergy\r\nfor subsequent processing by Synergy Capture.\r\n\r\nOne or more document definitions must be added in subsequent calls, along with subsequent\r\ncalls to upload file data for each document.\r\n\r\nFinally, after the file(s) data is uploaded, the batch transaction must be committed before\r\nit will be used to create a new Synergy batch.\r\nUpon a successful commit, a batch GUID is returned, and the batch is available for subsequent\r\nprocessing in Synergy Capture. " operationId: BatchTransactionsBeginBatch parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BeginBatchTransactionInfo' responses: '201': description: 'Created: Returns a batch transaction Id used for subsequent calls to the batch transactions API.' content: application/json: schema: $ref: '#/components/schemas/BeginBatchTransactionResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/batch-transactions/{batchTransactionId}/documents': post: tags: - BatchTransactions summary: Begins a document definition within a batch transaction. description: "### Begin Document Definition\r\nBegins a document definition within a batch transaction.<br/><br/>All metadata for the document is supplied at this stage.\r\nFile data is provided in subsequent operations, in one of two modes: *ad hoc* or *pre-registered*.\r\n- Ad hoc<br/>\r\n If no file information is provided in this call, then one or more files can be uploaded to the \".../files\"\r\n collection before the archive transaction is committed.\r\n- Pre-registered<br/>\r\n An array of file names with their respective sizes can be provided on this initial call. If so,\r\n an array of *file Ids* will be returned, and files may then be uploaded (in chunks if necessary)\r\n to the.../files/{fileId} route. File data for *all* file Ids must be uploaded prior to committing the archive transaction.\r\n\r\nNote that the two methods of uploading files are not interchangeable. It is an error to call the ad hoc route when\r\nfiles were pre-registered in the initial call.<br/>" operationId: BatchTransactionsBeginDocument parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: batchTransactionId in: path description: The batch transaction Id returned from the Begin Batch Transaction operation. required: true schema: type: string format: uuid - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchDocumentInfo' responses: '200': description: 'Success: Returns a pending document transaction Id used in subsequent calls to the batch API.' content: application/json: schema: $ref: '#/components/schemas/ArchiveTransactionBeginResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The batch transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/batch-transactions/{batchTransactionId}/documents/{documentTransactionId}/cross-index-documents': post: tags: - BatchTransactions summary: Begins a cross-index document definition within a batch transaction. description: "### Add Batch Cross Index Document\r\n\r\nThis will add a document definition to the batch that references another document in the batch,\r\nbut with different indexing and classification.\r\nNo file data should be uploaded for this document, as cross-indexed documents share the file\r\ndata of their referenced document." operationId: BatchTransactionsBeginCrossIndexDocument parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: batchTransactionId in: path description: The batch transaction Id returned from the Begin Batch Transaction operation. required: true schema: type: string format: uuid - name: documentTransactionId in: path description: The primary document transaction Id acquired when beginning another document in this batch. required: true schema: type: string format: uuid - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveDocumentInfo' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ArchiveTransactionBeginResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The batch transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/batch-transactions/{batchTransactionId}/documents/{documentTransactionId}/files': put: tags: - BatchTransactions summary: Adds a new file to a previously created batch document (Ad hoc). description: "### Add Batch Document File (Ad hoc)\r\nAdds a new file to a previously created document in the given batch transaction.\r\n\r\nThis route is intended for simple uploading of small files in a single operation.\r\nUse it when adding files to a document where file info was not\r\npre-registered in the `Files` property of the document's metadata.\r\n\r\nIf a file Id was acquired when beginning the document, *do not* use this route to upload it.\r\nInstead, use the \".../files/{fileId}\" route.\r\n\r\nOne of the following parameters is required when calling this route to determine a file's type:\r\n- The `filename` query parameter, from which the file extension will be used.\r\n- The `Content-Type` header, which will be translated into a file extension.\r\n\r\n> The above is used to determine if the file type (by extension) has been configured in Synergy's\r\n> upload allow list. If both are provided, the filename extension takes precedence. If neither is \r\n> provided, or the extension is not in the allow list, an error will result." operationId: BatchTransactionsAddFile parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: batchTransactionId in: path description: The batch transaction Id returned from the Begin Batch Transaction operation. required: true schema: type: string format: uuid - name: documentTransactionId in: path description: The document transaction Id acquired when beginning the document. required: true schema: type: string format: uuid - name: fileNumber in: query description: 'Used as a sorting key when multiple files are added. Defaults to 0, in which case files are added in the order received.' schema: type: integer format: int32 default: 0 - name: filename in: query description: 'Optional filename with extension. If provided, this will be used to determine the file type.' schema: type: string - name: Digest in: header description: "The optional expected sha-256 `Digest` header. \r\nIf this header is populated, it will be used for server-side validation, and will result in an error if it does not match the received file data.\r\nOn success, the computed sha-256 digest is always returned in the Digest response header for client-side validation.\r\n\r\nExample: `sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0=`" schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/octet-stream: schema: type: string description: File to upload. format: binary image/tiff: schema: type: string description: File to upload. format: binary image/jpeg: schema: type: string description: File to upload. format: binary image/png: schema: type: string description: File to upload. format: binary application/pdf: schema: type: string description: File to upload. format: binary responses: '200': description: Success '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The batch transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/batch-transactions/{batchTransactionId}/documents/{documentTransactionId}/files/{fileId}': put: tags: - BatchTransactions summary: Adds data to a file previously declared when adding a document to the batch transaction. description: "### Add Batch Document File (Pre-registered)\r\nAdds data to a file that was previously declared when creating a new document for the given batch transaction.\r\nThe file Id in the route is obtained from the `FileResponse` array that is returned\r\nwhen creating the archive transaction with pre-registered file info (the `Files` array property).\r\n\r\nIt is possible to upload partial data, such that a single file can be divided and\r\nuploaded over multiple calls. However, the back-end implementation requires that data\r\nbe uploaded synchronously in consecutive chunks. i.e., you cannot upload two halves of a\r\ngiven file in two concurrent calls.Data arriving out of order will result in an error.<br/><br/>It is possible to upload partial data, such that a single file can be divided and\r\nuploaded over multiple calls. However, the back-end implementation requires that data\r\nbe uploaded synchronously in consecutive chunks. i.e., you cannot upload two halves of a\r\ngiven file in two concurrent calls. Data arriving out of order will result in an error.<br/><br/><br/>If the `Content-Range` header is present, it must be expressed in bytes. \r\n> Example: `Content-Range: bytes 0-10000/50000`<br/>" operationId: BatchTransactionsAddRegisteredFile parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: batchTransactionId in: path description: The batch transaction Id returned from the Begin Batch Transaction operation. required: true schema: type: string format: uuid - name: documentTransactionId in: path description: The document transaction Id acquired when beginning the document. required: true schema: type: string format: uuid - name: fileId in: path description: The file Id obtained from the `FileResponse` array when beginning the document. required: true schema: type: string format: uuid - name: Digest in: header description: "The optional expected sha-256 `Digest` header. \r\nIf this header is populated, it will be used for server-side validation, and will result in an error if it does not match the received file data.\r\nOn success, the computed sha-256 digest is always returned in the Digest response header for client-side validation.\r\n\r\nExample: `sha-256=w/dKgvrrVRYW940bJibUmhAGb9MTS/74vs8vHabD+V0=`" schema: type: string - name: Content-Range in: header description: "Optional `Content-Range` header for uploading part of a file. \r\nExample, put the first MB: `bytes 0-999999/*`" schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/octet-stream: schema: type: string description: File to upload. format: binary image/tiff: schema: type: string description: File to upload. format: binary image/jpeg: schema: type: string description: File to upload. format: binary image/png: schema: type: string description: File to upload. format: binary application/pdf: schema: type: string description: File to upload. format: binary responses: '200': description: Success '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The batch transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/batch-transactions/{batchTransactionId}/state': post: tags: - BatchTransactions summary: Transitions a batch transaction to either the `Commit` or `Rollback` state. description: "### Commit or Rollback Batch Transaction\r\n\r\nIf successfully committed, a new batch GUID is returned for a new batch that has\r\njust been added to Synergy, and is available for subsequent processing in Synergy Capture.\r\n\r\nIf the transaction is rolled back, the batch transaction, along with any files that have\r\nbeen uploaded for it, are deleted.\r\n\r\nIn either case, the batch transaction is removed and the batch transaction Id\r\nbecomes invalid. " operationId: BatchTransactionsStateTransition parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: batchTransactionId in: path description: The batch transaction Id returned from the Begin Batch Transaction operation. required: true schema: type: string format: uuid - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ArchiveTransactonStateTransition' required: true responses: '200': description: ' Only returned when rolling back the transaction.' '201': description: 'Created: This indicates that a new batch has been submitted using the transaction data.' content: application/json: schema: $ref: '#/components/schemas/CommitBatchTransactionResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: 'Not Found: The batch transaction Id is invalid or the transaction was previously committed, rolled back, or expired.' headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/documents/{uniqueItemId}': get: tags: - Documents summary: Retrieves the metadata and index mappings for a given Synergy document. operationId: DocumentsGetInfo parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentInfo' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 patch: tags: - Documents summary: Modifies one or more properties of an existing Synergy document. operationId: DocumentsRefile parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RefileDocumentInfo' text/json: schema: $ref: '#/components/schemas/RefileDocumentInfo' application/*+json: schema: $ref: '#/components/schemas/RefileDocumentInfo' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RefileDocumentResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 delete: tags: - Documents summary: Delete a document from Synergy. operationId: DocumentsDeleteDocument parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DeleteDocumentResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/documents/{uniqueItemId}/cross-index-documents': post: tags: - Documents summary: 'Creates a new reference to an existing Synergy document, with an independent set of metadata and index mappings.' operationId: DocumentsCrossIndex parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CrossIndexDocumentInfo' text/json: schema: $ref: '#/components/schemas/CrossIndexDocumentInfo' application/*+json: schema: $ref: '#/components/schemas/CrossIndexDocumentInfo' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CrossIndexDocumentResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/documents/{uniqueItemId}/attachments': get: tags: - Documents summary: Retrieves attachment info objects for the given Synergy document. operationId: DocumentsGetAttachments parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: audience in: query description: "Optional query parameter. Limits the results to those attachments whose `audience` field begins with the supplied value.\r\n\r\n> Example: `.../attachments?audience=SEMANTIK`" schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDocumentAttachmentsResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/documents/{uniqueItemId}/attachments/{attachmentId}/data': get: tags: - Documents summary: "Retrieves the data (file content) for a given document attachment.\r\nThis endpoint does support partial content range requests (Accept-Ranges: bytes).\";" operationId: DocumentsGetAttachmentData parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: attachmentId in: path description: An attachment Id for the given document. required: true schema: type: string format: uuid - name: Range in: header description: Optional Range header. schema: type: string example: bytes=0-99 - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/octet-stream: schema: type: string format: byte multipart/byteranges: schema: type: string format: byte application/json: schema: type: string format: byte '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/documents/{uniqueItemId}/status': get: tags: - Documents summary: Get status information for given document. operationId: DocumentsGetDocumentStatus parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentStatusResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 post: tags: - Documents summary: Creates or replaces a status assignment for a given document. operationId: DocumentsSetDocumentStatus parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentStatusInput' responses: '201': description: 'Created: A document status assignment has been created or replaced.' content: application/json: schema: $ref: '#/components/schemas/ChangeDocumentStatusResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 delete: tags: - Documents summary: Clear the given document's status assignment. operationId: DocumentsClearDocumentStatus parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: uniqueItemId in: path description: A Synergy unique item Id assigned to an existing document. required: true schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ChangeDocumentStatusResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/document-status-definitions': get: tags: - DocumentStatusDefinitions summary: Gets a list of document status names as currently defined in Synergy. operationId: DocumentStatusDefinitionsGetDocumentStatuses parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: count in: query description: The desired number of items to retrieve. The default of zero indicates no cap. schema: type: integer format: int32 default: 0 - name: offset in: query description: The zero based integer offset of the first item to retrieve. Defaults to the first available item. schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DocumentStatusesResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/synergy-institutions': get: tags: - StorageCti summary: Gets a list of all Synergy defined institutions that are available for the current storage scope. operationId: StorageCtiGetSynergyInstitutions parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetSynergyInstitutionsResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/cabinets': get: tags: - StorageCti summary: "Gets a list of all cabinets for the given institution and current storage scope.\r\nIf the institution is not specified, the returned list is for all available institutions." operationId: StorageCtiGetCabinets parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: institutionName in: query description: A Synergy institution name. schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetCabinetsResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/cabinets/{cabinetName}/types': get: tags: - StorageCti summary: "Get a list of document types that have been assigned to the given cabinet and storage scope.\r\nIf the institution is not specified, the returned list is for all available institutions." operationId: StorageCtiGetMappedTypes parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: cabinetName in: path description: A Synergy cabinet name. required: true schema: type: string example: LOANS - name: institutionName in: query description: A Synergy institution name. schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetDocumentTypesResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '/v2/{InstitutionUniversalId}/{ProductId}/storage/v3/cabinets/{cabinetName}/types/{typeName}/indexes': get: tags: - StorageCti summary: "Get a list of document indexes that have been assigned to the given cabinet and storage scope.\r\nIf the institution is not specified, the returned list is for all available institutions." operationId: StorageCtiGetMappedIndexes parameters: - name: InstitutionUniversalId in: path description: "The Institution Universal Identification given to an entity / institution.\r\nThe URL utilizes this Id for routing." required: true schema: type: string example: 5a0eef05-8661-43f1-8dae-10847a25fabf example: 5a0eef05-8661-43f1-8dae-10847a25fabf - name: ProductId in: path description: "Product Identifier. This code identifies the Product for which the message is intended.\r\nGenerally, the Product Id will be in the form of Vendor-Product.\r\nHowever, various other Product Ids may exist." required: true schema: type: string example: jha-synergy example: jha-synergy - name: cabinetName in: path description: A Synergy cabinet name. required: true schema: type: string example: LOANS - name: typeName in: path description: A Synergy document type name. required: true schema: type: string example: AUTO APPLICATION - name: institutionName in: query description: A Synergy institution name. schema: type: string - name: X-Request-ID in: header description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 - name: X-Correlation-ID in: header description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 - name: X-AuditUserId in: header description: "This is the User Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the user id. It will not be use to authenticate, only audit information'" schema: type: string - name: X-AuditDeviceId in: header description: "This is the device Id which the consumer would like written to the audit as performing the requested service.\r\nIt will vary but could be down to the machine id or address." schema: type: string - name: X-BusinessCorrelationId in: header description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-WorkflowCorrelationId in: header description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string - name: X-AuthenticationUserCredential in: header description: "Authentication of the end-user (person at keyboard) Credentials in the form of a JSON Web Token (JWT).\r\n<br>Format is ` <type> <token>`. Type default is jwt.\r\n(Note: *Synergy currently only supports base64 encoded saml*)\r\n<br>Example `X-AuthenticationUserCredential: jwt <GeneratedOidcJwt>`\r\n<br>Example `X-AuthenticationUserCredential: saml <Generatedsaml>` " schema: type: string responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GetStorageIndexesResult' '400': description: "Bad Request<hr>\r\nThe server could not complete the request due to invalid syntax, parameters, or context.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 X-Correlation-ID: description: Correlation ID for communication-based multi-hop message correlation. schema: type: string example: 123e4567-e89b-12d3-a456-426655440002 X-BusinessCorrelationId: description: "The correlation identification as related to business functions and activities. \r\nGenerally expected to be a GUID." schema: type: string X-WorkflowCorrelationId: description: "The correlation identification as related to workflow functions and activities. \r\nGenerally expected to be a GUID." schema: type: string '401': description: "Unauthorized<hr>\r\nAlthough the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\".\r\nThat is, the client must authenticate itself to get the requested response." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '403': description: "Forbidden<hr>\r\nThe client does not have access rights to the content; that is, it is unauthorized, so the server\r\nis refusing to give the requested resource. Unlike 401, the clients identity is known to the server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '404': description: "Not Found<hr>\r\nThe server can not find the requested resource. In an API, this can also mean that the endpoint\r\nis valid but the resource itself does not exist. Servers may also send this response instead of\r\n403 to hide the existence of a resource from an unauthorized client.'" headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '413': description: "Request Too Large<hr>\r\nRequest entity is larger than limits defined by server." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '422': description: "Unprocessed<hr>\r\nThe request was well-formed but was unable to be followed due to semantic errors." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 '500': description: "Generic Internal Error<hr>\r\nThe server has encountered a situation it doesn't know how to handle." headers: X-Request-ID: description: "To support communications level correlation due to some responses only having header data, \r\na round-trip identifier (GUID) will be sent on every call from the consumer and returned \r\nby the service provider (or intermediary) regardless of the final disposition of the request/message." schema: type: string format: uuid example: 123e4567-e89b-12d3-a456-426655440001 components: securitySchemes: BearerAuth: type: http description: OpenIDConnect JWT Token scheme: bearer bearerFormat: JWT schemas: ApiVersionsResponseBody: type: object properties: VersionTags: type: array items: type: string description: The version tags supported by this instance. nullable: true Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Response body for the API versions endpoint. ArchiveDocumentInfo: type: object properties: CabinetName: maxLength: 80 minLength: 0 type: string description: "A cabinet name under which the document should be classified.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Application name.\r\n\r\nExample: \"LOANS\"" nullable: true example: LOANS TypeName: maxLength: 80 minLength: 0 type: string description: "A document type name under which the document should be classified.\r\nThis name must be defined in Synergy, must be mapped to the specified cabinet name,\r\nand be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Report name." nullable: true example: AUTO APPLICATION SynergyInstitutionName: maxLength: 20 minLength: 0 type: string description: "The institution name that the document should be assigned to.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nIf this property is not provided, Synergy will attempt to determine it, if possible." nullable: true DocumentName: maxLength: 80 minLength: 0 type: string description: "The optional document name.\r\nThis will default to the type name unless it has been mapped to a different default in Synergy." nullable: true example: Test Document ViewAuthorities: maxItems: 9 type: array items: type: integer format: int32 description: "A list of numerical view authorities for the document.\r\nThis must be a list of integers between 1 to 9, inclusively and can be one or many.\r\nIn order to view a document, a user must be assigned one or more of these view authorities.\r\nThis will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy." nullable: true example: - 1 - 3 - 5 - 7 - 9 Indexes: maxItems: 100 type: array items: $ref: '#/components/schemas/IndexMapping' description: "The index names and values to be associated with the document. Note that all of the indexes\r\nspecified must be assigned to the document's type in Synergy." nullable: true FolderName: maxLength: 80 type: string description: The optional Folder name. nullable: true OpenVocabularyName: maxLength: 80 minLength: 0 type: string description: "The optional name of a Synergy Open Vocabulary mapping.\r\nIf provided, the mapping will be used to map user defined \r\ncab, type, and index names to Synergy defined names." nullable: true example: Custom Vocab UseForSmartIndexing: maxItems: 100 type: array items: type: string description: "If the index names in this array are configured in Synergy as Smart Index lookup keys,\r\nSynergy will attempt to populate other indexes based on these values.\r\n<br>e.g. An account number index value may be used to look up the value of a customer name index.<br>The name(s) in this array, if any, must also be present in the indexes array." nullable: true example: - ACCOUNT NUMBER Files: maxItems: 100 type: array items: $ref: '#/components/schemas/ArchiveFileInfo' description: "Information about the set of files to be uploaded as part of the transaction.\r\nIf this property is provided, an array of file IDs will be returned in the\r\nresponse. These file IDs can be used in subsequent upload operations for this transaction.\r\nOnly use this property if the sizes of the files are known ahead of time." nullable: true additionalProperties: false description: The document classification and associated index values. ArchiveFileInfo: required: - FileName - FileSize - FileType type: object properties: FileName: maxLength: 256 minLength: 1 type: string description: "An identifying name for the given file. This value\r\nmust be unique withing the containing array." FileType: maxLength: 16 minLength: 1 type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' FileSize: minimum: 1 type: integer description: 'The size, in bytes, of the given file.' format: int64 IsAttachment: type: boolean description: "If true, this indicates the file should be treated as an attachment, and not part of the page data.\r\nThere are limited use-cases for this feature, and it should be used only when required." nullable: true AttachmentAudience: maxLength: 32 minLength: 0 type: string description: "This specifies the use-case for the given attachment.\r\nThis must be provided for an attachment and must match a predefined value." nullable: true additionalProperties: false description: Basic information about a file to be uploaded. These properties are exclusive to Archive Transactions. ArchiveFileResponse: required: - FileId - FileName type: object properties: FileId: type: string description: The file's id that the caller must be provide when uploading file data. format: uuid FileName: maxLength: 265 minLength: 1 type: string description: 'The name of the file, as it was provided when beginning the transaction.' additionalProperties: false description: "File Ids (associated by FileName) for each file to be uploaded as \r\npart of the transaction." ArchiveTransactionBeginResult: required: - DocumentTransactionId type: object properties: DocumentTransactionId: type: string description: "The ID for the newly created transaction.\r\nNote that this is not the Synergy document ID that will be produced on a successful commit." format: uuid example: d73da8b1-9dfc-ec11-a292-3cf011584417 FileResponse: maxItems: 100 type: array items: $ref: '#/components/schemas/ArchiveFileResponse' description: "An array of file Ids that have been assigned to file names provided when\r\ncreating the transaction." nullable: true additionalProperties: false description: Result object returned after successfully beginning an archive transaction. ArchiveTransactionCommitResult: required: - UniqueItemId type: object properties: UniqueItemId: maxLength: 256 minLength: 0 type: string description: "The unique item id for the document that was just created, modified, or queried.\r\nThis is a resource id that can be used in other API calls." example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 additionalProperties: false description: Base result object for document archiving (single document filing). ArchiveTransactionState: enum: - Commit - Rollback type: string description: Transaction states used by ArchiveTransactions. ArchiveTransactonStateTransition: type: object properties: State: $ref: '#/components/schemas/ArchiveTransactionState' additionalProperties: false description: ArchiveTransactionState wrapper. BatchDocumentInfo: type: object properties: CabinetName: maxLength: 80 minLength: 0 type: string description: "A cabinet name under which the document should be classified.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Application name.\r\n\r\nExample: \"LOANS\"" nullable: true example: LOANS TypeName: maxLength: 80 minLength: 0 type: string description: "A document type name under which the document should be classified.\r\nThis name must be defined in Synergy, must be mapped to the specified cabinet name,\r\nand be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Report name." nullable: true example: AUTO APPLICATION SynergyInstitutionName: maxLength: 20 minLength: 0 type: string description: "The institution name that the document should be assigned to.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nIf this property is not provided, Synergy will attempt to determine it, if possible." nullable: true DocumentName: maxLength: 80 minLength: 0 type: string description: "The optional document name.\r\nThis will default to the type name unless it has been mapped to a different default in Synergy." nullable: true example: Test Document ViewAuthorities: maxItems: 9 type: array items: type: integer format: int32 description: "A list of numerical view authorities for the document.\r\nThis must be a list of integers between 1 to 9, inclusively and can be one or many.\r\nIn order to view a document, a user must be assigned one or more of these view authorities.\r\nThis will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy." nullable: true example: - 1 - 3 - 5 - 7 - 9 Indexes: maxItems: 100 type: array items: $ref: '#/components/schemas/IndexMapping' description: "The index names and values to be associated with the document. Note that all of the indexes\r\nspecified must be assigned to the document's type in Synergy." nullable: true FolderName: maxLength: 80 type: string description: The optional Folder name. nullable: true OpenVocabularyName: maxLength: 80 minLength: 0 type: string description: "The optional name of a Synergy Open Vocabulary mapping.\r\nIf provided, the mapping will be used to map user defined \r\ncab, type, and index names to Synergy defined names." nullable: true example: Custom Vocab UseForSmartIndexing: maxItems: 100 type: array items: type: string description: "If the index names in this array are configured in Synergy as Smart Index lookup keys,\r\nSynergy will attempt to populate other indexes based on these values.\r\n<br>e.g. An account number index value may be used to look up the value of a customer name index.<br>The name(s) in this array, if any, must also be present in the indexes array." nullable: true example: - ACCOUNT NUMBER Files: type: array items: $ref: '#/components/schemas/DocumentFileInfo' description: "Information about the set of files to be uploaded as part of the transaction.\r\nIf this property is provided, an array of file IDs will be returned in the\r\nresponse. These file IDs can be used in subsequent upload operations for this transaction.\r\nOnly use this property if the sizes of the files are known ahead of time." nullable: true additionalProperties: false description: The document classification and associated index values. BeginBatchTransactionInfo: type: object properties: BatchName: maxLength: 80 type: string description: "The optional name that the batch will have, once submitted. This property is descriptive only, and will\r\nnot impact batch processing." nullable: true BatchTemplateName: maxLength: 80 type: string description: "The name of the batch template to use when creating a batch.\r\nIf not specified, the default batch template will be used.\r\nBatch templates are defined in Synergy Capture." nullable: true BatchRoutingStep: $ref: '#/components/schemas/ProcessingDisposition' additionalProperties: false description: Information used when creating a Synergy document batch. BeginBatchTransactionResult: required: - BatchTransactionId type: object properties: BatchTransactionId: type: string description: The ID for the newly created batch transaction. format: uuid example: d73da8b1-9dfc-ec11-a292-3cf011584417 additionalProperties: false description: Result object returned after successfully beginning a batch transaction. ChangeDocumentStatusResult: required: - UniqueItemId type: object properties: UniqueItemId: maxLength: 256 minLength: 0 type: string description: The document for which the status has been changed. example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 PreviousDocumentStatusName: maxLength: 80 minLength: 0 type: string description: 'The previous document status, if any. Otherwise this will be an empty string.' nullable: true CurrentDocumentStatusName: maxLength: 80 minLength: 0 type: string description: 'The current document status, if any (this will be empty after clearing a document status).' nullable: true additionalProperties: false description: Result of a successful document status change request. CommitBatchTransactionResult: required: - BatchId type: object properties: BatchId: type: string description: The Synergy batch ID assigned to the newly created batch. format: uuid additionalProperties: false description: Result object returned after successfully creating a batch. CrossIndexDocumentInfo: type: object properties: CabinetName: maxLength: 80 minLength: 0 type: string description: "A cabinet name under which the document should be classified.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Application name.\r\n\r\nExample: \"LOANS\"" nullable: true example: LOANS TypeName: maxLength: 80 minLength: 0 type: string description: "A document type name under which the document should be classified.\r\nThis name must be defined in Synergy, must be mapped to the specified cabinet name,\r\nand be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Report name." nullable: true example: AUTO APPLICATION SynergyInstitutionName: maxLength: 20 minLength: 0 type: string description: "The institution name that the document should be assigned to.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nIf this property is not provided, Synergy will attempt to determine it, if possible." nullable: true DocumentName: maxLength: 80 minLength: 0 type: string description: "The optional document name.\r\nThis will default to the type name unless it has been mapped to a different default in Synergy." nullable: true example: Test Document ViewAuthorities: maxItems: 9 type: array items: type: integer format: int32 description: "A list of numerical view authorities for the document.\r\nThis must be a list of integers between 1 to 9, inclusively and can be one or many.\r\nIn order to view a document, a user must be assigned one or more of these view authorities.\r\nThis will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy." nullable: true example: - 1 - 3 - 5 - 7 - 9 Indexes: maxItems: 100 type: array items: $ref: '#/components/schemas/IndexMapping' description: "The index names and values to be associated with the document. Note that all of the indexes\r\nspecified must be assigned to the document's type in Synergy." nullable: true FolderName: maxLength: 80 type: string description: The optional Folder name. nullable: true OpenVocabularyName: maxLength: 80 minLength: 0 type: string description: "The optional name of a Synergy Open Vocabulary mapping.\r\nIf provided, the mapping will be used to map user defined \r\ncab, type, and index names to Synergy defined names." nullable: true example: Custom Vocab additionalProperties: false description: The document classification and associated index values. CrossIndexDocumentResult: required: - UniqueItemId type: object properties: UniqueItemId: maxLength: 256 minLength: 0 type: string description: "The unique item id for the document that was just created, modified, or queried.\r\nThis is a resource id that can be used in other API calls." example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 additionalProperties: false description: Base result object for a cross-index operation. CurrentVersion: type: object properties: VersionNumber: type: integer description: The incrementing version number. format: int32 VersionComment: type: string description: Descriptive text relating to the given version. nullable: true VersionManagementState: type: string description: The current version management state of the document. nullable: true VersionDate: type: string description: The version time stamp. format: date-time UserName: maxLength: 255 minLength: 0 type: string description: The Synergy user who saved the given version. nullable: true additionalProperties: false description: Most recent version information for a given document. DeleteDocumentResult: required: - UniqueItemId type: object properties: UniqueItemId: maxLength: 256 minLength: 0 type: string description: "The unique item id for the document that was just created, modified, or queried.\r\nThis is a resource id that can be used in other API calls." example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 additionalProperties: false description: Base result object for a delete document operation. DocumentAttachmentInfo: required: - AttachmentId - Audience - DataSize - DataType type: object properties: AttachmentId: type: string description: The UUID of the Synergy document attachment. format: uuid Audience: minLength: 1 type: string description: The business use-case for the attachment. DataType: minLength: 1 type: string description: 'The data/file type for the attachment, e.g. `JSON`, `XML`, `TIF`, etc...' DataSize: type: integer description: The length of the data/file in bytes. format: int32 Description: type: string description: "Info about the `audience` type.\r\n*This will only be populated when the audience is known to Synergy.*" nullable: true additionalProperties: false description: Information about a Synergy document attachment. DocumentFileInfo: required: - FileName - FileSize - FileType type: object properties: FileName: maxLength: 256 minLength: 1 type: string description: "An identifying name for the given file. This value\r\nmust be unique withing the containing array." FileType: maxLength: 16 minLength: 1 type: string description: 'The file''s type; generally the file extension, without the leading ''.'' symbol.' FileSize: minimum: 1 type: integer description: 'The size, in bytes, of the given file.' format: int64 additionalProperties: false description: Basic information about a file to be uploaded. DocumentInfo: type: object properties: CabinetName: maxLength: 80 minLength: 0 type: string description: "A cabinet name under which the document should be classified.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Application name.\r\n\r\nExample: \"LOANS\"" nullable: true example: LOANS TypeName: maxLength: 80 minLength: 0 type: string description: "A document type name under which the document should be classified.\r\nThis name must be defined in Synergy, must be mapped to the specified cabinet name,\r\nand be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Report name." nullable: true example: AUTO APPLICATION SynergyInstitutionName: maxLength: 20 minLength: 0 type: string description: "The institution name that the document should be assigned to.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nIf this property is not provided, Synergy will attempt to determine it, if possible." nullable: true DocumentName: maxLength: 80 minLength: 0 type: string description: "The optional document name.\r\nThis will default to the type name unless it has been mapped to a different default in Synergy." nullable: true example: Test Document ViewAuthorities: maxItems: 9 type: array items: type: integer format: int32 description: "A list of numerical view authorities for the document.\r\nThis must be a list of integers between 1 to 9, inclusively and can be one or many.\r\nIn order to view a document, a user must be assigned one or more of these view authorities.\r\nThis will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy." nullable: true example: - 1 - 3 - 5 - 7 - 9 Indexes: maxItems: 100 type: array items: $ref: '#/components/schemas/IndexMapping' description: "The index names and values to be associated with the document. Note that all of the indexes\r\nspecified must be assigned to the document's type in Synergy." nullable: true FolderName: maxLength: 80 type: string description: The optional Folder name. nullable: true additionalProperties: false description: Basic document properties for filing. DocumentReference: required: - UniqueItemId type: object properties: UniqueItemId: maxLength: 256 minLength: 0 type: string description: "The unique item id for the document that was just created, modified, or queried.\r\nThis is a resource id that can be used in other API calls." example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 additionalProperties: false description: Base for result objects that return a document unique item id. DocumentStatusInput: required: - DocumentStatusName type: object properties: DocumentStatusName: maxLength: 80 minLength: 0 type: string description: The status to assign to the document. additionalProperties: false description: Information for setting a document's status. DocumentStatusResult: type: object properties: DocumentStatusName: maxLength: 80 minLength: 0 type: string description: "The current status assigned to a given document.\r\nThis property will only be available if the document has been assigned an explicit status." nullable: true Version: $ref: '#/components/schemas/CurrentVersion' additionalProperties: false description: Optional status information for a document. DocumentStatusesResult: type: object properties: DocumentStatusNames: type: array items: type: string description: Document Status names as currently defined in Synergy. nullable: true Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Result for GetDocumentStatues() GetCabinetsResult: type: object properties: CabinetNames: type: array items: type: string description: 'An array of cabinet names, as defined in Synergy.' nullable: true example: - INVOICES - LOANS Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Result object for a cabinets query. GetDocumentAttachmentsResult: required: - Attachments type: object properties: Document: $ref: '#/components/schemas/DocumentReference' Attachments: type: array items: $ref: '#/components/schemas/DocumentAttachmentInfo' description: An array of attachment info for a given document. additionalProperties: false description: Document attachment info for a given document attachment query. GetDocumentTypesResult: type: object properties: TypeNames: type: array items: type: string description: 'An array of document type names, as defined in Synergy.' nullable: true example: - AUTO APPLICATION - SHIPPING INVOICE Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Result object for a document types query. GetStorageIndexesResult: type: object properties: Indexes: type: array items: $ref: '#/components/schemas/StorageIndexInfo' description: 'An array of index metadata, as defined in Synergy.' nullable: true Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Result object for an indexes query. GetSynergyInstitutionsResult: type: object properties: SynergyInstitutionNames: type: array items: type: string description: 'An array of institution names, as defined in Synergy.' nullable: true example: - '01' - '02' Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Result object for a Synergy instition query. IndexMapping: required: - IndexName type: object properties: IndexName: maxLength: 80 minLength: 1 type: string description: 'The name of the index, as defined in Synergy.' example: ACCOUNT NUMBER IndexValue: maxLength: 1024 minLength: 0 type: string description: "An index value assignment for the document.\r\nIf the index is defined as multi-value in Synergy, there may be multiple\r\nindex mapping objects with the same index name, but each with different values." nullable: true example: '11223344' additionalProperties: false description: An index name along with its associated value. Paging: type: object properties: NextOffset: type: string description: The next offset is the start position of the read pointer for pagination. nullable: true Results: type: integer description: The number of records sent for pagination. format: int32 Total: type: integer description: The total number of records requested for pagination. format: int32 nullable: true additionalProperties: false description: Paging information. ProcessingDisposition: enum: - Acquire - Clean - Index - Ocr - Review - File type: string description: Impacts the action that will be taken once the archive transaction has been committed. RefileDocumentInfo: type: object properties: CabinetName: maxLength: 80 minLength: 0 type: string description: "A cabinet name under which the document should be classified.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Application name.\r\n\r\nExample: \"LOANS\"" nullable: true example: LOANS TypeName: maxLength: 80 minLength: 0 type: string description: "A document type name under which the document should be classified.\r\nThis name must be defined in Synergy, must be mapped to the specified cabinet name,\r\nand be accessible by your account for storage purposes.\r\nNote that this property is also used by the `Report` module for the Report name." nullable: true example: AUTO APPLICATION SynergyInstitutionName: maxLength: 20 minLength: 0 type: string description: "The institution name that the document should be assigned to.\r\nThis name must be defined in Synergy and be accessible by your account for storage purposes.\r\nIf this property is not provided, Synergy will attempt to determine it, if possible." nullable: true DocumentName: maxLength: 80 minLength: 0 type: string description: "The optional document name.\r\nThis will default to the type name unless it has been mapped to a different default in Synergy." nullable: true example: Test Document ViewAuthorities: maxItems: 9 type: array items: type: integer format: int32 description: "A list of numerical view authorities for the document.\r\nThis must be a list of integers between 1 to 9, inclusively and can be one or many.\r\nIn order to view a document, a user must be assigned one or more of these view authorities.\r\nThis will default to all (1-9) view authorities unless it has been mapped to a different default in Synergy." nullable: true example: - 1 - 3 - 5 - 7 - 9 Indexes: maxItems: 100 type: array items: $ref: '#/components/schemas/IndexMapping' description: "The index names and values to be associated with the document. Note that all of the indexes\r\nspecified must be assigned to the document's type in Synergy." nullable: true FolderName: maxLength: 80 type: string description: The optional Folder name. nullable: true OpenVocabularyName: maxLength: 80 minLength: 0 type: string description: "The optional name of a Synergy Open Vocabulary mapping.\r\nIf provided, the mapping will be used to map user defined \r\ncab, type, and index names to Synergy defined names." nullable: true example: Custom Vocab additionalProperties: false description: "The properties to change on the existing document.\r\nAt least one property or index must be populated." RefileDocumentResult: required: - UniqueItemId type: object properties: UniqueItemId: maxLength: 256 minLength: 0 type: string description: "The unique item id for the document that was just created, modified, or queried.\r\nThis is a resource id that can be used in other API calls." example: 1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417 additionalProperties: false description: Base result object for a refile operation. StorageIndexInfo: required: - IndexName - IndexType type: object properties: IndexName: maxLength: 80 minLength: 1 type: string description: "The name of the index, as defined in Synergy.\r\nThis will be used in the index assignment." example: ACCOUNT NUMBER IndexType: maxLength: 20 minLength: 1 type: string description: "The Synergy data type for the given index.\r\nNote that all index assignments should be provided as\r\nstring values, regardless of the underlying type." example: Numeric IsMultiValue: type: boolean description: "If true, this index supports multiple assigned values.\r\nOtherwise, only a single value can be specified for each\r\nindex assignment." example: false Length: type: integer description: The maximum value length for the index. format: int32 example: 10 IsRequired: type: boolean description: "This is a required index.\r\nAn error will result if no value is assigned." IsSmartIndexLookup: type: boolean description: "This index can be used as a Smart Index lookup key.\r\nIf 'UseForSmartIndexLookup' is specified in the index assignment,\r\nSynergy will attempt to automatically populate other index values\r\nwhere 'HasSmartIndexMapping' is true." HasSmartIndexMapping: type: boolean description: "This index is mapped in the smart index lookup table.\r\nSee 'IsSmartIndexLookup' for more details." additionalProperties: false description: "Information about an index defined in Synergy including \r\nsmart indexing info relevant to a given set of classifiers\r\n(institution, cabinet, type)." tags: - name: ArchiveTransactions description: APIs for archiving a single document directly into Synergy. - name: BatchTransactions description: APIs for preparing and submitting a batch of documents for subsequent processing by Synergy Capture and/or ADR. - name: Documents description: 'Document Refile, Cross-Indexing, and Status Assignment APIs.' - name: DocumentStatusDefinitions description: APIs for retrieving information about document status definitions defined in Synergy. - name: StorageCti description: Provides access to Synergy metadata and indexes needed for archiving documents into Synergy.

Please ignore this field