Type Alias PatchTwinDocumentRequest

PatchTwinDocumentRequest: {
    data?: Record<string, unknown>;
    documentName: string;
    region?: Region;
    twinId: string;
    version?: number;
}

Type declaration

  • Optionaldata?: Record<string, unknown>

    A json data that will be applied on the document's current data. Patching rules: The patch goes recursively through the patch objects. If the patch object property is null, it is removed from the final object. If the patch object property is a value (number, strings, bool, arrays), it is replaced. If the patch object property is an object, the previous rules will be applied recursively on it.

  • documentName: string

    Name of the document.

  • Optionalregion?: Region

    Region to target. If none is passed will use default region from the config.

  • twinId: string

    Twin ID.

  • Optionalversion?: number

    If set, ensures that the current version of the document matches before persisting the update.

Settings