transactionIdstringrequired
Unique identifier assigned when the Order Entry transaction is created
Retrieves the attachment payload (documents, required documents and rules) for a transaction.
Returns documents, required documents, additional document types and document rules for the specified transaction.
get
Path Parameters
Response
application/json
Response
application/json
Returns the attachment payload
AttachmentResponse
* Additional properties are NOT allowed.
transactionIdstringrequired
The unique identifier for the transaction the attachment belongs to
>= 1 characters
caseIdstring | null
Case identifier associated with the transaction
dataobjectrequired
Attachment data containing documents, required documents and rules
* Additional properties are NOT allowed.
Show Child Parameters
get/market-connect/order-entry/v1/attachment/{transactionId}
Authentication
Path Parameters
application/json
Health
Health check operations
Returns a simple health status indicating the API process is running.
Returns a simple health status. No authentication required.
get
Response
200
Response
200
API is healthy
get/market-connect/order-entry/v1/health
Authentication
200
AdditionalDocumentType
object * Additional properties are NOT allowed.
attachmentTypearray[string]
List of attachment type codes
documentTypearray[string]
List of document type codes
formTypearray[string]
List of form type codes
Example
AttachmentData
object * Additional properties are NOT allowed.
additionalDocumentTypesarray[object]
List of additional document types that can be uploaded
* Additional properties are NOT allowed.
Show Child Parameters
documentRulesarray[object]
Conditional rules that determine required or optional documents
* Additional properties are NOT allowed.
Show Child Parameters
documentsarray[object]
Documents already uploaded for the transaction
* Additional properties are NOT allowed.
Show Child Parameters
requiredDocumentsarray[object]
Documents that are required for submission
* Additional properties are NOT allowed.
Show Child Parameters
Example