action cdcgov_get_settings_organizations_organization_name_receivers { label: "get_settings_organizations_organizationName_receivers" description: "A list of receivers and their current settings" provider: cdcgov method: GET path: "/settings/organizations/{organizationName}/receivers" encoding: json input: { type: "object" properties: { organizationName: { type: "string" } } required: ["organizationName"] additionalProperties: false } output: { type: "array" items: { type: "object" description: "A receiver of reports from the data hub" required: ["name", "description", "topic", "jurisdictionalFilter", "reportConfiguations", "timing"] properties: { description: { type: "string" description: "Display ready description of the receiver" } jurisdictionalFilters: { type: "array" description: "What items to include in the report." required: ["matchFields"] items: { type: "object" description: "A single filter" properties: { doesNotMatch: { type: "boolean" description: "Ensure that the result does not match" } matchFields: { type: "string" description: "What fields to match in the filter" enum: ["FACILITY_OR_PATIENT_ADDRESS", "FACILITY_ADDRESS", "FACILITY_NAME", "ABNORMAL_VALUE"] } matchValues: { type: "array" description: "What is the value to match against" items: { type: "string" } } } } } meta: { type: "object" description: "The metadata associated with an setting" properties: { createdAt: { type: "string" format: "time-date" description: "the time that the particular revision was created" } createdBy: { type: "string" description: "the user who created the particular revision" } version: { type: "number" description: "the version number of the object" } } } name: { type: "string" description: "The unique name for the receiver. Should include the organization name as a prefix." } organizationName: { type: "string" description: "The name of the organization that this receiver belongs to" } timing: { type: "object" description: "When the report is sent if not immediately" required: ["frequency"] properties: { dailyAt: { type: "number" description: "The UTC hour to send a daily batch" } frequency: { type: "string" description: "How often send a report" enum: ["REAL_TIME", "HOURLY", "DAILY"] } } } topic: { type: "string" description: "The topic of for this receiver. Must match the supported topics." } translations: { type: "array" description: "How the report is translated from the sender. A report can be sent in multiple ways." items: { type: "object" } } } } } }