action cdcgov_post_reports { label: "Post a report to the data hub" provider: cdcgov method: POST path: "/reports" encoding: json input: { type: "object" properties: { client: { type: "string" } default: { type: "array" items: { type: "string" } } option: { type: "string" enum: ["ValidatePayload", "CheckConnections", "SendImmediately", "SkipSend", "SkipInvalidItems"] } routeTo: { type: "array" items: { type: "string" } } } required: ["client"] additionalProperties: false } output: { type: "object" required: ["id"] properties: { destinationCount: { type: "integer" description: "total destinations recieving the report(s)" } destinations: { type: "array" description: "where the report is being sent to" items: { type: "object" properties: { itemCount: { type: "integer" description: "The number of reports being sent to this destination" } organization: { type: "string" description: "The name of the organization reciving the report" } organization_id: { type: "string" description: "The organization id (i.e. {state abbreviation}-phd)" } sending_at: { type: "string" format: "date-time" description: "The time at which the report will be sent" } service: { type: "string" description: "The service used for delivering the report" } } } } errorCount: { type: "integer" description: "total errors found during initial validation. There may be multiple errors per item." } errors: { type: "array" description: "a list of errors in the report" items: { type: "object" properties: { detail: { type: "string" description: "The details of the error" } id: { type: "string" description: "Depends on scope, either the item's id (message_id) or the report's id" } scope: { type: "string" description: "Does the error apply to one item" enum: ["Parameter", "Report", "Item"] } } } } id: { type: "string" description: "the id for the report assigned by the Hub" } reportItemCount: { type: "integer" description: "total number of individual reports sent to the Hub (in a csv, the number of data lines sent)" } routing: { type: "array" description: "The receiver destination names for each item in the report. This is displayed when verbose=true is present on the query string." items: { type: "object" properties: { destinations: { type: "array" description: "The organization and service destinations" items: { type: "string" } } reportIndex: { type: "integer" description: "the index of the item in the submitted report (0 based)" } trackingId: { type: "string" description: "The tracking id provided by the sender defined in the schema, null otherwise" } } } } timestamp: { type: "string" format: "time-date" description: "the timestamp for this report submission" } topic: { type: "string" description: "the topic configured for the client organization sender" } warningCount: { type: "integer" description: "total warnings found during initial validation. There may be multiple warnings per item." } warnings: { type: "array" description: "a list of warnings in the report" items: { type: "object" additionalProperties: true } } } } }