Download Intake Item
Perform Download Intake Item through NikoHealth.
genhealth_download_intake_itemwrite
Inputs
- Source Type
source_typeselectrequiredRequired selected identifier or value.
Options: User Document ("user_doc"), Fax Inbox ("fax")
- Item
itemexpressionrequiredRequired literal value or workflow expression.
- Job Id
job_idexpressionOptional literal value or workflow expression.
- Workflow Id
workflow_idexpressionOptional literal value or workflow expression.
Outputs
successSuccessdocument_idDocument Idwas_existingWas ExistingdownloadedDownloadedskip_reasonSkip Reasonext_idExt IderrorError
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": [
"source_type",
"item"
],
"properties": {
"item": {
"description": "Required literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"job_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"source_type": {
"enum": [
"user_doc",
"fax"
],
"type": "string",
"description": "Required selected identifier or value.",
"x-workflow-field-type": "select"
},
"workflow_id": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"error": {},
"ext_id": {},
"success": {},
"downloaded": {},
"document_id": {},
"skip_reason": {},
"was_existing": {}
},
"additionalProperties": true
}