--- title: "Update Data Reconciliation" method: PUT path: "/data-reconciliation/{id}" tags: ["Data Reconciliation"] --- # Update Data Reconciliation `PUT /data-reconciliation/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/data-reconciliation/{id}` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to update an existing Data Reconciliation ## Path parameters - `id` string, uuid, required ## Request body - object - `data` DataReconciliationUpdateSchema, required: Update schema for DataReconciliation model. Update - `name` string: What the reconciliation is called, as its alert names it. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `description` string: Why the two must agree, and what to do when they do not. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `intervalInMinutes` number: How often both sides are read and compared: every 15 minutes, hour, 6 hours or day. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `toleranceType` 'Absolute' | 'Percent': How the tolerance is read: Absolute, an amount, or Percent, of the source's value. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `tolerance` number: How far apart the two may be before they have drifted: 0 means they must agree exactly. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceDataAssetId` string, uuid: ID of the source table the reconciliation reads. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceMeasure` 'Row Count' | 'Sum' | 'Distinct Count' | 'Custom SQL': What is measured of the source table: Row Count, Sum, Distinct Count, or Custom SQL. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceColumnName` string: For Sum or Distinct Count: the column of the source table. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceCustomSql` string: For Custom SQL: a read-only query of the source's database returning one number, as value. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetDataAssetId` string, uuid: ID of the target table the reconciliation reads. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetMeasure` 'Row Count' | 'Sum' | 'Distinct Count' | 'Custom SQL': What is measured of the target table: Row Count, Sum, Distinct Count, or Custom SQL. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetColumnName` string: For Sum or Distinct Count: the column of the target table. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetCustomSql` string: For Custom SQL: a read-only query of the target's database returning one number, as value. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] ## Response `200` Updated successfully - object - `data` DataReconciliationReadSchema: Read schema for DataReconciliation model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `name` string, required: What the reconciliation is called, as its alert names it. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `description` string: Why the two must agree, and what to do when they do not. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `intervalInMinutes` number: How often both sides are read and compared: every 15 minutes, hour, 6 hours or day. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `toleranceType` 'Absolute' | 'Percent', required: How the tolerance is read: Absolute, an amount, or Percent, of the source's value. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `tolerance` number, required: How far apart the two may be before they have drifted: 0 means they must agree exactly. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceDataAssetId` string, uuid: ID of the source table the reconciliation reads. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceMeasure` 'Row Count' | 'Sum' | 'Distinct Count' | 'Custom SQL', required: What is measured of the source table: Row Count, Sum, Distinct Count, or Custom SQL. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceColumnName` string: For Sum or Distinct Count: the column of the source table. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceCustomSql` string: For Custom SQL: a read-only query of the source's database returning one number, as value. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `sourceDataCheckId` string, uuid: ID of the data check that reads the source, made and kept by the reconciliation. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `sourceValue` number: The source's value at the latest comparison. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `targetDataAssetId` string, uuid: ID of the target table the reconciliation reads. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetMeasure` 'Row Count' | 'Sum' | 'Distinct Count' | 'Custom SQL', required: What is measured of the target table: Row Count, Sum, Distinct Count, or Custom SQL. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetColumnName` string: For Sum or Distinct Count: the column of the target table. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetCustomSql` string: For Custom SQL: a read-only query of the target's database returning one number, as value. Permissions - Create: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [Project Owner, Project Admin, Project Member, Telemetry Admin, Telemetry Member, Edit Data Asset] - `targetDataCheckId` string, uuid: ID of the data check that reads the target, made and kept by the reconciliation. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `targetValue` number: The target's value at the latest comparison. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `difference` number: The target's value less the source's, at the latest comparison. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `differencePercent` number: The difference as a percentage of the source's value, at the latest comparison. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `status` 'In Step' | 'Drifted' | 'Waiting' | 'Failed': In Step, Drifted, Waiting for both sides to be read together, or Failed when a side's check could not run. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `statusMessage` string: Why the reconciliation is waiting or failed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `comparedAt` object: When the later of the two compared values was read. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `statusChangedAt` object: When the status last changed. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `monitorId` string, uuid: ID of the Metrics monitor that alerts when the two drift. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Data Asset], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)