V3.0

openapi: 3.0.1 x-jh: publishing: type: Integration stage: prod isPublic: true group: Synergy name: Document Retrieval docURL: https://jkhy.github.io/synergyintegration info: title: SynergyECM Retrieval description: APIs for Query and Retrieval contact: email: SynergyOpenAPI@jackhenry.com version: v3 security: - BearerAuth: [] servers: - url: 'http:/jx-r.jhacorp.com/api' description: Corporate Test Server paths: '/v2/{InstitutionUniversalId}/{ProductId}/retrieval/api-versions': get: tags: - ApiVersions summary: The API Version supported by this instance. operationId: RetrievalApiVersionsGet 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}/retrieval/v3/items/{uniqueItemId}': get: tags: - Items summary: 'Retrieves metadata, index mappings, and file information for a given Synergy document or report.' operationId: ItemsGetInfo 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/ItemInfo' '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 unique item id is invalid.' 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}/retrieval/v3/items/{uniqueItemId}/pages': get: tags: - Items summary: Retrieves an entire document or report as a single file (typically PDF). description: "## Export Format\r\nThere are only two valid export formats for this API.\r\nIf the optional `exportFormat` parameter is used, note the following transform restrictions \r\nwhen exporting the given Synergy item types (default export format is PDF):\r\n| Export Format | Document (image or text) | Plain Text Report | Other Report Formats |\r\n| ------------- | ------------------------ | ----------------- | -------------------- |\r\n| `PDF` | YES | YES | YES |\r\n| `TEXT` | x | YES | x |\r\n\r\n## Retrieving Data\r\nThe maximum amount of file data returned in the response body is a configured limit.\r\nIf a file's size exceeds that limit, a `206 Partial Content` status code is returned\r\nalong with a `Content-Range` header, an `ETag` header, and the partial file data in\r\nthe response body. The remainder of the file has to be downloaded in subsequent ranges.\r\n\r\nSynergy requires that the `Range` header for a file download, always be accompanied\r\nby an `If-Range` header containing the `ETag` value from a previous request for this\r\nresource. This is to ensure that any intermediate data generated for the resource,\r\nis reused on subsequent requests for the same resource.\r\n \r\n### Pseudo code example of an initial file request:\r\n response = request.get('items/{itemId}/pages')\r\n if (response.status == 200 or response.status == 206) {\r\n // 200 OK indicates complete file is in the response body.\r\n output.write(response.body)\r\n }\r\n \r\n### Pseudocode example for retrieving the remainder of a file:\r\n if (response.status == 206) {\r\n while (response.headers[Content-Range].To < response.headers[Content-Range].Size - 1) {\r\n request.headers[Range].From = response.headers[Content-Range].To + 1\r\n request.headers[If-Range] = response.headers[ETag] // REQUIRED\r\n response = request.get(\"items/{itemId}/pages\")\r\n }\r\n }\r\n\r\nIf it is necessary to retrieve the first chunk of the file with a `Range` header,\r\nthe http `HEAD` method has to be used in an initial call to retrieve the `ETag`\r\nheader, which is needed for subsequent range requests." operationId: ItemsGetAllPages 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: exportFormat in: query description: The desired format of the returned file. schema: $ref: '#/components/schemas/ExportFormat' - name: renderOptions in: query description: "The desired format of the returned file.\r\nNote that for multi-page requests, only `PDF` and `TIFF` are valid.\r\nFor single page requests,'PNG and 'JPEG' are also allowed." schema: type: array items: $ref: '#/components/schemas/RenderOptions' - name: Range in: header description: "Optional Range header for retrieving the file in parts. For this API, the Range header *must always\r\nbe accompanied by an If-Range header* that contains an ETag acquired in a previous call to this API.\r\nThat call may have resulted in a `206 Partial Response`, or may have been an initial HTTP HEAD request\r\nfor this resource.\r\n\r\nExample, retrieve first KiB: `bytes=0-1023`" schema: type: string - name: If-Range in: header description: "When an ETag header is returned in a previous call to this API which resulted in a `206 Partial Response`,\r\nor from a prior HTTP HEAD request for this given resource, that ETag must be sent in the\r\nIf-Range header when retrieving subsequent ranges of the given resource.\r\nNote that the ETag returned from this API is short-lived." schema: type: string example: '' - 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 '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 unique item id is invalid.' 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 '206': description: 'Partial Response: Part of the requested file has been returned, and the Content-Range header describes which part.' '412': description: 'Precondition Failed: The ETag sent in the If-Range header was invalid or expired.' '428': description: 'Precondition Required: A Range header was sent, but the If-Range header was missing or invalid.' head: tags: - Items summary: Retrieves headers for a given resource. Call this first when planning to use Range/If-Range requests. description: "### Returns the following critical headers:\r\n- Content-Length: <*resource length*>\r\n- Accept-Ranges: `byte`\r\n- Etag: \"<*entity tag used in subsequent range requests*>\"" operationId: ItemsGetAllPagesHeaders 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: exportFormat in: query description: The desired format of the returned file. schema: $ref: '#/components/schemas/ExportFormat' - name: renderOptions in: query description: "The desired format of the returned file.\r\nNote that for multi-page requests, only `PDF` and `TIFF` are valid.\r\nFor single page requests,'PNG and 'JPEG' are also allowed." schema: type: array items: $ref: '#/components/schemas/RenderOptions' - 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 '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 unique item id is invalid.' 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}/retrieval/v3/items/{uniqueItemId}/files/{fileNumber}': get: tags: - Items summary: Retrieves a native document file from a given Synergy document. Not supported for the `Report` module. description: "The maximum amount of file data returned in the response body is a configured limit.\r\nIf a file's size exceeds that limit, a `206 Partial Content` status code is returned\r\nalong with a `Content-Range` header, an `ETag` header, and the partial file data in\r\nthe response body. The remainder of the file has to be downloaded in subsequent ranges.\r\n\r\n### Pseudo code example of an initial file request:\r\n response = request.get('items/{itemId}/pages')\r\n if (response.status == 200 or response.status == 206) {\r\n // 200 OK indicates complete file is in the response body.\r\n output.write(response.body)\r\n }\r\n\r\n### Pseudocode example for retrieving the remainder of a file:\r\n if (response.status == 206) {\r\n while (response.headers[Content-Range].To < response.headers[Content-Range].Size - 1) {\r\n request.headers[Range].From = response.headers[Content-Range].To + 1\r\n request.headers[If-Range] = response.headers[ETag] // REQUIRED\r\n response = request.get(\"items/{itemId}/files/{fileNumber}\")\r\n }\r\n }\r\n\r\nSynergy requires that the `Range` header for a file download, always be accompanied\r\nby an `If-Range` header containing the `ETag` value from a previous request for this\r\nresource. This is to ensure that any intermediate data generated for the resource,\r\nis reused on subsequent requests for the same resource.\r\n\r\nIf it is necessary to retrieve the first chunk of the file with a `Range` header,\r\nthe http `HEAD` method has to be used in an initial call to retrieve the `ETag`\r\nheader, which is needed for subsequent range requests." operationId: ItemsGetFile 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: fileNumber in: path description: The file sequence number within a compound Synergy document. required: true schema: type: integer format: int32 example: '' - name: Range in: header description: "Optional Range header for retrieving the file in parts. For this API, the Range header *must always\r\nbe accompanied by an If-Range header* that contains an ETag acquired in a previous call to this API.\r\nThat call may have resulted in a `206 Partial Response`, or may have been an initial HTTP HEAD request\r\nfor this resource.\r\n\r\nExample, retrieve first KiB: `bytes=0-1023`" schema: type: string - name: If-Range in: header description: "When an ETag header is returned in a previous call to this API which resulted in a `206 Partial Response`,\r\nor from a prior HTTP HEAD request for this given resource, that ETag must be sent in the\r\nIf-Range header when retrieving subsequent ranges of the given resource.\r\nNote that the ETag returned from this API is short-lived." schema: type: string example: '' - 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 '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 unique item id is invalid.' 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 '206': description: 'Partial Response: Part of the requested file has been returned, and the Content-Range header describes which part.' '412': description: 'Precondition Failed: The ETag sent in the If-Range header was invalid or expired.' '428': description: 'Precondition Required: A Range header was sent, but the If-Range header was missing or invalid.' head: tags: - Items summary: Retrieves headers for a given resource. Call this first when planning to use Range/If-Range requests. description: "### Returns the following critical headers:\r\n- Content-Length: <*resource length*>\r\n- Accept-Ranges: `byte`\r\n- Etag: \"<*entity tag used in subsequent range requests*>\"" operationId: ItemsGetFileHeaders 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: fileNumber in: path description: The file sequence number within a compound Synergy document. required: true schema: type: integer format: int32 example: '' - 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 '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 unique item id is invalid.' 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}/retrieval/v3/items/{uniqueItemId}/pages/{pageNumber}': get: tags: - Items summary: Retrieves a page or page-range from a given Synergy document. description: "## Export Format\r\nIf the optional `exportFormat` parameter is used, note the following transform restrictions \r\nwhen exporting the given Synergy item types (default export format is PDF):\r\n| Export Format | Document (image or text) | Plain Text Report | Other Report Formats | Page Range Support |\r\n| ------------- | ------------------------ | ----------------- | -------------------- | ------------------ |\r\n| `PDF` | YES | YES | YES | YES |\r\n| `TIFF` | YES | x | x | YES |\r\n| `JPEG` | YES | x | x | x |\r\n| `PNG` | YES | x | x | x |\r\n| `TEXT` | x | YES | x | YES |\r\n\r\n## Retrieving Data\r\nThe maximum amount of file data returned in the response body is a configured limit.\r\nIf a file's size exceeds that limit, a `206 Partial Content` status code is returned\r\nalong with a `Content-Range` header, an `ETag` header, and the partial file data in\r\nthe response body. The remainder of the file has to be downloaded in subsequent ranges.\r\n\r\n### Pseudo code example of an initial file request:\r\n response = request.get('items/{itemId}/pages')\r\n if (response.status == 200 or response.status == 206) {\r\n // 200 OK indicates complete file is in the response body.\r\n output.write(response.body)\r\n }\r\n \r\n### Pseudocode example for retrieving the remainder of a file:\r\n if (response.status == 206) {\r\n while (response.headers[Content-Range].To < response.headers[Content-Range].Size - 1) {\r\n request.headers[Range].From = response.headers[Content-Range].To + 1\r\n request.headers[If-Range] = response.headers[ETag] // REQUIRED\r\n response = request.get(\"items/{itemId}/pages/{pageNumber}\")\r\n }\r\n }\r\n\r\nSynergy requires that the `Range` header for a file download, always be accompanied\r\nby an `If-Range` header containing the `ETag` value from a previous request for this\r\nresource. This is to ensure that any intermediate data generated for the resource,\r\nis reused on subsequent requests for the same resource.\r\n\r\nIf it is necessary to retrieve the first chunk of the file with a `Range` header,\r\nthe http `HEAD` method has to be used in an initial call to retrieve the `ETag`\r\nheader, which is needed for subsequent range requests." operationId: ItemsGetPages 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: pageNumber in: path description: The page to retrieve. required: true schema: type: integer format: int32 - name: pageCount in: query description: 'If specified, multiple pages can be returned in a single file.' schema: type: integer format: int32 default: 0 - name: exportFormat in: query description: The desired format of the returned file. schema: $ref: '#/components/schemas/ExportFormat' - name: renderOptions in: query description: "The desired format of the returned file.\r\nNote that for multi-page requests, only `PDF` and `TIFF` are valid.\r\nFor single page requests,'PNG and 'JPEG' are also allowed." schema: type: array items: $ref: '#/components/schemas/RenderOptions' - name: Range in: header description: "Optional Range header for retrieving the file in parts. For this API, the Range header *must always\r\nbe accompanied by an If-Range header* that contains an ETag acquired in a previous call to this API.\r\nThat call may have resulted in a `206 Partial Response`, or may have been an initial HTTP HEAD request\r\nfor this resource.\r\n\r\nExample, retrieve first KiB: `bytes=0-1023`" schema: type: string - name: If-Range in: header description: "When an ETag header is returned in a previous call to this API which resulted in a `206 Partial Response`,\r\nor from a prior HTTP HEAD request for this given resource, that ETag must be sent in the\r\nIf-Range header when retrieving subsequent ranges of the given resource.\r\nNote that the ETag returned from this API is short-lived." schema: type: string example: '' - 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 '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 unique item id is invalid.' 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 '206': description: 'Partial Response: Part of the requested file has been returned, and the Content-Range header describes which part.' '412': description: 'Precondition Failed: The ETag sent in the If-Range header was invalid or expired.' '428': description: 'Precondition Required: A Range header was sent, but the If-Range header was missing or invalid.' head: tags: - Items summary: Retrieves headers for a given resource. Call this first when planning to use Range/If-Range requests. description: "### Returns the following critical headers:\r\n- Content-Length: <*resource length*>\r\n- Accept-Ranges: `byte`\r\n- Etag: \"<*entity tag used in subsequent range requests*>\"" operationId: ItemsGetPagesHeaders 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: pageNumber in: path description: The page to retrieve. required: true schema: type: integer format: int32 - name: pageCount in: query description: 'If specified, multiple pages can be returned in a single file.' schema: type: integer format: int32 default: 0 - name: exportFormat in: query description: The desired format of the returned file. schema: $ref: '#/components/schemas/ExportFormat' - name: renderOptions in: query description: "The desired format of the returned file.\r\nNote that for multi-page requests, only `PDF` and `TIFF` are valid.\r\nFor single page requests,'PNG and 'JPEG' are also allowed." schema: type: array items: $ref: '#/components/schemas/RenderOptions' - 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 '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 unique item id is invalid.' 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}/retrieval/v3/items/{uniqueItemId}/crop-zone': get: tags: - Items summary: 'Returns just the defined crop zone of a document, if one is defined. Otherwise the response will be 404 NotFound.' operationId: ItemsGetCropZone 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: exportFormat in: query description: The desired format of the returned file. schema: $ref: '#/components/schemas/ExportFormat' - name: renderOptions in: query description: "The desired format of the returned file.\r\nNote that for multi-page requests, only `PDF` and `TIFF` are valid.\r\nFor single page requests,'PNG and 'JPEG' are also allowed." schema: type: array items: $ref: '#/components/schemas/RenderOptions' - name: Range in: header description: "Optional Range header for retrieving the file in parts. For this API, the Range header *must always\r\nbe accompanied by an If-Range header* that contains an ETag acquired in a previous call to this API.\r\nThat call may have resulted in a `206 Partial Response`, or may have been an initial HTTP HEAD request\r\nfor this resource.\r\n\r\nExample, retrieve first KiB: `bytes=0-1023`" schema: type: string - name: If-Range in: header description: "When an ETag header is returned in a previous call to this API which resulted in a `206 Partial Response`,\r\nor from a prior HTTP HEAD request for this given resource, that ETag must be sent in the\r\nIf-Range header when retrieving subsequent ranges of the given resource.\r\nNote that the ETag returned from this API is short-lived." schema: type: string example: '' - 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 '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 unique item id is invalid.' 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 '206': description: 'Partial Response: Part of the requested file has been returned, and the Content-Range header describes which part.' '412': description: 'Precondition Failed: The ETag sent in the If-Range header was invalid or expired.' '428': description: 'Precondition Required: A Range header was sent, but the If-Range header was missing or invalid.' head: tags: - Items summary: Retrieves headers for a given resource. Call this first when planning to use Range/If-Range requests. description: "### Returns the following critical headers:\r\n- Content-Length: <*resource length*>\r\n- Accept-Ranges: `byte`\r\n- Etag: \"<*entity tag used in subsequent range requests*>\"" operationId: ItemsGetCropZoneHeaders 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: exportFormat in: query description: The desired format of the returned file. schema: $ref: '#/components/schemas/ExportFormat' - name: renderOptions in: query description: "The desired format of the returned file.\r\nNote that for multi-page requests, only `PDF` and `TIFF` are valid.\r\nFor single page requests,'PNG and 'JPEG' are also allowed." schema: type: array items: $ref: '#/components/schemas/RenderOptions' - 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 '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 unique item id is invalid.' 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}/retrieval/v3/items-search': post: tags: - ItemsSearch summary: Search for documents and/or reports. description: "This operation can use a *Predefined Search* which is a previously configured\r\nsearch template in Synergy, or it can be an *Open Search* where all criteria\r\nis provided in this call. Populating the `PredefinedSearchName` property will\r\ntrigger the former behavior.\r\n\r\nFor small searches, it is possible to acquire results in a single operation, \r\nresulting in a return status of `200 OK`.\r\n\r\nIf the search is taking longer, or producing more results than the pre-configured\r\nlimits for a synchronous search, the server will create an asynchronous search operation,\r\nresulting in a return status of `201 Created`. \r\n\r\nIn the latter case, a `SearchId` will be returned in lieu of results, \r\nand that id must be used in later calls to retrieve the results after the search has completed.\r\n\r\n### Pseudo code example of executing a predefined search:\r\n search = {\r\n \"PredefinedSearchName\": \"API Demo Invoice Search\",\r\n \"SortIndexName\": \"INVOICE NUMBER\",\r\n \"SearchClauses\": [\r\n { \"IndexName\": \"INVOICE NUMBER\", \"Operator\": \"eq\", \"IndexValue\": \"1234567\" }\r\n ]\r\n }\r\n \r\n response = request.post(\"items-search\", search)\r\n if (response.status == 200) {\r\n results = response.json.Results // complete item properties array\r\n }\r\n else if (response.status == 201) {\r\n // poll on asynchronous search status\r\n while (not response.json.IsSearchComplete) {\r\n delay()\r\n response = request.get(\"items-search/{response.json.SearchId}\")\r\n }\r\n total = response.json.TotalResultCount\r\n // fetch results from completed search\r\n offset = 0\r\n while (offset < total) {\r\n response = request.get(\"items-search/{response.json.SearchId}/results?offset={offset}\")\r\n results += response.json.Results // item properties array\r\n offset += response.json.Paging.Results // block count\r\n }\r\n }" operationId: ItemsSearchStartSearch 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: offset in: query description: '' schema: type: integer format: int32 - name: count in: query description: '' schema: type: integer format: int32 - 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/OpenSearchJob' text/json: schema: $ref: '#/components/schemas/OpenSearchJob' application/*+json: schema: $ref: '#/components/schemas/OpenSearchJob' responses: '200': description: 'Success: The search results are returned in the response.' content: application/json: schema: $ref: '#/components/schemas/ItemSearchResult' '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 '201': description: 'Created: The search is running and a search id is returned that can be used in other API calls to retrieve status and results.' '/v2/{InstitutionUniversalId}/{ProductId}/retrieval/v3/items-search/{searchId}': get: tags: - ItemsSearch summary: Retrieve status information for a search that was executed asynchronously operationId: ItemsSearchGetSearchStatus 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: searchId in: path description: The search Id returned from a previous call to start a search. 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/ItemSearchStatus' '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: - ItemsSearch summary: Delete a search that was (or is) being executed asynchronously. operationId: ItemsSearchDeleteSearch 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: searchId in: path description: The search Id returned from a previous call to start a search. 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 '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}/retrieval/v3/items-search/{searchId}/results': get: tags: - ItemsSearch summary: Retrieve search results for a search that was executed asynchronously. description: "The number of results that can be retrieved in a single request is a\r\npre-configured limit. It is important to check the statistics in the \r\n`Paging` object and to use the `offset` query parameter as necessary\r\nto retrieve all results.\r\n\r\n### Pseudo code example of fetching all remaining search results:\r\n results += response.json.Results // item properties array\r\n offset = response.json.Paging.Results // block count\r\n total = response.json.Paging.Total\r\n while (offset < total) {\r\n response = get(\"items-search/{response.json.SearchId}/results?offset={offset}\")\r\n results += response.json.Results // item properties array\r\n offset += response.json.Paging.Results // block count\r\n }" operationId: ItemsSearchGetSearchResults 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: searchId in: path description: The search Id returned from a previous call to start a search. required: true schema: type: string - name: offset in: query description: '' schema: type: integer format: int32 - name: count in: query description: '' schema: type: integer format: int32 - 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/ItemSearchResult' '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}/retrieval/v3/predefined-searches': get: tags: - PredefinedSearches summary: Retrieves all the predefined searches for the user's file rooms. operationId: PredefinedSearchesGetPredefinedSearchListings 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/PredefinedSearchListResult' '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}/retrieval/v3/predefined-searches/{predefinedSearchId}': get: tags: - PredefinedSearches summary: Retrieves the details of a specific predefined search. operationId: PredefinedSearchesGetPredefinedSearch 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: predefinedSearchId in: path description: The predefined search Id. 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 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/PredefinedSearchResult' '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}/retrieval/v3/reports-search': post: tags: - ReportsSearch summary: Retrieves the metadata for a list of reports matching the given report search criteria operationId: ReportsSearchFindReports 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/FindReports' text/json: schema: $ref: '#/components/schemas/FindReports' application/*+json: schema: $ref: '#/components/schemas/FindReports' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/FindReportsResult' '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}/retrieval/v3/institutions-search': post: tags: - RetrievalCti summary: Gets an array of Synergy institution names for formulating an item search. operationId: RetrievalCtiGetInstitutions 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: offset in: query description: The zero-offset item number for the first item to retrieve. schema: type: integer format: int32 - name: count in: query description: The number of items to retrieve. schema: type: integer format: int32 - 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/RetrievalInstitutionsSearch' text/json: schema: $ref: '#/components/schemas/RetrievalInstitutionsSearch' application/*+json: schema: $ref: '#/components/schemas/RetrievalInstitutionsSearch' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RetrievalInstitutionsSearchResult' '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}/retrieval/v3/cabinets-search': post: tags: - RetrievalCti summary: Gets an array of cabinet and/or application names for formulating an item search. operationId: RetrievalCtiGetCabinets 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: offset in: query description: The zero-offset item number for the first item to retrieve. schema: type: integer format: int32 - name: count in: query description: The number of items to retrieve. schema: type: integer format: int32 - 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/RetrievalCabinetsSearch' text/json: schema: $ref: '#/components/schemas/RetrievalCabinetsSearch' application/*+json: schema: $ref: '#/components/schemas/RetrievalCabinetsSearch' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RetrievalCabinetsSearchResult' '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}/retrieval/v3/types-search': post: tags: - RetrievalCti summary: Gets an array of document type and/or report names for formulating an item search. operationId: RetrievalCtiGetTypes 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: offset in: query description: The zero-offset item number for the first item to retrieve. schema: type: integer format: int32 - name: count in: query description: The number of items to retrieve. schema: type: integer format: int32 - 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/RetrievalTypesSearch' text/json: schema: $ref: '#/components/schemas/RetrievalTypesSearch' application/*+json: schema: $ref: '#/components/schemas/RetrievalTypesSearch' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RetrievalTypesSearchResult' '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}/retrieval/v3/indexes-search': post: tags: - RetrievalCti summary: Gets an array of index information for formulating an item search. operationId: RetrievalCtiGetIndexes 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: offset in: query description: The zero-offset item number for the first item to retrieve. schema: type: integer format: int32 - name: count in: query description: The number of items to retrieve. schema: type: integer format: int32 - 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/RetrievalIndexesSearch' text/json: schema: $ref: '#/components/schemas/RetrievalIndexesSearch' application/*+json: schema: $ref: '#/components/schemas/RetrievalIndexesSearch' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RetrievalIndexesSearchResult' '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}/retrieval/v3/items/{uniqueItemId}/text-notes': get: tags: - TextNotes summary: 'Get an array of properties for text notes on a document, check or report.' operationId: TextNotesGetTextNotes 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: 'The Synergy unique item id of an existing document, check or report.' required: true schema: type: string example: '' - name: allPages in: query description: 'If true, retrieves text notes for all pages in a report.' schema: type: boolean - name: offset in: query description: "The offset from which to start retrieval. This value comes from the `Paging` object, \r\nfound in a previous call to this API where the `count` of items retrieved was less\r\nthan the total available." schema: type: string - name: count in: query description: The maximum number of items to retrieve for this operation. schema: type: integer format: int32 - name: If-Modified-Since in: header description: "Retrieves note properties with a modification date after this RFC1123-date.\r\n\r\nExample: `Sun, 21 Oct 2018 12:16:24 GMT`" schema: type: string format: date-time - 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/TextNoteListResult' '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: Item could not be found.' 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: - TextNotes summary: Create a new text note. operationId: TextNotesCreateTextNote 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: 'The Synergy unique item id of an existing document, check or report.' required: true schema: type: string example: '' - name: pageNumberOverride in: query description: 'For reports, overrides the page number embedded in the uniqueItemId, if any.' schema: type: integer format: int32 - 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/TextNoteCreateInfo' text/json: schema: $ref: '#/components/schemas/TextNoteCreateInfo' application/*+json: schema: $ref: '#/components/schemas/TextNoteCreateInfo' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TextNoteIdResult' '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 '201': description: 'Created: Returns the text note id for the new text note.' '/v2/{InstitutionUniversalId}/{ProductId}/retrieval/v3/items/{uniqueItemId}/text-notes/{textNoteId}': get: tags: - TextNotes summary: 'Retrieve properties for a given text note, including the content.' operationId: TextNotesGetTextNote 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: 'The Synergy unique item id of an existing document, check or report.' required: true schema: type: string example: '' - name: textNoteId in: path description: The relative note id for the given item. required: true schema: type: integer format: int32 - name: X-SynNoteKey in: header description: 'If the note is password protected, this parameter is required in order to retrieve the note''s text.' 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/TextNoteContentInfo' '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: Item could not be found.' 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: - TextNotes summary: Delete a text note. operationId: TextNotesDeleteTextNote 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: 'The Synergy unique item id of an existing document, check or report.' required: true schema: type: string example: '' - name: textNoteId in: path description: The relative note id for the given item. required: true schema: type: integer format: int32 - 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/TextNoteIdResult' '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: - TextNotes summary: Update a text note. operationId: TextNotesUpdateTextNote 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: 'The Synergy unique item id of an existing document, check or report.' required: true schema: type: string example: '' - name: textNoteId in: path description: The relative note id for the given item. required: true schema: type: integer format: int32 - 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/TextNoteUpdateInfo' text/json: schema: $ref: '#/components/schemas/TextNoteUpdateInfo' application/*+json: schema: $ref: '#/components/schemas/TextNoteUpdateInfo' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/TextNoteIdResult' '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. CommonItemInfo: required: - DocumentDate - HasCropZone - Indexes - Module - Restrictions - UniqueItemId - ViewAuthority 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 UniqueItemId: minLength: 1 type: string description: "The unique item id for a document or report.\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 Module: minLength: 1 type: string description: The Synergy module from which the document or report is stored. example: Document Indexes: maxItems: 100 minItems: 1 type: array items: $ref: '#/components/schemas/IndexMapping' description: The index names and values associated with the document. DocumentDate: type: string description: 'For documents, this is the UTC creation date/time, for reports, this is the loaded date.' format: date-time ViewAuthority: minLength: 1 type: string description: "This is a string representation of the view authorities required to be able\r\nto view the document." HasCropZone: type: boolean description: "If true, the document has a crop zone defined that can be retrieved in lieu of\r\nthe entire document page(s)." Restrictions: minLength: 1 type: string description: Access restrictions. DocumentInfo: $ref: '#/components/schemas/DocumentSpecificInfo' ReportInfo: $ref: '#/components/schemas/ReportSpecificInfo' additionalProperties: false description: Information common to both item search results an item info inquiry. ContentFileInfo: type: object properties: FileId: type: integer description: The file number within the context of the owning document or report. format: int32 example: 1 FileType: type: string description: The type of the file. nullable: true example: pdf SubPageCount: type: integer description: The number of pages in *this* file. format: int32 example: 3 additionalProperties: false description: Information about a specific file in a Synergy document or report. DocumentSpecificInfo: required: - CheckReturnReason - DocumentName - ModificationDate type: object properties: LegacyDocumentId: type: integer description: 'Legacy Synergy document id, for informational purposes.' format: int32 DocumentName: maxLength: 80 minLength: 0 type: string description: "The document's friendly name. This may be the same as the document's type\r\nname if it was not overridden." example: Test Document ModificationDate: type: string description: The UTC date and time of the last modification. format: date-time CheckReturnReason: maxLength: 50 minLength: 0 type: string description: The reason a check has been returned. Will be "None" if not a returned check. additionalProperties: false description: Info specific to items in the document module. ExportFormat: enum: - PDF - TIFF - JPEG - PNG - TEXT type: string description: Image or report export format. FindReportInfo: type: object properties: UniqueItemId: type: string description: The unique item id for the report. nullable: true SynergyInstitutionName: type: string description: Synergy institution name. nullable: true ApplicationName: type: string description: Application name. nullable: true ReportName: type: string description: Report name. nullable: true ReportDate: type: string description: The report loaded date. format: date-time additionalProperties: false description: Find Reports Information for a Specific Report FindReports: type: object properties: SynergyInstitutionNames: maxItems: 100 type: array items: type: string description: Synergy institution names for which to constrain the search. nullable: true ApplicationNames: maxItems: 100 type: array items: type: string description: Application names for which to constrain the search. nullable: true ReportNames: maxItems: 100 type: array items: type: string description: Report names for which to constrain the search. nullable: true ReportDatesFrom: type: string description: "The inclusive lower bound for report loaded (processed) dates.\r\nIf not specified, there is no lower bound date constraint for report searches." format: date-time nullable: true example: '2022-05-19' ReportDatesTo: type: string description: "The inclusive upper bound for report loaded (processed) dates.\r\nIf not specified, there is no upper bound date constraint for report searches." format: date-time nullable: true example: '2022-05-19' additionalProperties: false description: Find Reports Criteria FindReportsResult: type: object properties: Reports: type: array items: $ref: '#/components/schemas/FindReportInfo' description: An array of reports. nullable: true Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Find Reports Result HitPageInfo: type: object properties: PageNumber: type: integer description: The page number of the document with the search result. format: int32 PageCount: type: integer description: The number of pages in the search result document. format: int32 additionalProperties: false description: JSON Schema HitPageInfo IndexInfo: 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 additionalProperties: false description: Basic information for a Synergy index. 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. ItemInfo: required: - DocumentDate - Files - HasCropZone - Indexes - Module - PageCount - Restrictions - UniqueItemId - ViewAuthority 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 UniqueItemId: minLength: 1 type: string description: "The unique item id for a document or report.\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 Module: minLength: 1 type: string description: The Synergy module from which the document or report is stored. example: Document Indexes: maxItems: 100 minItems: 1 type: array items: $ref: '#/components/schemas/IndexMapping' description: The index names and values associated with the document. DocumentDate: type: string description: 'For documents, this is the UTC creation date/time, for reports, this is the loaded date.' format: date-time ViewAuthority: minLength: 1 type: string description: "This is a string representation of the view authorities required to be able\r\nto view the document." HasCropZone: type: boolean description: "If true, the document has a crop zone defined that can be retrieved in lieu of\r\nthe entire document page(s)." Restrictions: minLength: 1 type: string description: Access restrictions. DocumentInfo: $ref: '#/components/schemas/DocumentSpecificInfo' ReportInfo: $ref: '#/components/schemas/ReportSpecificInfo' PageCount: type: integer description: The total page count for the document. format: int32 example: 3 Files: type: array items: $ref: '#/components/schemas/ContentFileInfo' description: An array of information about the file from which the document is composed. additionalProperties: false description: Information about an document or report stored in Synergy. ItemSearchResult: required: - IsSearchComplete type: object properties: SearchId: type: string description: The search id. This property will only be populated for asynchronous searches. nullable: true IsSearchComplete: type: boolean description: "If `True`, the search has completed, and the `Results` array\r\ncontains properties of the matching items." Results: type: array items: $ref: '#/components/schemas/CommonItemInfo' description: An array of search results. nullable: true Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: The result of either a StartSearch or GetSearchResults operation. ItemSearchStatus: required: - IsCanceled - IsSearchComplete - SearchId type: object properties: SearchId: minLength: 1 type: string description: 'The id of the asynchronous search, for which this request was issued.' IsSearchComplete: type: boolean description: "If `True`, the search has completed, and the `ResultCount` property\r\ncontains the number of matches." TotalResultCount: type: integer description: "The number of search matches. This property will not be available\r\nuntil `IsSearchComplete` is `True`." format: int32 nullable: true IsCanceled: type: boolean description: The search was canceled by the caller. additionalProperties: false description: Result of a search status call. Module: enum: - Document - Report - Check - All type: string description: JSON schema for SynergyModules OpenSearchJob: required: - SearchClauses type: object properties: SearchClauses: maxItems: 100 minItems: 1 type: array items: $ref: '#/components/schemas/SearchClause' description: 'An array of index names, values, and comparison operators by which to constrain the results.' 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 CabinetNames: maxItems: 100 type: array items: type: string description: "A verbatim array of document cabinet and/or report applications. \r\nOnly items with an exact cabinet/application match from this array will be searched." nullable: true ForceAsync: type: boolean description: "If `True`, this will force the search to be started asynchronously and return a search id\r\nthat can be used in subsequent calls to get the search status, search results, and to delete \r\nthe search.\r\n<br>If this property is `False` (the default), then Synergy will attempt to return search\r\nresults with this response, assuming the search completes quickly with a few number of hits.\r\nIn this case, no search id is returned, because no asynchronous search resource is created.\r\nIf the search exceeds the time or count thresholds (30 seconds, 200 hits), the\r\nsearch will become asynchronous, and a search id will be returned, just as if this property\r\nhad been set to `True`.\r\n" PredefinedSearchName: maxLength: 100 minLength: 0 type: string description: "The search operation can be executed as a \"Predefined Search\" or as\r\nan \"Open Search\". If this property is populated, the specified predefined search will\r\nbe executed and any properties in this object that are not compatible with a\r\npredefined search will be ignored." nullable: true example: Signature Card Search SortIndexName: maxLength: 80 minLength: 0 type: string description: "The index used to sort search results. \r\nIf this property is not specified, the first index specified in \r\n`SearchClauses` will be used." nullable: true example: ACCOUNT NUMBER Modules: maxItems: 3 type: array items: $ref: '#/components/schemas/Module' description: "One or more Synergy modules with which to constraint the results.\r\nIf no module is specified, all accessible modules are assumed.\r\n\r\n<br>*This property is not used for a predefined search.*" nullable: true TypeNames: maxItems: 100 type: array items: type: string description: "A verbatim array of document type and/or report names. \r\nOnly items with an exact type/report match from this array will be searched.\r\n\r\n<br>*This property is not used for a predefined search.*" nullable: true SynergyInstitutionNames: maxItems: 100 type: array items: type: string description: "Synergy institution names for which to constrain the search.\r\n\r\n<br>*This property is not used for a predefined search.*" nullable: true HitListViewName: maxLength: 80 minLength: 0 type: string description: "Hit list view that will determine index information returned.\r\n\r\n<br>*This property is not used for a predefined search.*" nullable: true ReportDatesFrom: type: string description: "The inclusive lower bound for report loaded (processed) dates.\r\nIf not specified, there is no lower bound date constraint for report searches.\r\nThis property will only constrain items in the `Report` module.\r\n\r\n<br>*This property is not used for a predefined search.*" format: date-time nullable: true example: '2022-05-19' ReportDatesTo: type: string description: "The inclusive upper bound for report loaded (processed) dates.\r\nIf not specified, there is no upper bound date constraint for report searches.\r\nThis property will only constrain items in the `Report` module.\r\n\r\n<br>*This property is not used for a predefined search.*" format: date-time nullable: true example: '2022-05-19' additionalProperties: false description: Open Search Criteria 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. PredefinedSearchGroup: type: object properties: GroupId: type: integer description: 1-based group Id. format: int32 Modules: maxItems: 10 type: array items: $ref: '#/components/schemas/Module' description: Module. nullable: true CabinetNames: maxItems: 100 type: array items: type: string description: Cabinet Names. nullable: true CabinetNameFragment: maxLength: 100 minLength: 0 type: string description: Cabinet Fragment. nullable: true Indexes: maxItems: 100 type: array items: $ref: '#/components/schemas/PredefinedSearchIndex' description: Indexes. nullable: true additionalProperties: false description: Predefined Search Group. PredefinedSearchIndex: type: object properties: IndexName: maxLength: 100 minLength: 0 type: string description: Index name. nullable: true Operator: maxLength: 32 minLength: 0 type: string description: Index operator. nullable: true IsLocked: type: boolean description: Is index locked. additionalProperties: false description: Predefined Search Index. PredefinedSearchInfo: required: - PredefinedSearchId type: object properties: PredefinedSearchId: minLength: 1 type: string description: The predefined search id. PredefinedSearchName: type: string description: The predefined search name. nullable: true FileRoomName: type: string description: The fileroom the predefined search is for. nullable: true additionalProperties: false description: Predefined Search Properties PredefinedSearchListResult: type: object properties: PredefinedSearches: type: array items: $ref: '#/components/schemas/PredefinedSearchInfo' description: An array of predefined search info objects. nullable: true additionalProperties: false description: Predefined Search Array Result PredefinedSearchResult: type: object properties: PredefinedSearchName: maxLength: 100 minLength: 0 type: string description: The predefined search name. nullable: true PredefinedSearchId: maxLength: 100 minLength: 0 type: string description: The predefined search Id. nullable: true SearchGroups: maxItems: 100 type: array items: $ref: '#/components/schemas/PredefinedSearchGroup' description: The predefined search groups. nullable: true additionalProperties: false description: Predefined Search Properties RenderOptions: enum: - Annotations - Overlays - Greenbar type: string description: Render options used during item retrieval. ReportSpecificInfo: required: - DateGroup - HasStatements - ReportName type: object properties: ReportName: maxLength: 128 minLength: 0 type: string description: "The report's friendly name. It is a conglomeration\r\nof the report's primary classification attributes." example: 0001 - 031398 - DDA - BALANCE REF JOURNAL HasStatements: type: boolean description: 'If true, the report contains statements.' StatementPageCount: type: integer description: Statement page count (only for statement reports). format: int32 nullable: true DateGroup: minLength: 1 type: string description: 'The report date group. This is typically a 6 digit date, but may also contain text.' example: '031398' HitPage: $ref: '#/components/schemas/HitPageInfo' additionalProperties: false description: Info specific to items in the report module. RetrievalCabinetsSearch: type: object properties: Modules: type: array items: $ref: '#/components/schemas/Module' description: "One or more Synergy modules with which to constraint the results.\r\nIf no module is specified, all accessible modules are assumed." nullable: true SynergyInstitutionNames: maxItems: 100 type: array items: type: string description: "One or more Synergy institutions with which to constrain the results.\r\nIf no institutions are provided, all accessible institutions are assumed." nullable: true example: - '01' - '02' additionalProperties: false description: Request body schema for retrieval cabinet/application search. RetrievalCabinetsSearchResult: required: - CabinetNames type: object properties: CabinetNames: type: array items: type: string description: An array of Synergy cabinet/application names. Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Response body schema for retrieval cabinet/application search. RetrievalIndexesSearch: type: object properties: Modules: type: array items: $ref: '#/components/schemas/Module' description: "One or more Synergy modules with which to constraint the results.\r\nIf no module is specified, all accessible modules are assumed." nullable: true SynergyInstitutionNames: maxItems: 100 type: array items: type: string description: "One or more Synergy institutions with which to constrain the results.\r\nIf no institutions are provided, all accessible institutions are assumed." nullable: true example: - '01' - '02' CabinetNames: maxItems: 100 type: array items: type: string description: "One or more Synergy cabinets with which to constrain the results.\r\nIf no cabinets are provided, all accessible cabinets are assumed.\r\nFor the `Report` module, this array can also contain application names." nullable: true example: - TESTCAB - TESTCAB 2 TypeNames: maxItems: 100 type: array items: type: string description: "One or more document types with which to constrain the results.\r\nIf no document types are provded, all accesible document types are assumed.\r\nFor the `Report` module, this array can also contain report names." nullable: true example: - TESTDOC additionalProperties: false description: Request body schema for retrieval index search. RetrievalIndexesSearchResult: required: - Indexes type: object properties: Indexes: type: array items: $ref: '#/components/schemas/IndexInfo' description: An array of Synergy index information. Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Response body schema for retrieval index search. RetrievalInstitutionsSearch: type: object properties: Modules: type: array items: $ref: '#/components/schemas/Module' description: "One or more Synergy modules with which to constraint the results.\r\nIf no module is specified, all accessible modules are assumed." nullable: true additionalProperties: false description: Request body schema for retrieval Synergy institution search. RetrievalInstitutionsSearchResult: required: - SynergyInstitutionsNames type: object properties: SynergyInstitutionsNames: type: array items: type: string description: An array of Synergy institution names. Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Response body schema for retrieval institution search. RetrievalTypesSearch: type: object properties: Modules: type: array items: $ref: '#/components/schemas/Module' description: "One or more Synergy modules with which to constraint the results.\r\nIf no module is specified, all accessible modules are assumed." nullable: true SynergyInstitutionNames: maxItems: 100 type: array items: type: string description: "One or more Synergy institutions with which to constrain the results.\r\nIf no institutions are provided, all accessible institutions are assumed." nullable: true example: - '01' - '02' CabinetNames: maxItems: 100 type: array items: type: string description: "One or more Synergy cabinets with which to constrain the results.\r\nIf no cabinets are provided, all accessible cabinets are assumed.\r\nFor the `Report` module, this array can also contain application names." nullable: true example: - TESTCAB - TESTCAB 2 additionalProperties: false description: Request body schema for retrieval type/report search. RetrievalTypesSearchResult: required: - TypeNames type: object properties: TypeNames: type: array items: type: string description: An array of Synergy type/report names. Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Response body schema for retrieval type/report search. SearchClause: required: - IndexName - Operator 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' Operator: $ref: '#/components/schemas/SearchOperator' additionalProperties: false description: 'Index, value and comparison operator.' SearchOperator: enum: - eq - neq - lt - lte - gt - gte - in - con type: string description: Comparison operators for a SearchClause. TextNoteContentInfo: type: object properties: TextNoteId: type: integer description: Note Id format: int32 NoteName: maxLength: 40 minLength: 0 type: string description: The note's descriptive name (title). nullable: true IsClassified: type: boolean description: 'If true, the "Classified Notes" authority is required to view the note content. Default: false.' NoteType: $ref: '#/components/schemas/TextNoteType' Owner: maxLength: 255 minLength: 0 type: string description: Note's creator. nullable: true ModificationDate: type: string description: Note's last UTC modification date. format: date-time PageNumber: type: integer description: 'If the note is a page-level note, this is the page number.' format: int32 IsKeyProtected: type: boolean description: Indicates if the note's content is protected by a password. NoteText: maxLength: 2048 minLength: 0 type: string description: The contents of the text note. nullable: true additionalProperties: false description: Note properties returned when 'inquiring' a note. TextNoteCreateInfo: required: - NoteName - NoteText type: object properties: NoteName: maxLength: 40 minLength: 0 type: string description: The note's descriptive name (title). NoteText: maxLength: 2048 minLength: 0 type: string description: The contents of the text note. IsClassified: type: boolean description: 'If true, the "Classified Notes" authority is required to view the note content. Default: false.' NoteKey: maxLength: 64 minLength: 0 type: string description: 'If specified, the note content will be password protected.' nullable: true additionalProperties: false description: Note properties used when creating a note. TextNoteIdResult: type: object properties: TextNoteId: type: integer description: Note Id format: int32 additionalProperties: false description: Note identifier. TextNoteInfo: type: object properties: TextNoteId: type: integer description: Note Id format: int32 NoteName: maxLength: 40 minLength: 0 type: string description: The note's descriptive name (title). nullable: true IsClassified: type: boolean description: 'If true, the "Classified Notes" authority is required to view the note content. Default: false.' NoteType: $ref: '#/components/schemas/TextNoteType' Owner: maxLength: 255 minLength: 0 type: string description: Note's creator. nullable: true ModificationDate: type: string description: Note's last UTC modification date. format: date-time PageNumber: type: integer description: 'If the note is a page-level note, this is the page number.' format: int32 IsKeyProtected: type: boolean description: Indicates if the note's content is protected by a password. additionalProperties: false description: Note properties returned when listing notes. TextNoteListResult: type: object properties: TextNotes: type: array items: $ref: '#/components/schemas/TextNoteInfo' description: An array of text notes. nullable: true Paging: $ref: '#/components/schemas/Paging' additionalProperties: false description: Response body schema for enumerating text note information. TextNoteType: enum: - PageOrDocument - ReportOrTypeNote - ApplicationOrCabinetNote type: string description: Enum of Text Note Types. TextNoteUpdateInfo: type: object properties: NoteName: maxLength: 40 minLength: 0 type: string description: "The note's descriptive name (title).\r\nOmit or specify null to leave the value unchanged." nullable: true NoteText: maxLength: 2048 minLength: 0 type: string description: "The contents of the text note.\r\nOmit or specify null to leave the value unchanged." nullable: true IsClassified: type: boolean description: "If true, the \"Classified Notes\" authority is required to view the note content. Default: false.\r\nOmit or specify null to leave the value unchanged." nullable: true NoteKey: maxLength: 64 minLength: 0 type: string description: "If specified, the note content will be password protected.\r\nOmit or specify null to leave the value unchanged." nullable: true additionalProperties: false description: Note properties used when updating a note. tags: - name: ApiVersions description: APIs for retrieving the API version supported by this instance. - name: Items description: 'APIs to retrieve item properties, and to retrieve file data for items stored in Synergy.' - name: ItemsSearch description: 'APIs to search, both synchronously and asynchronously, for items stored in Synergy.' - name: ReportsSearch description: APIs to search for reports stored in Synergy. - name: PredefinedSearches description: APIs for retrieving and executing predefined searches configured in Synergy. - name: RetrievalCti description: Provides access to Synergy metadata and indexes needed to formulate an item search. - name: TextNotes description: API for working with Text Notes.

Please ignore this field