record-status.schema.json

{
    "meta:license": [
        "Copyright 2022 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/mixins/record-status",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Record Status",
    "type": "object",
    "meta:intendedToExtend": [
        "https://ns.adobe.com/xdm/classes/account-person",
        "https://ns.adobe.com/xdm/context/account",
        "https://ns.adobe.com/xdm/classes/marketing-list-member",
        "https://ns.adobe.com/xdm/classes/marketing-list",
        "https://ns.adobe.com/xdm/classes/opportunity-person",
        "https://ns.adobe.com/xdm/context/opportunity"
    ],
    "description": "Used to provide a status for the igested record. Example, mark the isDeleted flag TRUE if the record is marked for deletion. This field group could also be used to add more record statuses in future.",
    "definitions": {
        "record-status": {
            "properties": {
                "xdm:isDeleted": {
                    "title": "Soft Delete Flag",
                    "description": "Soft delete flag to indicate if the record is marked for deletion.",
                    "type": "boolean",
                    "meta:titleId": "record-status##xdm:isDeleted##title##77601",
                    "meta:descriptionId": "record-status##xdm:isDeleted##description##95591"
                }
            }
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/record-status"
        }
    ],
    "meta:status": "stable",
    "meta:titleId": "record-status##title##68531",
    "meta:descriptionId": "record-status##description##57781",
    "examples": [
        {
            "xdm:isDeleted": true
        }
    ]
}