Download Document
Perform Download Document through Tomorrow Health.
tomorrow_health_download_documentwritetomorrow_health
Inputs
- Order Id
order_idexpressionrequiredRequired literal value or workflow expression.
- Document Id
document_idexpressionrequiredRequired literal value or workflow expression.
- Type
typeexpressionrequiredRequired literal value or workflow expression.
- Original File Name
original_file_nameexpressionOptional literal value or workflow expression.
- Supplier Id
supplier_idexpressionOptional literal value or workflow expression.
- Is Primary
is_primaryexpressionOptional literal value or workflow expression.
- Source Position
source_positionexpressionOptional literal value or workflow expression.
- Persist Hidden Document
persist_hidden_documentbooleanOptional true-or-false value.
Default:
true
Outputs
successSuccessraw_document_idRaw Document Iddocument_idDocument IdtypeTypetype_labelType Labelsupplier_idSupplier Idoriginal_file_nameOriginal File NamecreatedCreatederrorError
Output schema completeness: best_effort_declared
Safety
- External effect
- write
- Confirmation recommended
- No
- Retry safe
- No
- Dry run supported
- No
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"required": [
"order_id",
"document_id",
"type"
],
"properties": {
"type": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"order_id": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"is_primary": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"document_id": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"supplier_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"source_position": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"original_file_name": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"persist_hidden_document": {
"type": "boolean",
"default": true,
"description": "Optional true-or-false value.",
"x-workflow-field-type": "boolean"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"type": {},
"error": {},
"created": {},
"success": {},
"type_label": {},
"document_id": {},
"supplier_id": {},
"raw_document_id": {},
"original_file_name": {}
},
"additionalProperties": true
}