Items Retrieval API
Enterprise REST API
>
Synergy Retrieval
>
API Reference
>
v2.3
>
Items Retrieval API
openapi: 3.0.0
info:
version: v2.3
title: Items Retrieval API
description: ''
contact:
email: SynergyOpenAPI@jackhenry.com
servers:
- url: https://{API_ENVIRONMENT}/jx-api
variables:
API_ENVIRONMENT:
default: jxdmz.jackhenry.com
description: Corporate Test Server
- url: https://{API_ENVIRONMENT}/jx-api
variables:
API_ENVIRONMENT:
default: jxdmz.jackhenry.com
description: 'Local Mock Server #1'
- url: https://{API_ENVIRONMENT}/jx-api
variables:
API_ENVIRONMENT:
default: jxdmz.jackhenry.com
description: 'Local Mock Server #2'
security:
- OAuth2: []
tags:
- name: Items Retrieval API
description: >-
Provides APIs to retrieve the metadata for items stored in Synergy as well
a various APIs for downloading the documents/reports themselves.
paths:
/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/retrieval/v2.3/items/{UniqueItemId}:
get:
tags:
- Items Retrieval API
description: Retrieve item properties for a document or report. `Inquire`
operationId: retrieval-items-inquire
parameters:
- name: InstitutionId
in: path
description: >-
The identification given to an entity / institution. The URL
utilizes this Id for routing. A financial Institution might opt to
utilize their routing and transit number
required: true
schema:
type: string
default: '000000000'
- name: InstitutionEnvironment
in: path
description: >-
Institution Environment. This code identifies the processing
environment for which the message is intended. Generally, the
environment will be PRODuction, however, various other environments
may exist. TESTing environments are common.
required: true
schema:
type: string
default: PROD
- name: ProductId
in: path
description: >-
Product Identifier. This code identifies the Product for which the
message is intended. Generally, the Product Id will be in the form
of Vendor-Product. However, various other Product Ids may exist.
<br>Example:`jha-synergy`
required: true
schema:
type: string
example: jha-synergy
- name: UniqueItemId
in: path
description: The unique item id of a Synergy document or report.
required: true
schema:
type: string
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|3c3d2e3b-560b-ec11-a275-3cf011584417
- name: X-Request-ID
in: header
description: >-
To support communications level correlation due to some responses
only having header data, a round-trip identifier (GUID) will be
sent on every call from the consumer and returned by the service
provider (or intermediary) regardless of the final disposition of
the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-Correlation-ID
in: header
required: true
description: Correlation ID for communication-based multi-hop message correlation
schema:
type: string
- name: X-BusinessCorrelationId
in: header
description: >-
The correlation identification as related to business functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-WorkflowCorrelationId
in: header
description: >-
The correlation identification as related to workflow functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-AuthenticationUserCredential
in: header
description: >-
Authentication of the end-user (person at keyboard) Credentials in
the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`.
Type default is jwt. <br>Example `X-AuthenticationUserCredential:
jwt <GeneratedOidcJwt>` <br>Example
`X-AuthenticationUserCredential: saml <Generatedsaml>`
schema:
type: string
example: jwt:<GeneratedOidcJwt>
responses:
'200':
description: >-
OK<hr> The HTTP 200 OK success status response code indicates that
the request has succeeded. <br>A 200 response is cacheable by
default.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
content:
application/json:
schema:
allOf:
- allOf:
- allOf:
- type: object
description: Synergy Classifier properties.
additionalProperties: false
properties:
CabinetName:
type: string
description: >-
A cabinet name under which the document should
be classified.
This name must be defined in Synergy and be
accessible by your account for storage
purposes.
Note that this property is also used by the
`Report` module for the Application name.
Example: "LOANS"
maxLength: 80
minLength: 0
example: LOANS
TypeName:
type: string
description: >-
A document type name under which the document
should be classified.
This name must be defined in Synergy, must be
mapped to the specified cabinet name,
and be accessible by your account for storage
purposes.
Note that this property is also used by the
`Report` module for the Report name.
maxLength: 80
minLength: 0
example: AUTO APPLICATION
SynergyInstitutionName:
type: string
description: >-
The institution name that the document should
be assigned to.
This name must be defined in Synergy and be
accessible by your account for storage
purposes.
If this property is not provided, Synergy will
attempt to determine it, if possible.
maxLength: 20
minLength: 0
nullable: true
example: '01'
- type: object
description: >-
Information common to both item search results an
item info inquiry.
additionalProperties: false
required:
- UniqueItemId
- Module
- Indexes
- DocumentDate
- ViewAuthority
- HasCropZone
- Restrictions
properties:
UniqueItemId:
type: string
description: >-
The unique item id for a document or report.
This is a resource id that can be used in
other API calls.
minLength: 1
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417
Module:
type: string
description: >-
The Synergy module from which the document or
report is stored.
minLength: 1
example: Document
Indexes:
type: array
description: >-
The index names and values associated with the
document.
maxItems: 100
minItems: 1
items:
type: object
description: >-
An index name along with its associated
value.
additionalProperties: false
required:
- IndexName
properties:
IndexName:
type: string
description: >-
The name of the index, as defined in
Synergy.
maxLength: 80
minLength: 1
example: ACCOUNT NUMBER
IndexValue:
type: string
description: >-
An index value assignment for the
document.
If the index is defined as multi-value
in Synergy, there may be multiple
index mapping objects with the same
index name, but each with different
values.
maxLength: 1024
minLength: 0
nullable: true
example: 11223344
DocumentDate:
type: string
description: >-
For documents, this is the UTC creation
date/time, for reports, this is the loaded
date.
format: date-time
minLength: 1
ViewAuthority:
type: string
description: >-
This is a string representation of the view
authorities required to be able
to view the document.
minLength: 1
HasCropZone:
type: boolean
description: >-
If true, the document has a crop zone defined
that can be retrieved in lieu of
the entire document page(s).
Restrictions:
type: string
description: Access restrictions.
minLength: 1
DocumentInfo:
description: >-
This information is only provided with the
item belongs to the `Document` or `Check`
module.
nullable: true
allOf:
- type: object
description: >-
Info specific to items in the document
module.
additionalProperties: false
required:
- DocumentName
- ModificationDate
- CheckReturnReason
properties:
LegacyDocumentId:
type: integer
description: >-
Legacy Synergy document id, for
informational purposes.
format: int32
DocumentName:
type: string
description: >-
The document's friendly name. This may
be the same as the document's type
name if it was not overridden.
maxLength: 80
minLength: 0
example: Test Document
ModificationDate:
type: string
description: >-
The UTC date and time of the last
modification.
format: date-time
minLength: 1
CheckReturnReason:
type: string
description: >-
The reason a check has been returned.
Will be "None" if not a returned check.
maxLength: 50
minLength: 0
ReportInfo:
description: >-
This information is only provided when the
item belongs to the `Report` module.
nullable: true
allOf:
- type: object
description: >-
Info specific to items in the report
module.
additionalProperties: false
required:
- ReportName
- HasStatements
- DateGroup
properties:
ReportName:
type: string
description: >-
The report's friendly name. It is a
conglomeration
of the report's primary classification
attributes.
maxLength: 128
minLength: 0
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:
type: string
description: >-
The report date group. This is typically
a 6 digit date, but may also contain
text.
minLength: 1
example: 31398
HitPage:
description: >-
Location information (if any) regarding
a search result.
nullable: true
allOf:
- type: object
description: JSON Schema HitPageInfo
additionalProperties: false
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
- type: object
description: >-
Information about an document or report stored in
Synergy.
additionalProperties: false
required:
- PageCount
- Files
properties:
PageCount:
type: integer
description: The total page count for the document.
format: int32
example: 3
Files:
type: array
description: >-
An array of information about the file from which
the document is composed.
items:
type: object
description: >-
Information about a specific file in a Synergy
document or report.
additionalProperties: false
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.
example: pdf
SubPageCount:
type: integer
description: The number of pages in *this* file.
format: int32
example: 3
- type: object
properties:
MessageStatus:
type: object
description: >-
`MessageStatus` is required/expected for non 2xx
responses.
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a
human readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This
would represent the service provider that carry
out the business service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: >-
The array of details as related to a fault
response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The
category assigned to a providers message
statuses
type: string
Description:
description: >-
The description related to the status code
in a human readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional
element will contain the element which is
causing the condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional
element will contain the value of the
element which is causing the condition
type: string
Location:
description: >-
This is typically the program that generated
the status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to
the log store
type: string
'304':
description: >-
Not Modified <hr> The HTTP 304 Not Modified client redirection
response code indicates that there is no need to retransmit the
requested resources. It is an implicit redirection to a cached
resource. This happens when the request method is safe, like a GET
or a HEAD request, or when the request is conditional and uses a
If-None-Match or a If-Modified-Since header.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
'400':
description: >-
Bad Request<hr> The server could not understand the request due to
invalid syntax.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/json:
schema:
allOf:
- type: object
properties:
MessageStatus:
type: object
description: >-
`MessageStatus` is required/expected for non 2xx
responses.
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a
human readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This
would represent the service provider that carry
out the business service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: >-
The array of details as related to a fault
response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The
category assigned to a providers message
statuses
type: string
Description:
description: >-
The description related to the status code
in a human readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional
element will contain the element which is
causing the condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional
element will contain the value of the
element which is causing the condition
type: string
Location:
description: >-
This is typically the program that generated
the status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to
the log store
type: string
'401':
description: >-
Unauthorized<hr> Although the HTTP standard specifies
"unauthorized", semantically this response means "unauthenticated".
That is, the client must authenticate itself to get the requested
response.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'403':
description: >-
Forbidden<hr> The client does not have access rights to the content;
that is, it is unauthorized, so the server is refusing to give the
requested resource. Unlike 401, the clients identity is known to the
server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'404':
description: >-
Not Found<hr> The server can not find the requested resource. In an
API, this can also mean that the endpoint is valid but the resource
itself does not exist. Servers may also send this response instead
of 403 to hide the existence of a resource from an unauthorized
client.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'413':
description: >-
Request Too Large<hr> Request entity is larger than limits defined
by server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'422':
description: >-
Unprocessed<hr> The request was well-formed but was unable to be
followed due to semantic errors.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'500':
description: >-
Generic Internal Error<hr> The server has encountered a situation it
doesnt know how to handle.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
default:
description: Generic Internal Error
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/retrieval/v2.3/items/{UniqueItemId}/pages:
get:
tags:
- Items Retrieval API
description: >
Retrieve an entire document or report as a single PDF file. `Download`
## Export Format
There are only two valid export formats for this API.
If the optional `exportFormat` parameter is used, note the following
transform restrictions
when exporting the given Synergy item types (default export format is
PDF):
| Export Format | Document (image or text) | Plain Text Report | Other
Report Formats |
| ------------- | ------------------------ | ----------------- |
-------------------- |
| `PDF` | YES | YES |
YES |
| `TEXT` | x | YES |
x |
## Retrieving Data
The maximum amount of file data returned in the response body is a
configured limit.
If a file's size exceeds that limit, a `206 Partial Content` status code
is returned
along with a `Content-Range` header, an `ETag` header, and the partial
file data in
the response body. The remainder of the file has to be downloaded in
subsequent ranges.
### Pseudo code example of an initial file request:
response = request.get('items/{itemId}/pages')
if (response.status == 200 or response.status == 206) {
// 200 OK indicates complete file is in the response body.
output.write(response.body)
}
### Pseudo code example for retrieving the remainder of a file:
if (response.status == 206) {
// 206 Partial Response indicates only partial data for the previous request.
while (response.headers['Content-Range'].To < response.headers['Content-Range'].Size - 1) {
request.headers['Range'].From = response.headers['Content-Range'].To + 1
request.headers['If-Range'] = response.headers['ETag'] // REQUIRED
response = request.get('items/{itemId}/pages')
output.append(response.body)
}
}
Synergy requires that the `Range` header for a file download, always be
accompanied
by an `If-Range` header containing the `ETag` value from a previous
request for this
resource. This is to ensure that any intermediate data generated for the
resource,
is reused on subsequent requests for the same resource.
If it is necessary to retrieve the first chunk of the file with a
`Range` header,
the http `HEAD` method has to be used in an initial call to retrieve the
`ETag`
header, which is needed for subsequent range requests.
operationId: retrieval-items-allpages-download
parameters:
- name: InstitutionId
in: path
description: >-
The identification given to an entity / institution. The URL
utilizes this Id for routing. A financial Institution might opt to
utilize their routing and transit number
required: true
schema:
type: string
default: '000000000'
- name: InstitutionEnvironment
in: path
description: >-
Institution Environment. This code identifies the processing
environment for which the message is intended. Generally, the
environment will be PRODuction, however, various other environments
may exist. TESTing environments are common.
required: true
schema:
type: string
default: PROD
- name: ProductId
in: path
description: >-
Product Identifier. This code identifies the Product for which the
message is intended. Generally, the Product Id will be in the form
of Vendor-Product. However, various other Product Ids may exist.
<br>Example:`jha-synergy`
required: true
schema:
type: string
example: jha-synergy
- name: UniqueItemId
in: path
description: The unique item id of a Synergy document or report.
required: true
schema:
type: string
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|3c3d2e3b-560b-ec11-a275-3cf011584417
- name: Range
in: header
description: >-
Http header element that indicates a request for part of a resource.
<br> Example: <br>`Range: bytes=<range-start>-<range-end>`
example: bytes=0-999
schema:
type: string
example: bytes=0-999
- name: If-Range
in: header
description: >-
The If-Range HTTP request header makes a range request conditional:
if the condition is fulfilled, the range request is issued, and the
server sends back a 206 Partial Content answer with the appropriate
body. If the condition is not fulfilled, the full resource is sent
back with a 200 OK status.
schema:
type: string
- name: X-Request-ID
in: header
description: >-
To support communications level correlation due to some responses
only having header data, a round-trip identifier (GUID) will be
sent on every call from the consumer and returned by the service
provider (or intermediary) regardless of the final disposition of
the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-Correlation-ID
in: header
required: true
description: Correlation ID for communication-based multi-hop message correlation
schema:
type: string
- name: X-BusinessCorrelationId
in: header
description: >-
The correlation identification as related to business functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-WorkflowCorrelationId
in: header
description: >-
The correlation identification as related to workflow functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-AuthenticationUserCredential
in: header
description: >-
Authentication of the end-user (person at keyboard) Credentials in
the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`.
Type default is jwt. <br>Example `X-AuthenticationUserCredential:
jwt <GeneratedOidcJwt>` <br>Example
`X-AuthenticationUserCredential: saml <Generatedsaml>`
schema:
type: string
example: jwt:<GeneratedOidcJwt>
- name: ExportFormat
in: query
description: >-
The format in which to export the given page(s). Note that valid
values for this parameter vary relative to the specific API being
used. <br>Example: `.../resource?ExportFormat=TIFF`
required: false
schema:
type: string
enum:
- PDF
- TIFF
- JPEG
- PNG
- TEXT
default: PDF
- name: RenderOptions
in: query
description: >-
Render options <br>Example:
`.../resource?RenderOptions=Greenbar&RenderOptions=Annotations`
schema:
type: string
enum:
- Greenbar
- Annotations
- Overlay
responses:
'200':
description: >-
OK<hr> The HTTP 200 OK success status response code indicates that
the request has succeeded. <br>A 200 response is cacheable by
default.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/pdf:
schema:
type: string
format: binary
'206':
description: >-
The HTTP 206 Partial Content success status response code indicates
that the request has succeeded and the body contains the requested
ranges of data, as described in the `Range` header of the request.
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/octet-stream:
schema:
type: string
format: binary
'304':
description: >-
Not Modified <hr> The HTTP 304 Not Modified client redirection
response code indicates that there is no need to retransmit the
requested resources. It is an implicit redirection to a cached
resource. This happens when the request method is safe, like a GET
or a HEAD request, or when the request is conditional and uses a
If-None-Match or a If-Modified-Since header.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
'400':
description: >-
Bad Request<hr> The server could not understand the request due to
invalid syntax.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/json:
schema:
allOf:
- type: object
properties:
MessageStatus:
type: object
description: >-
`MessageStatus` is required/expected for non 2xx
responses.
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a
human readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This
would represent the service provider that carry
out the business service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: >-
The array of details as related to a fault
response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The
category assigned to a providers message
statuses
type: string
Description:
description: >-
The description related to the status code
in a human readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional
element will contain the element which is
causing the condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional
element will contain the value of the
element which is causing the condition
type: string
Location:
description: >-
This is typically the program that generated
the status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to
the log store
type: string
'401':
description: >-
Unauthorized<hr> Although the HTTP standard specifies
"unauthorized", semantically this response means "unauthenticated".
That is, the client must authenticate itself to get the requested
response.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'403':
description: >-
Forbidden<hr> The client does not have access rights to the content;
that is, it is unauthorized, so the server is refusing to give the
requested resource. Unlike 401, the clients identity is known to the
server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'404':
description: >-
Not Found<hr> The server can not find the requested resource. In an
API, this can also mean that the endpoint is valid but the resource
itself does not exist. Servers may also send this response instead
of 403 to hide the existence of a resource from an unauthorized
client.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'412':
description: >-
Precondition Failed<hr> The client has indicated preconditions in
its headers which the server does not meet.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'413':
description: >-
Request Too Large<hr> Request entity is larger than limits defined
by server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'422':
description: >-
Unprocessed<hr> The request was well-formed but was unable to be
followed due to semantic errors.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'428':
description: >-
Precondition Required<hr> The origin server requires the request to
be conditional.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'500':
description: >-
Generic Internal Error<hr> The server has encountered a situation it
doesnt know how to handle.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
default:
description: Generic Internal Error
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/retrieval/v2.3/items/{UniqueItemId}/files/{FileNumber}:
get:
tags:
- Items Retrieval API
description: Retrieve a file from a document in its native format. `Download`
operationId: retrieval-items-files-download
parameters:
- name: InstitutionId
in: path
description: >-
The identification given to an entity / institution. The URL
utilizes this Id for routing. A financial Institution might opt to
utilize their routing and transit number
required: true
schema:
type: string
default: '000000000'
- name: InstitutionEnvironment
in: path
description: >-
Institution Environment. This code identifies the processing
environment for which the message is intended. Generally, the
environment will be PRODuction, however, various other environments
may exist. TESTing environments are common.
required: true
schema:
type: string
default: PROD
- name: ProductId
in: path
description: >-
Product Identifier. This code identifies the Product for which the
message is intended. Generally, the Product Id will be in the form
of Vendor-Product. However, various other Product Ids may exist.
<br>Example:`jha-synergy`
required: true
schema:
type: string
example: jha-synergy
- name: UniqueItemId
in: path
description: The unique item id of a Synergy document or report.
required: true
schema:
type: string
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|3c3d2e3b-560b-ec11-a275-3cf011584417
- name: FileNumber
in: path
description: >-
The unit offset file number to retrieve from a document. Note that a
Synergy document can be composed of many files of varying types.
required: true
schema:
type: integer
example: 1
- name: Range
in: header
description: >-
Http header element that indicates a request for part of a resource.
<br> Example: <br>`Range: bytes=<range-start>-<range-end>`
example: bytes=0-999
schema:
type: string
example: bytes=0-999
- name: If-Range
in: header
description: >-
The If-Range HTTP request header makes a range request conditional:
if the condition is fulfilled, the range request is issued, and the
server sends back a 206 Partial Content answer with the appropriate
body. If the condition is not fulfilled, the full resource is sent
back with a 200 OK status.
schema:
type: string
- name: X-Request-ID
in: header
description: >-
To support communications level correlation due to some responses
only having header data, a round-trip identifier (GUID) will be
sent on every call from the consumer and returned by the service
provider (or intermediary) regardless of the final disposition of
the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-Correlation-ID
in: header
required: true
description: Correlation ID for communication-based multi-hop message correlation
schema:
type: string
- name: X-BusinessCorrelationId
in: header
description: >-
The correlation identification as related to business functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-WorkflowCorrelationId
in: header
description: >-
The correlation identification as related to workflow functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-AuthenticationUserCredential
in: header
description: >-
Authentication of the end-user (person at keyboard) Credentials in
the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`.
Type default is jwt. <br>Example `X-AuthenticationUserCredential:
jwt <GeneratedOidcJwt>` <br>Example
`X-AuthenticationUserCredential: saml <Generatedsaml>`
schema:
type: string
example: jwt:<GeneratedOidcJwt>
responses:
'200':
description: >-
OK<hr> The HTTP 200 OK success status response code indicates that
the request has succeeded. <br>A 200 response is cacheable by
default.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
content:
application/octet-stream:
schema:
type: string
format: binary
'206':
description: >-
The HTTP 206 Partial Content success status response code indicates
that the request has succeeded and the body contains the requested
ranges of data, as described in the `Range` header of the request.
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/octet-stream:
schema:
type: string
format: binary
'304':
description: >-
Not Modified <hr> The HTTP 304 Not Modified client redirection
response code indicates that there is no need to retransmit the
requested resources. It is an implicit redirection to a cached
resource. This happens when the request method is safe, like a GET
or a HEAD request, or when the request is conditional and uses a
If-None-Match or a If-Modified-Since header.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
'400':
description: >-
Bad Request<hr> The server could not understand the request due to
invalid syntax.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/json:
schema:
allOf:
- type: object
properties:
MessageStatus:
type: object
description: >-
`MessageStatus` is required/expected for non 2xx
responses.
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a
human readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This
would represent the service provider that carry
out the business service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: >-
The array of details as related to a fault
response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The
category assigned to a providers message
statuses
type: string
Description:
description: >-
The description related to the status code
in a human readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional
element will contain the element which is
causing the condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional
element will contain the value of the
element which is causing the condition
type: string
Location:
description: >-
This is typically the program that generated
the status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to
the log store
type: string
'401':
description: >-
Unauthorized<hr> Although the HTTP standard specifies
"unauthorized", semantically this response means "unauthenticated".
That is, the client must authenticate itself to get the requested
response.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'403':
description: >-
Forbidden<hr> The client does not have access rights to the content;
that is, it is unauthorized, so the server is refusing to give the
requested resource. Unlike 401, the clients identity is known to the
server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'404':
description: >-
Not Found<hr> The server can not find the requested resource. In an
API, this can also mean that the endpoint is valid but the resource
itself does not exist. Servers may also send this response instead
of 403 to hide the existence of a resource from an unauthorized
client.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'412':
description: >-
Precondition Failed<hr> The client has indicated preconditions in
its headers which the server does not meet.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'413':
description: >-
Request Too Large<hr> Request entity is larger than limits defined
by server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'422':
description: >-
Unprocessed<hr> The request was well-formed but was unable to be
followed due to semantic errors.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'428':
description: >-
Precondition Required<hr> The origin server requires the request to
be conditional.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'500':
description: >-
Generic Internal Error<hr> The server has encountered a situation it
doesnt know how to handle.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
default:
description: Generic Internal Error
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/retrieval/v2.3/items/{UniqueItemId}/pages/{PageNumber}:
get:
tags:
- Items Retrieval API
description: >
Retrieve one or more pages from a document or report as a single file in
a given format. `Download`
## Export Format
If the optional `exportFormat` parameter is used, note the following
transform restrictions
when exporting the given Synergy item types (default export format is
PDF):
| Export Format | Document (image or text) | Plain Text Report | Other
Report Formats | Page Range Support |
| ------------- | ------------------------ | ----------------- |
-------------------- | ------------------ |
| `PDF` | YES | YES |
YES | YES |
| `TIFF` | YES | x |
x | YES |
| `JPEG` | YES | x |
x | x |
| `PNG` | YES | x |
x | x |
| `TEXT` | x | YES |
x | YES |
## Retrieving Data
The maximum amount of file data returned in the response body is a
configured limit.
If a file's size exceeds that limit, a `206 Partial Content` status code
is returned
along with a `Content-Range` header, an `ETag` header, and the partial
file data in
the response body. The remainder of the file has to be downloaded in
subsequent ranges.
### Pseudo code example of an initial file request:
response = request.get('items/{itemId}/pages')
if (response.status == 200 or response.status == 206) {
// 200 OK indicates complete file is in the response body.
output.write(response.body)
}
### Pseudo code example for retrieving the remainder of a file:
if (response.status == 206) {
// 206 Partial Response indicates only partial data for the previous request.
while (response.headers['Content-Range'].To < response.headers['Content-Range'].Size - 1) {
request.headers['Range'].From = response.headers['Content-Range'].To + 1
request.headers['If-Range'] = response.headers['ETag'] // REQUIRED
response = request.get('items/{itemId}/pages')
output.append(response.body)
}
}
Synergy requires that the `Range` header for a file download, always be
accompanied
by an `If-Range` header containing the `ETag` value from a previous
request for this
resource. This is to ensure that any intermediate data generated for the
resource,
is reused on subsequent requests for the same resource.
If it is necessary to retrieve the first chunk of the file with a
`Range` header,
the http `HEAD` method has to be used in an initial call to retrieve the
`ETag`
header, which is needed for subsequent range requests.
operationId: retrieval-items-pages-download
parameters:
- name: InstitutionId
in: path
description: >-
The identification given to an entity / institution. The URL
utilizes this Id for routing. A financial Institution might opt to
utilize their routing and transit number
required: true
schema:
type: string
default: '000000000'
- name: InstitutionEnvironment
in: path
description: >-
Institution Environment. This code identifies the processing
environment for which the message is intended. Generally, the
environment will be PRODuction, however, various other environments
may exist. TESTing environments are common.
required: true
schema:
type: string
default: PROD
- name: ProductId
in: path
description: >-
Product Identifier. This code identifies the Product for which the
message is intended. Generally, the Product Id will be in the form
of Vendor-Product. However, various other Product Ids may exist.
<br>Example:`jha-synergy`
required: true
schema:
type: string
example: jha-synergy
- name: UniqueItemId
in: path
description: The unique item id of a Synergy document or report.
required: true
schema:
type: string
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|3c3d2e3b-560b-ec11-a275-3cf011584417
- name: Range
in: header
description: >-
Http header element that indicates a request for part of a resource.
<br> Example: <br>`Range: bytes=<range-start>-<range-end>`
example: bytes=0-999
schema:
type: string
example: bytes=0-999
- name: If-Range
in: header
description: >-
The If-Range HTTP request header makes a range request conditional:
if the condition is fulfilled, the range request is issued, and the
server sends back a 206 Partial Content answer with the appropriate
body. If the condition is not fulfilled, the full resource is sent
back with a 200 OK status.
schema:
type: string
- name: X-Request-ID
in: header
description: >-
To support communications level correlation due to some responses
only having header data, a round-trip identifier (GUID) will be
sent on every call from the consumer and returned by the service
provider (or intermediary) regardless of the final disposition of
the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-Correlation-ID
in: header
required: true
description: Correlation ID for communication-based multi-hop message correlation
schema:
type: string
- name: X-BusinessCorrelationId
in: header
description: >-
The correlation identification as related to business functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-WorkflowCorrelationId
in: header
description: >-
The correlation identification as related to workflow functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-AuthenticationUserCredential
in: header
description: >-
Authentication of the end-user (person at keyboard) Credentials in
the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`.
Type default is jwt. <br>Example `X-AuthenticationUserCredential:
jwt <GeneratedOidcJwt>` <br>Example
`X-AuthenticationUserCredential: saml <Generatedsaml>`
schema:
type: string
example: jwt:<GeneratedOidcJwt>
- name: PageNumber
in: path
description: >-
The logical page number within the document from which to start
retrieval.
required: true
schema:
type: integer
- name: PageCount
in: query
description: >-
The number of pages to retrieve, starting at the given `PageNumber`.
The default of 0 causes a single page to be retrieved. <br>Example:
`.../resource?PageCount=3`
required: false
schema:
type: integer
default: 0
- name: ExportFormat
in: query
description: >-
The format in which to export the given page(s). Note that valid
values for this parameter vary relative to the specific API being
used. <br>Example: `.../resource?ExportFormat=TIFF`
required: false
schema:
type: string
enum:
- PDF
- TIFF
- JPEG
- PNG
- TEXT
default: PDF
- name: RenderOptions
in: query
description: >-
Render options <br>Example:
`.../resource?RenderOptions=Greenbar&RenderOptions=Annotations`
schema:
type: string
enum:
- Greenbar
- Annotations
- Overlay
responses:
'200':
description: >-
OK<hr> The HTTP 200 OK success status response code indicates that
the request has succeeded. <br>A 200 response is cacheable by
default.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
content:
application/pdf:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
'206':
description: >-
The HTTP 206 Partial Content success status response code indicates
that the request has succeeded and the body contains the requested
ranges of data, as described in the `Range` header of the request.
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/pdf:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
'304':
description: >-
Not Modified <hr> The HTTP 304 Not Modified client redirection
response code indicates that there is no need to retransmit the
requested resources. It is an implicit redirection to a cached
resource. This happens when the request method is safe, like a GET
or a HEAD request, or when the request is conditional and uses a
If-None-Match or a If-Modified-Since header.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
'400':
description: >-
Bad Request<hr> The server could not understand the request due to
invalid syntax.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/json:
schema:
allOf:
- type: object
properties:
MessageStatus:
type: object
description: >-
`MessageStatus` is required/expected for non 2xx
responses.
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a
human readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This
would represent the service provider that carry
out the business service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: >-
The array of details as related to a fault
response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The
category assigned to a providers message
statuses
type: string
Description:
description: >-
The description related to the status code
in a human readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional
element will contain the element which is
causing the condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional
element will contain the value of the
element which is causing the condition
type: string
Location:
description: >-
This is typically the program that generated
the status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to
the log store
type: string
'401':
description: >-
Unauthorized<hr> Although the HTTP standard specifies
"unauthorized", semantically this response means "unauthenticated".
That is, the client must authenticate itself to get the requested
response.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'403':
description: >-
Forbidden<hr> The client does not have access rights to the content;
that is, it is unauthorized, so the server is refusing to give the
requested resource. Unlike 401, the clients identity is known to the
server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'404':
description: >-
Not Found<hr> The server can not find the requested resource. In an
API, this can also mean that the endpoint is valid but the resource
itself does not exist. Servers may also send this response instead
of 403 to hide the existence of a resource from an unauthorized
client.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'412':
description: >-
Precondition Failed<hr> The client has indicated preconditions in
its headers which the server does not meet.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'413':
description: >-
Request Too Large<hr> Request entity is larger than limits defined
by server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'422':
description: >-
Unprocessed<hr> The request was well-formed but was unable to be
followed due to semantic errors.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'428':
description: >-
Precondition Required<hr> The origin server requires the request to
be conditional.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'500':
description: >-
Generic Internal Error<hr> The server has encountered a situation it
doesnt know how to handle.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
default:
description: Generic Internal Error
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
/v1/institutions/{InstitutionId}/environments/{InstitutionEnvironment}/products/{ProductId}/retrieval/v2.3/items/{UniqueItemId}/cropzone:
get:
tags:
- Items Retrieval API
description: >-
Retrieves the crop zone only, of the given document. A crop zone must be
defined in Synergy for the given document's Cabinet and Type, or a 404
NotFound will be returned. `Download`
operationId: retrieval-items-cropzone-download
parameters:
- name: InstitutionId
in: path
description: >-
The identification given to an entity / institution. The URL
utilizes this Id for routing. A financial Institution might opt to
utilize their routing and transit number
required: true
schema:
type: string
default: '000000000'
- name: InstitutionEnvironment
in: path
description: >-
Institution Environment. This code identifies the processing
environment for which the message is intended. Generally, the
environment will be PRODuction, however, various other environments
may exist. TESTing environments are common.
required: true
schema:
type: string
default: PROD
- name: ProductId
in: path
description: >-
Product Identifier. This code identifies the Product for which the
message is intended. Generally, the Product Id will be in the form
of Vendor-Product. However, various other Product Ids may exist.
<br>Example:`jha-synergy`
required: true
schema:
type: string
example: jha-synergy
- name: UniqueItemId
in: path
description: The unique item id of a Synergy document or report.
required: true
schema:
type: string
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|3c3d2e3b-560b-ec11-a275-3cf011584417
- name: ExportFormat
in: query
description: >-
The format in which to export the given page(s). Note that valid
values for this parameter vary relative to the specific API being
used. <br>Example: `.../resource?ExportFormat=TIFF`
required: false
schema:
type: string
enum:
- PDF
- TIFF
- JPEG
- PNG
- TEXT
default: PDF
- name: Range
in: header
description: >-
Http header element that indicates a request for part of a resource.
<br> Example: <br>`Range: bytes=<range-start>-<range-end>`
example: bytes=0-999
schema:
type: string
example: bytes=0-999
- name: If-Range
in: header
description: >-
The If-Range HTTP request header makes a range request conditional:
if the condition is fulfilled, the range request is issued, and the
server sends back a 206 Partial Content answer with the appropriate
body. If the condition is not fulfilled, the full resource is sent
back with a 200 OK status.
schema:
type: string
- name: X-Request-ID
in: header
description: >-
To support communications level correlation due to some responses
only having header data, a round-trip identifier (GUID) will be
sent on every call from the consumer and returned by the service
provider (or intermediary) regardless of the final disposition of
the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-Correlation-ID
in: header
required: true
description: Correlation ID for communication-based multi-hop message correlation
schema:
type: string
- name: X-BusinessCorrelationId
in: header
description: >-
The correlation identification as related to business functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-WorkflowCorrelationId
in: header
description: >-
The correlation identification as related to workflow functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
- name: X-AuthenticationUserCredential
in: header
description: >-
Authentication of the end-user (person at keyboard) Credentials in
the form of a JSON Web Token (JWT). <br>Format is `,type> <token>`.
Type default is jwt. <br>Example `X-AuthenticationUserCredential:
jwt <GeneratedOidcJwt>` <br>Example
`X-AuthenticationUserCredential: saml <Generatedsaml>`
schema:
type: string
example: jwt:<GeneratedOidcJwt>
- name: RenderOptions
in: query
description: >-
Render options <br>Example:
`.../resource?RenderOptions=Greenbar&RenderOptions=Annotations`
schema:
type: string
enum:
- Greenbar
- Annotations
- Overlay
responses:
'200':
description: >-
OK<hr> The HTTP 200 OK success status response code indicates that
the request has succeeded. <br>A 200 response is cacheable by
default.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
content:
application/pdf:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
'206':
description: >-
The HTTP 206 Partial Content success status response code indicates
that the request has succeeded and the body contains the requested
ranges of data, as described in the `Range` header of the request.
headers:
ETag:
description: >-
Entity tag used for web cache validation. It provides a
mechanism to cache unchanged resources.
schema:
type: string
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/pdf:
schema:
type: string
format: binary
image/tiff:
schema:
type: string
format: binary
image/jpeg:
schema:
type: string
format: binary
image/png:
schema:
type: string
format: binary
'304':
description: >-
Not Modified <hr> The HTTP 304 Not Modified client redirection
response code indicates that there is no need to retransmit the
requested resources. It is an implicit redirection to a cached
resource. This happens when the request method is safe, like a GET
or a HEAD request, or when the request is conditional and uses a
If-None-Match or a If-Modified-Since header.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
'400':
description: >-
Bad Request<hr> The server could not understand the request due to
invalid syntax.
headers:
X-Request-ID:
description: >-
To support communications level correlation due to some
responses only having header data, a round-trip identifier
(GUID) will be sent on every call from the consumer and returned
by the service provider (or intermediary) regardless of the
final disposition of the request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
X-Correlation-ID:
description: >-
Correlation ID for communication-based multi-hop message
correlation
schema:
type: string
X-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
X-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions
and activities. Generally expected to be a GUID.
schema:
type: string
X-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions
and activities. Generally expected to be a GUID.
schema:
type: string
content:
application/json:
schema:
allOf:
- type: object
properties:
MessageStatus:
type: object
description: >-
`MessageStatus` is required/expected for non 2xx
responses.
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a
human readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This
would represent the service provider that carry
out the business service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: >-
The array of details as related to a fault
response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The
category assigned to a providers message
statuses
type: string
Description:
description: >-
The description related to the status code
in a human readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional
element will contain the element which is
causing the condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional
element will contain the value of the
element which is causing the condition
type: string
Location:
description: >-
This is typically the program that generated
the status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to
the log store
type: string
'401':
description: >-
Unauthorized<hr> Although the HTTP standard specifies
"unauthorized", semantically this response means "unauthenticated".
That is, the client must authenticate itself to get the requested
response.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'403':
description: >-
Forbidden<hr> The client does not have access rights to the content;
that is, it is unauthorized, so the server is refusing to give the
requested resource. Unlike 401, the clients identity is known to the
server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'404':
description: >-
Not Found<hr> The server can not find the requested resource. In an
API, this can also mean that the endpoint is valid but the resource
itself does not exist. Servers may also send this response instead
of 403 to hide the existence of a resource from an unauthorized
client.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'412':
description: >-
Precondition Failed<hr> The client has indicated preconditions in
its headers which the server does not meet.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'413':
description: >-
Request Too Large<hr> Request entity is larger than limits defined
by server.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'422':
description: >-
Unprocessed<hr> The request was well-formed but was unable to be
followed due to semantic errors.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'428':
description: >-
Precondition Required<hr> The origin server requires the request to
be conditional.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
'500':
description: >-
Generic Internal Error<hr> The server has encountered a situation it
doesnt know how to handle.
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
default:
description: Generic Internal Error
headers:
X-Request-ID:
description: Returned X-Request-ID
schema:
type: string
components:
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
tokenUrl: >-
https://jxdmz.jackhenry.com/jxchange/identity/authserver/connect/token
scopes: {}
parameters:
pInstitutionId:
name: InstitutionId
in: path
description: >-
The identification given to an entity / institution. The URL utilizes
this Id for routing. A financial Institution might opt to utilize
their routing and transit number
required: true
schema:
type: string
default: '000000000'
pInstitutionEnvironment:
name: InstitutionEnvironment
in: path
description: >-
Institution Environment. This code identifies the processing
environment for which the message is intended. Generally, the
environment will be PRODuction, however, various other environments may
exist. TESTing environments are common.
required: true
schema:
type: string
default: PROD
pProductId:
name: ProductId
in: path
description: >-
Product Identifier. This code identifies the Product for which the
message is intended. Generally, the Product Id will be in the form of
Vendor-Product. However, various other Product Ids may exist.
<br>Example:`jha-synergy`
required: true
schema:
type: string
example: jha-synergy
pResourceId:
name: ResourceId
in: path
description: The identifier to be used as a key to the resource
required: true
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
pOffset:
name: Offset
in: query
description: >-
The service offset provided by the API provider <br>Example:
`.../resource?Offset=value`
schema:
type: string
default: '0'
pCount:
name: Count
in: query
description: 'The count of records requested <br>Example: `.../resource?Count=value`'
schema:
type: string
default: '0'
pStatusType:
name: StatusType
in: path
description: The type of status
required: true
schema:
type: string
default: ''
pFields:
name: Fields
in: query
description: >-
The query of fields, comma separated, for get operations. <br>Example:
`.../resource?Fields=field1,field2,field3`
schema:
type: string
example: field1,field2,field3
peTags:
name: eTags
in: query
description: >-
Indicating if a collection of eTags should be returned for GET:List
operations. Default is false. <br>Example: `.../resource?eTags=true`
schema:
type: boolean
example: 'false'
pRestrictions:
name: Restrictions
in: query
description: 'The query of restrictions <br>Example: `.../resource?Restrictions=value`'
schema:
type: boolean
example: true
pSort:
name: Sort
in: query
description: >-
Indicating the elements used for sorting and direction [asc, desc],
comma separated, for operations that retun a list. <br>Example:
`.../resource?Sort=field1:direction,field2:direction,field3:direction`
schema:
type: string
example: '`.../resource?Sort=field1:asc,field2:desc`'
pFilter-Basic:
name: Filter
in: query
description: >-
Indicating the elements used for filtering and the match value for each
element. Filtering reduces the rows returned and therefore Basic
Filtering is appropriate to services that return an array of resources.
The default operation is "equal" and the default collation rule is
"ignore case" <br>Example:
`.../resource?filter=address.state:mo,address.county:green)`
schema:
type: string
example: '`.../resource?Filter=field1:value1,field2:value2`'
pFilter:
name: Filter
in: query
description: >-
Indicating the elements used for filtering, the operation (type of
evaluation), and the value used for evaluation for each element.
Filtering reduces the rows returned and therefore Filtering is
appropriate to services that return an array of resources. <br>Format of
filter object is `element:operator:value` <br>Operators: eq - equal, ne
- not equal, lt - less than, gt - greater than, in - in list, con -
contains, gte - greater than or equal, lte - less than or equal, sw -
starts with, ew - ends with <br>Collation Rule: i - ignore case (add
rule to front of operation: ieq, ine, ilt, igt, iin, icon, igte, ilte,
isw, iew) <br>Example:
`.../resource?filter=address.state:eq:MO,address.county:eq:Green,customer.lastname:isw:hamm`
schema:
type: string
example: '`.../resource?Filter=field1:op:value1,field2:op:value2`'
pAuthorization:
name: Authorization
in: header
description: >-
JWT Token. Represents Callers Authentication Token in the form of a JWT
generated by a OAuth 2.0 Identity Provider and conforms to the OpenID
Connect specification. See [Security section] for other details.
<br>Example `Authorization: bearer <GeneratedOidcJwt>`
required: true
schema:
type: string
example: bearer <GeneratedOidcJwt>
pDate:
in: header
name: Date
description: >-
Standard http header element for date and time. HTTP headers are
represented as RFC 7231 Full Dates. <br>Example `Date: Wed, 21 Oct 2015
07:28:00 GMT`
required: true
schema:
type: string
example: Wed, 21 Oct 2015 07:28:00 GMT
pContent-Type:
name: Content-Type
description: >-
The Content-Type entity header is used to indicate the media type of the
resource. In responses, a Content-Type header tells the client what the
content type of the returned content actually is. In requests, (such as
POST or PUT), the client tells the server what type of data is actually
sent.
in: header
required: true
schema:
type: string
default: application/json
pContentLength:
name: Content-Length
in: header
description: Http header element that indicates the length expressed in bytes.
required: true
schema:
type: integer
pRange:
name: Range
in: header
description: >-
Http header element that indicates a request for part of a resource.
<br> Example: <br>`Range: bytes=<range-start>-<range-end>`
example: bytes=0-999
schema:
type: string
example: bytes=0-999
pETag:
name: ETag
in: header
description: >-
Entity tag used for web cache validation. It provides a mechanism to
cache unchanged resources.
schema:
type: string
pIf-Match:
name: If-Match
in: header
description: Enables optimistic updating with ETag
schema:
type: string
pIf-Modified-Since:
name: If-Modified-Since
in: header
description: >-
The If-Modified-Since request HTTP header makes the request conditional:
the server will send back the requested resource, with a 200 status,
only if it has been last modified after the given date. If the request
has not been modified since, the response will be a 304 without any
body; the Last-Modified response header of a previous request will
contain the date of last modification. <br>Example: `<day-name>, <day>
<month> <year> <hour>:<minute>:<second> GMT`
schema:
type: string
example: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
pIf-Range:
name: If-Range
in: header
description: >-
The If-Range HTTP request header makes a range request conditional: if
the condition is fulfilled, the range request is issued, and the server
sends back a 206 Partial Content answer with the appropriate body. If
the condition is not fulfilled, the full resource is sent back with a
200 OK status.
schema:
type: string
pX-Request-ID:
name: X-Request-ID
in: header
description: >-
To support communications level correlation due to some responses only
having header data, a round-trip identifier (GUID) will be sent on
every call from the consumer and returned by the service provider (or
intermediary) regardless of the final disposition of the
request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
pX-AuditUserId:
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. It will vary but could be down to
the user id. It will not be use to authenticate, only audit information.
schema:
type: string
example: InigoMontoya
pX-AuditDeviceId:
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. It will vary but could be down to
the machine id or address.
schema:
type: string
example: 192.168.0.101
pX-BusinessCorrelationId:
name: X-BusinessCorrelationId
in: header
description: >-
The correlation identification as related to business functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
pX-WorkflowCorrelationId:
name: X-WorkflowCorrelationId
in: header
description: >-
The correlation identification as related to workflow functions and
activities. Generally expected to be a GUID.
schema:
type: string
example: 123e4567-e89b-12d3-a456-426655440000
pX-AuthenticationUserCredential-optional:
name: X-AuthenticationUserCredential
in: header
description: >-
Authentication of the end-user (person at keyboard) Credentials in the
form of a JSON Web Token (JWT). <br>Format is `,type> <token>`. Type
default is jwt. <br>Example `X-AuthenticationUserCredential: jwt
<GeneratedOidcJwt>` <br>Example `X-AuthenticationUserCredential: saml
<Generatedsaml>`
schema:
type: string
example: jwt:<GeneratedOidcJwt>
pX-AuthenticationProductCredential:
name: X-AuthenticationProductCredential
in: header
description: >-
Authentication of the Consumer Product Credentials in the form of a JSON
Web Token (JWT). Same as "Authorization" jwt unless the message is
sent "on-behalf-of" this consumer product. <br>Format is `<type>
<token>`. Type default is jwt. <br>Example
`X-AuthenticationProductCredential: jwt <GeneratedOidcJwt>` <br>Example
`X-AuthenticationProductCredential: saml <Generatedsaml>`
required: true
schema:
type: string
example: jwt:<GeneratedOidcJwt>
pX-Correlation-ID:
name: X-Correlation-ID
in: header
required: true
description: Correlation ID for communication-based multi-hop message correlation
schema:
type: string
pX-Messages:
name: X-Messages
in: header
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
pX-Version:
name: X-Version
in: header
description: Indicating version for the management status service
schema:
type: string
default: false
pX-FaultOverride:
name: X-FaultOverride
in: header
description: Determines if all faults should be override
schema:
type: string
default: false
pContentRange:
name: Content-Range
in: header
description: >-
Http header element that indicates where, in a full body message, a
partial message belongs. <br> Examples: <br>`Content-Range: <unit>
<range-start>-<range-end>/<size>` <br>`Content-Range: <unit>
<range-start>-<range-end>/*` <br>`Content-Range: <unit> */<size>`
required: true
example: bytes 0-1000/*
schema:
type: string
example: bytes 0-1000/*
pLanguage:
name: Language
in: query
description: 'Language of request <br>Example: `.../resource?Language=value`'
schema:
type: string
default: en
enum:
- en
- sp
- fr
- ch
pRenderOptions:
name: RenderOptions
in: query
description: >-
Render options <br>Example:
`.../resource?RenderOptions=Greenbar&RenderOptions=Annotations`
schema:
type: string
enum:
- Greenbar
- Annotations
- Overlay
pUniqueItemId:
name: UniqueItemId
in: path
description: The unique item id of a Synergy document or report.
required: true
schema:
type: string
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|3c3d2e3b-560b-ec11-a275-3cf011584417
pSearchId:
name: SearchId
in: path
description: The id of a previously created asynchronous search.
required: true
schema:
type: string
pFileNumber:
name: FileNumber
in: path
description: >-
The unit offset file number to retrieve from a document. Note that a
Synergy document can be composed of many files of varying types.
required: true
schema:
type: integer
example: 1
pPageNumberOverride:
name: PageNumberOverride
in: query
description: The logical page number within a report on which to place the text note.
required: false
schema:
type: integer
pPageNumber:
name: PageNumber
in: path
description: >-
The logical page number within the document from which to start
retrieval.
required: true
schema:
type: integer
pPageCount:
name: PageCount
in: query
description: >-
The number of pages to retrieve, starting at the given `PageNumber`. The
default of 0 causes a single page to be retrieved. <br>Example:
`.../resource?PageCount=3`
required: false
schema:
type: integer
default: 0
pExportFormat:
name: ExportFormat
in: query
description: >-
The format in which to export the given page(s). Note that valid values
for this parameter vary relative to the specific API being used.
<br>Example: `.../resource?ExportFormat=TIFF`
required: false
schema:
type: string
enum:
- PDF
- TIFF
- JPEG
- PNG
- TEXT
default: PDF
pTextNoteId:
name: TextNoteId
in: path
description: 'The relative text note id associated with a given item. <br>Example: `1`'
required: true
schema:
type: string
pAllPages:
name: AllPages
in: query
description: >-
If true, get text note properties for all pages in a report or
statement.
required: false
schema:
type: boolean
default: false
pX-SynNoteKey:
name: X-SynNoteKey
in: header
required: false
description: >-
If a text note is locked with a password, and is not owned by the API
user, this header value is required in order to retrieve the note''s
content, to edit it, or to delete it.
schema:
type: string
pPredefinedSearchId:
name: PredefinedSearchId
in: path
description: 'Custom URL key: PredefinedSearchId'
required: true
schema:
type: string
pModule:
name: Module
in: query
description: 'Custom query key: Module <br>Example: `.../resource?Module=value`'
required: false
schema:
type: string
headers:
pContent-Range:
description: >-
Http header element that indicates where, in a full body message, a
partial message belongs. <br> Examples: <br>`Content-Range: <unit>
<range-start>-<range-end>/<size>` <br>`Content-Range: <unit>
<range-start>-<range-end>/*` <br>`Content-Range: <unit> */<size>`
required: true
example: bytes 0-1000/*
schema:
type: string
example: bytes 0-1000/*
pContent-Type:
description: >-
The Content-Type entity header is used to indicate the media type of the
resource. In responses, a Content-Type header tells the client what the
content type of the returned content actually is. In requests, (such as
POST or PUT), the client tells the server what type of data is actually
sent.
required: true
schema:
type: string
default: application/json
pContent-Length:
description: Http header element that indicates the length expressed in bytes.
required: true
schema:
type: integer
pETag:
description: >-
Entity tag used for web cache validation. It provides a mechanism to
cache unchanged resources.
schema:
type: string
pIf-Match:
description: Enables optimistic updating with ETag
schema:
type: string
default: application/json
pX-Request-ID:
description: >-
To support communications level correlation due to some responses only
having header data, a round-trip identifier (GUID) will be sent on
every call from the consumer and returned by the service provider (or
intermediary) regardless of the final disposition of the
request/message.
required: true
schema:
type: string
format: uuid
example: 123e4567-e89b-12d3-a456-426655440000
pX-AuditUserId:
description: >-
This is the User Id which the consumer would like written to the audit
as performing the requested service. It will vary but could be down to
the user id. It will not be use to authenticate, only audit information.
schema:
type: string
pX-AuditDeviceId:
description: >-
This is the device Id which the consumer would like written to the audit
as performing the requested service. It will vary but could be down to
the machine id.
schema:
type: string
pX-BusinessCorrelationId:
description: >-
The correlation identification as related to business functions and
activities. Generally expected to be a GUID.
schema:
type: string
pX-WorkflowCorrelationId:
description: >-
The correlation identification as related to workflow functions and
activities. Generally expected to be a GUID.
schema:
type: string
pX-AuthenticationUserCredential-optional:
description: >-
Authentication of the end-user (person at keyboard) Credentials in the
form of a JSON Web Token (JWT). <br>Example
`X-AuthenticationUserCredential: jwt:<GeneratedOidcJwt>` <br>Example
`X-AuthenticationUserCredential: saml:<Generatedsaml>`
schema:
type: string
pX-AuthenticationProductCredential:
description: >-
Authentication of the Consumer Product Credentials in the form of a JSON
Web Token (JWT). Same as "Authorization" jwt unless the message is
sent "on-behalf-of" this consumer product. <br>Example
`X-AuthenticationProductCredential: jwt:<GeneratedOidcJwt>` <br>Example
`X-AuthenticationProductCredential: saml:<Generatedsaml>`
required: true
schema:
type: string
pX-Correlation-ID:
description: Correlation ID for communication-based multi-hop message correlation
schema:
type: string
pX-Messages:
description: Indicating messages/faults/errors returned
schema:
type: boolean
default: false
pX-Version:
description: Indicating version for the management status service
schema:
type: string
default: false
pX-FaultOverride:
description: Determines if all faults should be override
schema:
type: string
default: false
requestBodies:
RetrievalSynergyinstitutionsSearchRequest:
content:
application/json:
schema:
allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint the
results.
If no module is specified, all accessible modules are
assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Request body schema for retrieval Synergy institution search.
additionalProperties: false
RetrievalCabinetsSearchRequest:
content:
application/json:
schema:
allOf:
- allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint
the results.
If no module is specified, all accessible modules are
assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Cabinet constraint. Used in other objects.
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: >-
One or more Synergy institutions with which to
constrain the results.
If no institutions are provided, all accessible
institutions are assumed.
maxItems: 100
example:
- '01'
- '02'
items:
type: string
maxLength: 20
- type: object
description: Request body schema for retrieval cabinet/application search.
additionalProperties: false
RetrievalTypesSearchRequest:
content:
application/json:
schema:
allOf:
- allOf:
- allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to
constraint the results.
If no module is specified, all accessible modules
are assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Cabinet constraint. Used in other objects.
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: >-
One or more Synergy institutions with which to
constrain the results.
If no institutions are provided, all accessible
institutions are assumed.
maxItems: 100
example:
- '01'
- '02'
items:
type: string
maxLength: 20
- type: object
description: Type constraint. Used in other objects.
additionalProperties: false
properties:
CabinetNames:
type: array
description: >-
One or more Synergy cabinets with which to constrain
the results.
If no cabinets are provided, all accessible cabinets
are assumed.
For the `Report` module, this array can also contain
application names.
maxItems: 100
example:
- TESTCAB
- TESTCAB 2
items:
type: string
maxLength: 80
- type: object
description: Request body schema for retrieval type/report search.
additionalProperties: false
RetrievalIndexesSearchRequest:
content:
application/json:
schema:
allOf:
- allOf:
- allOf:
- allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to
constraint the results.
If no module is specified, all accessible
modules are assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Cabinet constraint. Used in other objects.
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: >-
One or more Synergy institutions with which to
constrain the results.
If no institutions are provided, all
accessible institutions are assumed.
maxItems: 100
example:
- '01'
- '02'
items:
type: string
maxLength: 20
- type: object
description: Type constraint. Used in other objects.
additionalProperties: false
properties:
CabinetNames:
type: array
description: >-
One or more Synergy cabinets with which to
constrain the results.
If no cabinets are provided, all accessible
cabinets are assumed.
For the `Report` module, this array can also
contain application names.
maxItems: 100
example:
- TESTCAB
- TESTCAB 2
items:
type: string
maxLength: 80
- type: object
description: Index constraint. Used in other objects.
additionalProperties: false
properties:
TypeNames:
type: array
description: >-
One or more document types with which to constrain the
results.
If no document types are provded, all accesible
document types are assumed.
For the `Report` module, this array can also contain
report names.
maxItems: 100
example:
- TESTDOC
items:
type: string
maxLength: 80
- type: object
description: Request body schema for retrieval index search.
additionalProperties: false
RetrievalItemsSearchRequest:
content:
application/json:
schema:
allOf:
- type: object
description: >-
Properties common to both PredefinedSearchJob (v1.0) and
OpenSearchJob (v2.1)
additionalProperties: false
required:
- SearchClauses
properties:
SearchClauses:
type: array
description: >-
An array of index names, values, and comparison operators
by which to constrain the results.
maxItems: 100
minItems: 1
items:
allOf:
- type: object
description: An index name along with its associated value.
additionalProperties: false
required:
- IndexName
properties:
IndexName:
type: string
description: The name of the index, as defined in Synergy.
maxLength: 80
minLength: 1
example: ACCOUNT NUMBER
IndexValue:
type: string
description: >-
An index value assignment for the document.
If the index is defined as multi-value in
Synergy, there may be multiple
index mapping objects with the same index name,
but each with different values.
maxLength: 1024
minLength: 0
nullable: true
example: 11223344
- type: object
description: Index, value and comparison operator.
additionalProperties: false
required:
- Operator
properties:
Operator:
description: Comparison operator.
example: eq
allOf:
- type: string
description: Comparison operators for a SearchClause.
x-enumNames:
- eq
- neq
- lt
- lte
- gt
- gte
- in
- con
enum:
- eq
- neq
- lt
- lte
- gt
- gte
- in
- con
OpenVocabularyName:
type: string
description: |-
The optional name of a Synergy Open Vocabulary mapping.
If provided, the mapping will be used to map user defined
cab, type, and index names to Synergy defined names.
maxLength: 80
minLength: 0
nullable: true
example: Custom Vocab
CabinetNames:
type: array
description: >-
A verbatim array of document cabinet and/or report
applications.
Only items with an exact cabinet/application match from
this array will be searched.
maxItems: 100
nullable: true
items:
type: string
maxLength: 80
ForceAsync:
type: boolean
description: >-
If `True`, this will force the search to be started
asynchronously and return a search id
that can be used in subsequent calls to get the search
status, search results, and to delete
the search.
If this property is `False` (the default), then Synergy
will attempt to return search
results with this response, assuming the search completes
quickly with a few number of hits.
In this case, no search id is returned, because no
asynchronous search resource is created.
If the search exceeds the time or count thresholds (30
seconds, 200 hits), the
search will become asynchronous, and a search id will be
returned, just as if this property
had been set to `True`.
- type: object
description: Open Search Criteria
additionalProperties: false
properties:
PredefinedSearchName:
type: string
description: >-
The search operation can be executed as a "Predefined
Search" or as
an "Open Search". If this property is populated, the
specified predefined search will
be executed and any properties in this object that are not
compatible with a
predefined search will be ignored.
maxLength: 100
minLength: 0
nullable: true
example: Signature Card Search
SortIndexName:
type: string
description: >-
The index used to sort search results.
If this property is not specified, the first index
specified in
`SearchClauses` will be used.
maxLength: 80
minLength: 0
nullable: true
example: ACCOUNT NUMBER
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint the
results.
If no module is specified, all accessible modules are
assumed.
*This property is not used for a predefined search.*
maxItems: 3
nullable: true
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
TypeNames:
type: array
description: >-
A verbatim array of document type and/or report names.
Only items with an exact type/report match from this array
will be searched.
*This property is not used for a predefined search.*
maxItems: 100
nullable: true
items:
type: string
maxLength: 80
SynergyInstitutionNames:
type: array
description: >-
Synergy institution names for which to constrain the
search.
*This property is not used for a predefined search.*
maxItems: 100
nullable: true
items:
type: string
maxLength: 20
HitListViewName:
type: string
description: >-
Hit list view that will determine index information
returned.
*This property is not used for a predefined search.*
maxLength: 80
minLength: 0
nullable: true
ReportDatesFrom:
type: string
description: >-
The inclusive lower bound for report loaded (processed)
dates.
If not specified, there is no lower bound date constraint
for report searches.
This property will only constrain items in the `Report`
module.
*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.
If not specified, there is no upper bound date constraint
for report searches.
This property will only constrain items in the `Report`
module.
*This property is not used for a predefined search.*
format: date-time
nullable: true
example: '2022-05-19'
RetrievalItemsTextnotesCreateRequest:
content:
application/json:
schema:
allOf:
- type: object
description: Note properties used when creating a note.
additionalProperties: false
required:
- NoteName
- NoteText
properties:
NoteName:
type: string
description: The note's descriptive name (title).
maxLength: 40
minLength: 0
NoteText:
type: string
description: The contents of the text note.
maxLength: 2048
minLength: 0
IsClassified:
type: boolean
description: >-
If true, the "Classified Notes" authority is required to
view the note content. Default: false.
NoteKey:
type: string
description: If specified, the note content will be password protected.
maxLength: 64
minLength: 0
nullable: true
RetrievalItemsTextnotesUpdateRequest:
content:
application/json:
schema:
allOf:
- type: object
description: Note properties used when updating a note.
additionalProperties: false
properties:
NoteName:
type: string
description: |-
The note's descriptive name (title).
Omit or specify null to leave the value unchanged.
maxLength: 40
minLength: 0
nullable: true
NoteText:
type: string
description: |-
The contents of the text note.
Omit or specify null to leave the value unchanged.
maxLength: 2048
minLength: 0
nullable: true
IsClassified:
type: boolean
description: >-
If true, the "Classified Notes" authority is required to
view the note content. Default: false.
Omit or specify null to leave the value unchanged.
nullable: true
NoteKey:
type: string
description: |-
If specified, the note content will be password protected.
Omit or specify null to leave the value unchanged.
maxLength: 64
minLength: 0
nullable: true
RetrievalReportsSearchRequest:
content:
application/json:
schema:
allOf:
- type: object
description: Find Reports Criteria
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: >-
Synergy institution names for which to constrain the
search.
maxItems: 100
nullable: true
items:
type: string
maxLength: 20
ApplicationNames:
type: array
description: Application names for which to constrain the search.
maxItems: 100
nullable: true
items:
type: string
maxLength: 4
ReportNames:
type: array
description: Report names for which to constrain the search.
maxItems: 100
nullable: true
items:
type: string
maxLength: 80
ReportDatesFrom:
type: string
description: >-
The inclusive lower bound for report loaded (processed)
dates.
If 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.
If not specified, there is no upper bound date constraint
for report searches.
format: date-time
nullable: true
example: '2022-05-19'
schemas:
RetrievalSynergyinstitutionsSearchRequest:
allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint the
results.
If no module is specified, all accessible modules are assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Request body schema for retrieval Synergy institution search.
additionalProperties: false
RetrievalSynergyinstitutionsSearchResponse:
allOf:
- type: object
description: Response body schema for retrieval institution search.
additionalProperties: false
required:
- SynergyInstitutionsNames
properties:
SynergyInstitutionsNames:
type: array
description: An array of Synergy institution names.
items:
type: string
maxLength: 20
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalCabinetsSearchRequest:
allOf:
- allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint the
results.
If no module is specified, all accessible modules are
assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Cabinet constraint. Used in other objects.
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: >-
One or more Synergy institutions with which to constrain the
results.
If no institutions are provided, all accessible institutions
are assumed.
maxItems: 100
example:
- '01'
- '02'
items:
type: string
maxLength: 20
- type: object
description: Request body schema for retrieval cabinet/application search.
additionalProperties: false
RetrievalCabinetsSearchResponse:
allOf:
- type: object
description: Response body schema for retrieval cabinet/application search.
additionalProperties: false
required:
- CabinetNames
properties:
CabinetNames:
type: array
description: An array of Synergy cabinet/application names.
items:
type: string
maxLength: 80
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalTypesSearchRequest:
allOf:
- allOf:
- allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint the
results.
If no module is specified, all accessible modules are
assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Cabinet constraint. Used in other objects.
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: >-
One or more Synergy institutions with which to constrain
the results.
If no institutions are provided, all accessible
institutions are assumed.
maxItems: 100
example:
- '01'
- '02'
items:
type: string
maxLength: 20
- type: object
description: Type constraint. Used in other objects.
additionalProperties: false
properties:
CabinetNames:
type: array
description: >-
One or more Synergy cabinets with which to constrain the
results.
If no cabinets are provided, all accessible cabinets are
assumed.
For the `Report` module, this array can also contain
application names.
maxItems: 100
example:
- TESTCAB
- TESTCAB 2
items:
type: string
maxLength: 80
- type: object
description: Request body schema for retrieval type/report search.
additionalProperties: false
RetrievalTypesSearchResponse:
allOf:
- type: object
description: Response body schema for retrieval type/report search.
additionalProperties: false
required:
- TypeNames
properties:
TypeNames:
type: array
description: An array of Synergy type/report names.
items:
type: string
maxLength: 80
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalIndexesSearchRequest:
allOf:
- allOf:
- allOf:
- allOf:
- type: object
description: Module constraint. Used in other objects.
additionalProperties: false
properties:
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint
the results.
If no module is specified, all accessible modules
are assumed.
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
- type: object
description: Cabinet constraint. Used in other objects.
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: >-
One or more Synergy institutions with which to
constrain the results.
If no institutions are provided, all accessible
institutions are assumed.
maxItems: 100
example:
- '01'
- '02'
items:
type: string
maxLength: 20
- type: object
description: Type constraint. Used in other objects.
additionalProperties: false
properties:
CabinetNames:
type: array
description: >-
One or more Synergy cabinets with which to constrain the
results.
If no cabinets are provided, all accessible cabinets are
assumed.
For the `Report` module, this array can also contain
application names.
maxItems: 100
example:
- TESTCAB
- TESTCAB 2
items:
type: string
maxLength: 80
- type: object
description: Index constraint. Used in other objects.
additionalProperties: false
properties:
TypeNames:
type: array
description: >-
One or more document types with which to constrain the
results.
If no document types are provded, all accesible document
types are assumed.
For the `Report` module, this array can also contain report
names.
maxItems: 100
example:
- TESTDOC
items:
type: string
maxLength: 80
- type: object
description: Request body schema for retrieval index search.
additionalProperties: false
RetrievalIndexesSearchResponse:
allOf:
- type: object
description: Response body schema for retrieval index search.
additionalProperties: false
required:
- Indexes
properties:
Indexes:
type: array
description: An array of Synergy index information.
items:
type: object
description: Basic information for a Synergy index.
additionalProperties: false
required:
- IndexName
- IndexType
properties:
IndexName:
type: string
description: |-
The name of the index, as defined in Synergy.
This will be used in the index assignment.
maxLength: 80
minLength: 1
example: ACCOUNT NUMBER
IndexType:
type: string
description: |-
The Synergy data type for the given index.
Note that all index assignments should be provided as
string values, regardless of the underlying type.
maxLength: 20
minLength: 1
example: Numeric
IsMultiValue:
type: boolean
description: |-
If true, this index supports multiple assigned values.
Otherwise, only a single value can be specified for each
index assignment.
example: false
Length:
type: integer
description: The maximum value length for the index.
format: int32
example: 10
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItemsSearchRequest:
allOf:
- type: object
description: >-
Properties common to both PredefinedSearchJob (v1.0) and
OpenSearchJob (v2.1)
additionalProperties: false
required:
- SearchClauses
properties:
SearchClauses:
type: array
description: >-
An array of index names, values, and comparison operators by
which to constrain the results.
maxItems: 100
minItems: 1
items:
allOf:
- type: object
description: An index name along with its associated value.
additionalProperties: false
required:
- IndexName
properties:
IndexName:
type: string
description: The name of the index, as defined in Synergy.
maxLength: 80
minLength: 1
example: ACCOUNT NUMBER
IndexValue:
type: string
description: >-
An index value assignment for the document.
If the index is defined as multi-value in Synergy,
there may be multiple
index mapping objects with the same index name, but
each with different values.
maxLength: 1024
minLength: 0
nullable: true
example: 11223344
- type: object
description: Index, value and comparison operator.
additionalProperties: false
required:
- Operator
properties:
Operator:
description: Comparison operator.
example: eq
allOf:
- type: string
description: Comparison operators for a SearchClause.
x-enumNames:
- eq
- neq
- lt
- lte
- gt
- gte
- in
- con
enum:
- eq
- neq
- lt
- lte
- gt
- gte
- in
- con
OpenVocabularyName:
type: string
description: |-
The optional name of a Synergy Open Vocabulary mapping.
If provided, the mapping will be used to map user defined
cab, type, and index names to Synergy defined names.
maxLength: 80
minLength: 0
nullable: true
example: Custom Vocab
CabinetNames:
type: array
description: >-
A verbatim array of document cabinet and/or report
applications.
Only items with an exact cabinet/application match from this
array will be searched.
maxItems: 100
nullable: true
items:
type: string
maxLength: 80
ForceAsync:
type: boolean
description: >-
If `True`, this will force the search to be started
asynchronously and return a search id
that can be used in subsequent calls to get the search status,
search results, and to delete
the search.
If this property is `False` (the default), then Synergy will
attempt to return search
results with this response, assuming the search completes
quickly with a few number of hits.
In this case, no search id is returned, because no asynchronous
search resource is created.
If the search exceeds the time or count thresholds (30 seconds,
200 hits), the
search will become asynchronous, and a search id will be
returned, just as if this property
had been set to `True`.
- type: object
description: Open Search Criteria
additionalProperties: false
properties:
PredefinedSearchName:
type: string
description: >-
The search operation can be executed as a "Predefined Search" or
as
an "Open Search". If this property is populated, the specified
predefined search will
be executed and any properties in this object that are not
compatible with a
predefined search will be ignored.
maxLength: 100
minLength: 0
nullable: true
example: Signature Card Search
SortIndexName:
type: string
description: |-
The index used to sort search results.
If this property is not specified, the first index specified in
`SearchClauses` will be used.
maxLength: 80
minLength: 0
nullable: true
example: ACCOUNT NUMBER
Modules:
type: array
description: >-
One or more Synergy modules with which to constraint the
results.
If no module is specified, all accessible modules are assumed.
*This property is not used for a predefined search.*
maxItems: 3
nullable: true
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
TypeNames:
type: array
description: >-
A verbatim array of document type and/or report names.
Only items with an exact type/report match from this array will
be searched.
*This property is not used for a predefined search.*
maxItems: 100
nullable: true
items:
type: string
maxLength: 80
SynergyInstitutionNames:
type: array
description: |-
Synergy institution names for which to constrain the search.
*This property is not used for a predefined search.*
maxItems: 100
nullable: true
items:
type: string
maxLength: 20
HitListViewName:
type: string
description: |-
Hit list view that will determine index information returned.
*This property is not used for a predefined search.*
maxLength: 80
minLength: 0
nullable: true
ReportDatesFrom:
type: string
description: >-
The inclusive lower bound for report loaded (processed) dates.
If not specified, there is no lower bound date constraint for
report searches.
This property will only constrain items in the `Report` module.
*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.
If not specified, there is no upper bound date constraint for
report searches.
This property will only constrain items in the `Report` module.
*This property is not used for a predefined search.*
format: date-time
nullable: true
example: '2022-05-19'
RetrievalItemsSearchResponse:
allOf:
- type: object
description: 'The result of either a StartSearch or GetSearchResults operation. '
additionalProperties: false
required:
- IsSearchComplete
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
contains properties of the matching items.
Results:
type: array
description: An array of search results.
nullable: true
items:
allOf:
- type: object
description: Synergy Classifier properties.
additionalProperties: false
properties:
CabinetName:
type: string
description: >-
A cabinet name under which the document should be
classified.
This name must be defined in Synergy and be accessible
by your account for storage purposes.
Note that this property is also used by the `Report`
module for the Application name.
Example: "LOANS"
maxLength: 80
minLength: 0
example: LOANS
TypeName:
type: string
description: >-
A document type name under which the document should
be classified.
This name must be defined in Synergy, must be mapped
to the specified cabinet name,
and be accessible by your account for storage
purposes.
Note that this property is also used by the `Report`
module for the Report name.
maxLength: 80
minLength: 0
example: AUTO APPLICATION
SynergyInstitutionName:
type: string
description: >-
The institution name that the document should be
assigned to.
This name must be defined in Synergy and be accessible
by your account for storage purposes.
If this property is not provided, Synergy will attempt
to determine it, if possible.
maxLength: 20
minLength: 0
nullable: true
example: '01'
- type: object
description: >-
Information common to both item search results an item
info inquiry.
additionalProperties: false
required:
- UniqueItemId
- Module
- Indexes
- DocumentDate
- ViewAuthority
- HasCropZone
- Restrictions
properties:
UniqueItemId:
type: string
description: >-
The unique item id for a document or report.
This is a resource id that can be used in other API
calls.
minLength: 1
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417
Module:
type: string
description: >-
The Synergy module from which the document or report
is stored.
minLength: 1
example: Document
Indexes:
type: array
description: >-
The index names and values associated with the
document.
maxItems: 100
minItems: 1
items:
type: object
description: An index name along with its associated value.
additionalProperties: false
required:
- IndexName
properties:
IndexName:
type: string
description: The name of the index, as defined in Synergy.
maxLength: 80
minLength: 1
example: ACCOUNT NUMBER
IndexValue:
type: string
description: >-
An index value assignment for the document.
If the index is defined as multi-value in
Synergy, there may be multiple
index mapping objects with the same index name,
but each with different values.
maxLength: 1024
minLength: 0
nullable: true
example: 11223344
DocumentDate:
type: string
description: >-
For documents, this is the UTC creation date/time, for
reports, this is the loaded date.
format: date-time
minLength: 1
ViewAuthority:
type: string
description: >-
This is a string representation of the view
authorities required to be able
to view the document.
minLength: 1
HasCropZone:
type: boolean
description: >-
If true, the document has a crop zone defined that can
be retrieved in lieu of
the entire document page(s).
Restrictions:
type: string
description: Access restrictions.
minLength: 1
DocumentInfo:
description: >-
This information is only provided with the item
belongs to the `Document` or `Check` module.
nullable: true
allOf:
- type: object
description: Info specific to items in the document module.
additionalProperties: false
required:
- DocumentName
- ModificationDate
- CheckReturnReason
properties:
LegacyDocumentId:
type: integer
description: >-
Legacy Synergy document id, for informational
purposes.
format: int32
DocumentName:
type: string
description: >-
The document's friendly name. This may be the
same as the document's type
name if it was not overridden.
maxLength: 80
minLength: 0
example: Test Document
ModificationDate:
type: string
description: >-
The UTC date and time of the last
modification.
format: date-time
minLength: 1
CheckReturnReason:
type: string
description: >-
The reason a check has been returned. Will be
"None" if not a returned check.
maxLength: 50
minLength: 0
ReportInfo:
description: >-
This information is only provided when the item
belongs to the `Report` module.
nullable: true
allOf:
- type: object
description: Info specific to items in the report module.
additionalProperties: false
required:
- ReportName
- HasStatements
- DateGroup
properties:
ReportName:
type: string
description: >-
The report's friendly name. It is a
conglomeration
of the report's primary classification
attributes.
maxLength: 128
minLength: 0
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:
type: string
description: >-
The report date group. This is typically a 6
digit date, but may also contain text.
minLength: 1
example: 31398
HitPage:
description: >-
Location information (if any) regarding a
search result.
nullable: true
allOf:
- type: object
description: JSON Schema HitPageInfo
additionalProperties: false
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
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItems-SearchInquireResponse:
allOf:
- type: object
description: Result of a search status call.
additionalProperties: false
required:
- SearchId
- IsSearchComplete
- IsCanceled
properties:
SearchId:
type: string
description: >-
The id of the asynchronous search, for which this request was
issued.
minLength: 1
IsSearchComplete:
type: boolean
description: >-
If `True`, the search has completed, and the `ResultCount`
property
contains the number of matches.
TotalResultCount:
type: integer
description: >-
The number of search matches. This property will not be
available
until `IsSearchComplete` is `True`.
format: int32
nullable: true
IsCanceled:
type: boolean
description: The search was canceled by the caller.
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItems-SearchResultsListResponse:
allOf:
- type: object
description: 'The result of either a StartSearch or GetSearchResults operation. '
additionalProperties: false
required:
- IsSearchComplete
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
contains properties of the matching items.
Results:
type: array
description: An array of search results.
nullable: true
items:
allOf:
- type: object
description: Synergy Classifier properties.
additionalProperties: false
properties:
CabinetName:
type: string
description: >-
A cabinet name under which the document should be
classified.
This name must be defined in Synergy and be accessible
by your account for storage purposes.
Note that this property is also used by the `Report`
module for the Application name.
Example: "LOANS"
maxLength: 80
minLength: 0
example: LOANS
TypeName:
type: string
description: >-
A document type name under which the document should
be classified.
This name must be defined in Synergy, must be mapped
to the specified cabinet name,
and be accessible by your account for storage
purposes.
Note that this property is also used by the `Report`
module for the Report name.
maxLength: 80
minLength: 0
example: AUTO APPLICATION
SynergyInstitutionName:
type: string
description: >-
The institution name that the document should be
assigned to.
This name must be defined in Synergy and be accessible
by your account for storage purposes.
If this property is not provided, Synergy will attempt
to determine it, if possible.
maxLength: 20
minLength: 0
nullable: true
example: '01'
- type: object
description: >-
Information common to both item search results an item
info inquiry.
additionalProperties: false
required:
- UniqueItemId
- Module
- Indexes
- DocumentDate
- ViewAuthority
- HasCropZone
- Restrictions
properties:
UniqueItemId:
type: string
description: >-
The unique item id for a document or report.
This is a resource id that can be used in other API
calls.
minLength: 1
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417
Module:
type: string
description: >-
The Synergy module from which the document or report
is stored.
minLength: 1
example: Document
Indexes:
type: array
description: >-
The index names and values associated with the
document.
maxItems: 100
minItems: 1
items:
type: object
description: An index name along with its associated value.
additionalProperties: false
required:
- IndexName
properties:
IndexName:
type: string
description: The name of the index, as defined in Synergy.
maxLength: 80
minLength: 1
example: ACCOUNT NUMBER
IndexValue:
type: string
description: >-
An index value assignment for the document.
If the index is defined as multi-value in
Synergy, there may be multiple
index mapping objects with the same index name,
but each with different values.
maxLength: 1024
minLength: 0
nullable: true
example: 11223344
DocumentDate:
type: string
description: >-
For documents, this is the UTC creation date/time, for
reports, this is the loaded date.
format: date-time
minLength: 1
ViewAuthority:
type: string
description: >-
This is a string representation of the view
authorities required to be able
to view the document.
minLength: 1
HasCropZone:
type: boolean
description: >-
If true, the document has a crop zone defined that can
be retrieved in lieu of
the entire document page(s).
Restrictions:
type: string
description: Access restrictions.
minLength: 1
DocumentInfo:
description: >-
This information is only provided with the item
belongs to the `Document` or `Check` module.
nullable: true
allOf:
- type: object
description: Info specific to items in the document module.
additionalProperties: false
required:
- DocumentName
- ModificationDate
- CheckReturnReason
properties:
LegacyDocumentId:
type: integer
description: >-
Legacy Synergy document id, for informational
purposes.
format: int32
DocumentName:
type: string
description: >-
The document's friendly name. This may be the
same as the document's type
name if it was not overridden.
maxLength: 80
minLength: 0
example: Test Document
ModificationDate:
type: string
description: >-
The UTC date and time of the last
modification.
format: date-time
minLength: 1
CheckReturnReason:
type: string
description: >-
The reason a check has been returned. Will be
"None" if not a returned check.
maxLength: 50
minLength: 0
ReportInfo:
description: >-
This information is only provided when the item
belongs to the `Report` module.
nullable: true
allOf:
- type: object
description: Info specific to items in the report module.
additionalProperties: false
required:
- ReportName
- HasStatements
- DateGroup
properties:
ReportName:
type: string
description: >-
The report's friendly name. It is a
conglomeration
of the report's primary classification
attributes.
maxLength: 128
minLength: 0
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:
type: string
description: >-
The report date group. This is typically a 6
digit date, but may also contain text.
minLength: 1
example: 31398
HitPage:
description: >-
Location information (if any) regarding a
search result.
nullable: true
allOf:
- type: object
description: JSON Schema HitPageInfo
additionalProperties: false
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
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItemsInquireResponse:
allOf:
- allOf:
- allOf:
- type: object
description: Synergy Classifier properties.
additionalProperties: false
properties:
CabinetName:
type: string
description: >-
A cabinet name under which the document should be
classified.
This name must be defined in Synergy and be accessible
by your account for storage purposes.
Note that this property is also used by the `Report`
module for the Application name.
Example: "LOANS"
maxLength: 80
minLength: 0
example: LOANS
TypeName:
type: string
description: >-
A document type name under which the document should be
classified.
This name must be defined in Synergy, must be mapped to
the specified cabinet name,
and be accessible by your account for storage purposes.
Note that this property is also used by the `Report`
module for the Report name.
maxLength: 80
minLength: 0
example: AUTO APPLICATION
SynergyInstitutionName:
type: string
description: >-
The institution name that the document should be
assigned to.
This name must be defined in Synergy and be accessible
by your account for storage purposes.
If this property is not provided, Synergy will attempt
to determine it, if possible.
maxLength: 20
minLength: 0
nullable: true
example: '01'
- type: object
description: >-
Information common to both item search results an item info
inquiry.
additionalProperties: false
required:
- UniqueItemId
- Module
- Indexes
- DocumentDate
- ViewAuthority
- HasCropZone
- Restrictions
properties:
UniqueItemId:
type: string
description: >-
The unique item id for a document or report.
This is a resource id that can be used in other API
calls.
minLength: 1
example: >-
1|1|11d01e33-48b2-e911-b1f2-34f39a77db65|d73da8b1-9dfc-ec11-a292-3cf011584417
Module:
type: string
description: >-
The Synergy module from which the document or report is
stored.
minLength: 1
example: Document
Indexes:
type: array
description: The index names and values associated with the document.
maxItems: 100
minItems: 1
items:
type: object
description: An index name along with its associated value.
additionalProperties: false
required:
- IndexName
properties:
IndexName:
type: string
description: The name of the index, as defined in Synergy.
maxLength: 80
minLength: 1
example: ACCOUNT NUMBER
IndexValue:
type: string
description: >-
An index value assignment for the document.
If the index is defined as multi-value in Synergy,
there may be multiple
index mapping objects with the same index name,
but each with different values.
maxLength: 1024
minLength: 0
nullable: true
example: 11223344
DocumentDate:
type: string
description: >-
For documents, this is the UTC creation date/time, for
reports, this is the loaded date.
format: date-time
minLength: 1
ViewAuthority:
type: string
description: >-
This is a string representation of the view authorities
required to be able
to view the document.
minLength: 1
HasCropZone:
type: boolean
description: >-
If true, the document has a crop zone defined that can
be retrieved in lieu of
the entire document page(s).
Restrictions:
type: string
description: Access restrictions.
minLength: 1
DocumentInfo:
description: >-
This information is only provided with the item belongs
to the `Document` or `Check` module.
nullable: true
allOf:
- type: object
description: Info specific to items in the document module.
additionalProperties: false
required:
- DocumentName
- ModificationDate
- CheckReturnReason
properties:
LegacyDocumentId:
type: integer
description: >-
Legacy Synergy document id, for informational
purposes.
format: int32
DocumentName:
type: string
description: >-
The document's friendly name. This may be the
same as the document's type
name if it was not overridden.
maxLength: 80
minLength: 0
example: Test Document
ModificationDate:
type: string
description: The UTC date and time of the last modification.
format: date-time
minLength: 1
CheckReturnReason:
type: string
description: >-
The reason a check has been returned. Will be
"None" if not a returned check.
maxLength: 50
minLength: 0
ReportInfo:
description: >-
This information is only provided when the item belongs
to the `Report` module.
nullable: true
allOf:
- type: object
description: Info specific to items in the report module.
additionalProperties: false
required:
- ReportName
- HasStatements
- DateGroup
properties:
ReportName:
type: string
description: >-
The report's friendly name. It is a
conglomeration
of the report's primary classification
attributes.
maxLength: 128
minLength: 0
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:
type: string
description: >-
The report date group. This is typically a 6
digit date, but may also contain text.
minLength: 1
example: 31398
HitPage:
description: >-
Location information (if any) regarding a search
result.
nullable: true
allOf:
- type: object
description: JSON Schema HitPageInfo
additionalProperties: false
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
- type: object
description: Information about an document or report stored in Synergy.
additionalProperties: false
required:
- PageCount
- Files
properties:
PageCount:
type: integer
description: The total page count for the document.
format: int32
example: 3
Files:
type: array
description: >-
An array of information about the file from which the
document is composed.
items:
type: object
description: >-
Information about a specific file in a Synergy document or
report.
additionalProperties: false
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.
example: pdf
SubPageCount:
type: integer
description: The number of pages in *this* file.
format: int32
example: 3
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItemsTextnotesListResponse:
allOf:
- type: object
description: Response body schema for enumerating text note information.
additionalProperties: false
properties:
TextNotes:
type: array
description: An array of text notes.
items:
type: object
description: Note properties returned when listing notes.
additionalProperties: false
properties:
TextNoteId:
type: integer
description: Note Id
format: int32
NoteName:
type: string
description: The note's descriptive name (title).
maxLength: 40
minLength: 0
IsClassified:
type: boolean
description: >-
If true, the "Classified Notes" authority is required to
view the note content. Default: false.
NoteType:
description: Note's type (document, page, cabinet, type)
allOf:
- type: string
description: Enum of Text Note Types.
x-enumNames:
- ApplicationOrCabinetNote
- ReportOrTypeNote
- PageOrDocument
enum:
- ApplicationOrCabinetNote
- ReportOrTypeNote
- PageOrDocument
Owner:
type: string
description: Note's creator.
maxLength: 255
minLength: 0
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.
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItemsTextnotesCreateRequest:
allOf:
- type: object
description: Note properties used when creating a note.
additionalProperties: false
required:
- NoteName
- NoteText
properties:
NoteName:
type: string
description: The note's descriptive name (title).
maxLength: 40
minLength: 0
NoteText:
type: string
description: The contents of the text note.
maxLength: 2048
minLength: 0
IsClassified:
type: boolean
description: >-
If true, the "Classified Notes" authority is required to view
the note content. Default: false.
NoteKey:
type: string
description: If specified, the note content will be password protected.
maxLength: 64
minLength: 0
nullable: true
RetrievalItemsTextnotesCreateResponse:
allOf:
- type: object
description: Note identifier.
additionalProperties: false
properties:
TextNoteId:
type: integer
description: Note Id
format: int32
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItemsTextnotesInquireResponse:
allOf:
- allOf:
- type: object
description: Note properties returned when listing notes.
additionalProperties: false
properties:
TextNoteId:
type: integer
description: Note Id
format: int32
NoteName:
type: string
description: The note's descriptive name (title).
maxLength: 40
minLength: 0
IsClassified:
type: boolean
description: >-
If true, the "Classified Notes" authority is required to
view the note content. Default: false.
NoteType:
description: Note's type (document, page, cabinet, type)
allOf:
- type: string
description: Enum of Text Note Types.
x-enumNames:
- ApplicationOrCabinetNote
- ReportOrTypeNote
- PageOrDocument
enum:
- ApplicationOrCabinetNote
- ReportOrTypeNote
- PageOrDocument
Owner:
type: string
description: Note's creator.
maxLength: 255
minLength: 0
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.
- type: object
description: Note properties returned when 'inquiring' a note.
additionalProperties: false
properties:
NoteText:
type: string
description: The contents of the text note.
maxLength: 2048
minLength: 0
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItemsTextnotesUpdateRequest:
allOf:
- type: object
description: Note properties used when updating a note.
additionalProperties: false
properties:
NoteName:
type: string
description: |-
The note's descriptive name (title).
Omit or specify null to leave the value unchanged.
maxLength: 40
minLength: 0
nullable: true
NoteText:
type: string
description: |-
The contents of the text note.
Omit or specify null to leave the value unchanged.
maxLength: 2048
minLength: 0
nullable: true
IsClassified:
type: boolean
description: >-
If true, the "Classified Notes" authority is required to view
the note content. Default: false.
Omit or specify null to leave the value unchanged.
nullable: true
NoteKey:
type: string
description: |-
If specified, the note content will be password protected.
Omit or specify null to leave the value unchanged.
maxLength: 64
minLength: 0
nullable: true
RetrievalItemsTextnotesUpdateResponse:
allOf:
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalItemsTextnotesDeleteResponse:
allOf:
- type: object
description: Note identifier.
additionalProperties: false
properties:
TextNoteId:
type: integer
description: Note Id
format: int32
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalPredefinedsearchesListResponse:
allOf:
- type: object
description: Predefined Search Array Result
additionalProperties: false
properties:
PredefinedSearches:
type: array
description: An array of predefined search info objects.
items:
type: object
description: Predefined Search Properties
additionalProperties: false
required:
- PredefinedSearchId
properties:
PredefinedSearchId:
type: string
description: The predefined search id.
minLength: 1
PredefinedSearchName:
type: string
description: The predefined search name.
FileRoomName:
type: string
description: The fileroom the predefined search is for.
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalPredefinedsearchesInquireResponse:
allOf:
- type: object
description: Predefined Search Properties
additionalProperties: false
properties:
PredefinedSearchName:
type: string
description: The predefined search name.
maxLength: 100
minLength: 0
PredefinedSearchId:
type: string
description: The predefined search Id.
maxLength: 100
minLength: 0
SearchGroups:
type: array
description: The predefined search groups.
maxItems: 100
items:
type: object
description: Predefined Search Group.
additionalProperties: false
properties:
GroupId:
type: integer
description: 1-based group Id.
format: int32
Modules:
type: array
description: Module.
maxItems: 10
nullable: true
items:
type: string
description: JSON schema for SynergyModules
x-enumFlags: true
x-enumNames:
- Document
- Report
- Check
- All
enum:
- Document
- Report
- Check
- All
CabinetNames:
type: array
description: Cabinet Names.
maxItems: 100
nullable: true
items:
type: string
maxLength: 80
CabinetNameFragment:
type: string
description: Cabinet Fragment.
maxLength: 100
minLength: 0
nullable: true
Indexes:
type: array
description: Indexes.
maxItems: 100
nullable: true
items:
type: object
description: Predefined Search Index.
additionalProperties: false
properties:
IndexName:
type: string
description: Index name.
maxLength: 100
minLength: 0
nullable: true
Operator:
type: string
description: Index operator.
maxLength: 32
minLength: 0
nullable: true
IsLocked:
type: boolean
description: Is index locked.
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
RetrievalReportsSearchRequest:
allOf:
- type: object
description: Find Reports Criteria
additionalProperties: false
properties:
SynergyInstitutionNames:
type: array
description: Synergy institution names for which to constrain the search.
maxItems: 100
nullable: true
items:
type: string
maxLength: 20
ApplicationNames:
type: array
description: Application names for which to constrain the search.
maxItems: 100
nullable: true
items:
type: string
maxLength: 4
ReportNames:
type: array
description: Report names for which to constrain the search.
maxItems: 100
nullable: true
items:
type: string
maxLength: 80
ReportDatesFrom:
type: string
description: >-
The inclusive lower bound for report loaded (processed) dates.
If 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.
If not specified, there is no upper bound date constraint for
report searches.
format: date-time
nullable: true
example: '2022-05-19'
RetrievalReportsSearchResponse:
allOf:
- type: object
description: Find Reports Result
additionalProperties: false
properties:
Reports:
type: array
description: An array of reports.
items:
type: object
description: Find Reports Information for a Specific Report
additionalProperties: false
properties:
UniqueItemId:
type: string
description: The unique item id for the report.
SynergyInstitutionName:
type: string
description: Synergy institution name.
ApplicationName:
type: string
description: Application name.
ReportName:
type: string
description: Report name.
ReportDate:
type: string
description: The report loaded date.
format: date-time
Paging:
description: Paging information about the result set.
nullable: true
allOf:
- type: object
description: Paging information.
additionalProperties: false
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
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
ProblemDetailsResponse:
allOf:
- type: object
properties:
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
MessageSource:
description: >-
The source of the response to a message. This would
represent the service provider that carry out the business
service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category
assigned to a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human
readable format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element
will contain the element which is causing the
condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element
will contain the value of the element which is causing
the condition
type: string
Location:
description: >-
This is typically the program that generated the
status condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: >-
The key related to a log entry specific to the log
store
type: string
MessageStatus:
type: object
description: '`MessageStatus` is required/expected for non 2xx responses.'
properties:
ResponseCode:
description: The code related to message responses
type: string
Description:
description: >-
The description related to the status code in a human readable
format
type: string
MessageSource:
description: >-
The source of the response to a message. This would represent the
service provider that carry out the business service for the message
type: string
MessageSourceResponse:
type: object
additionalProperties: true
Details:
description: The array of details as related to a fault response code
type: array
items:
type: object
properties:
Code:
description: The code assigned to a providers statuses
type: string
Category:
description: >-
ENUM[Error,Fault,Warning,Overridden] The category assigned to
a providers message statuses
type: string
Description:
description: >-
The description related to the status code in a human readable
format
type: string
Element:
description: >-
When an Error or Fault occurs this optional element will
contain the element which is causing the condition
type: string
ElementValue:
description: >-
When an Error or Fault occurs this optional element will
contain the value of the element which is causing the
condition
type: string
Location:
description: >-
This is typically the program that generated the status
condition
type: string
Logs:
description: The array of logs as related to a response code
type: array
items:
type: object
properties:
Store:
description: The store that retains log entries
type: string
Key:
description: The key related to a log entry specific to the log store
type: string
x-jh:
publishing:
type: Integration
stage: prod
isPublic: true
group: Synergy
name: Document Retrieval
docURL: https://jkhy.github.io/synergyintegration
Have a Question?
Have a how-to question? Seeing a weird error? Get help on
StackOverflow.
Register for the Digital Toolkit Meetup
where we answer technical Q&A from the audience.
Last updated Wed Aug 7 2024