REST API - change

cdc change log: change event

Holds information about a single resource change that has been captured, e.g. resource creation/deletion or resource model update.

Representation:

JSON

{
    "resource" : {
        "id" : "obj-103",
        "type" : "string"
    },
    "kind" : "CREATE",
    "parent_resources" : [
        {
            "id" : "obj-103",
            "type" : "string"
        },
        {
            "id" : "obj-103",
            "type" : "string"
        }
    ],
    "properties" : [
        "string",
        "string"
    ]
}

Attributes:

Name	Type	Description
Required
resource	dynamic_ID	The identifier of the resource that has been changed.
resource.type	string	The type of resource being identified (for example `com.acme.Person`). Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.
resource.id	string	The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type. When clients pass a value of this structure as a parameter, the field `type` must contain the actual resource type. When operations return a value of this structure as a result, the field `type` will contain the actual resource type.
kind	string	The kind of the change that has occurred. Never `null` The kind of the change that occurred. Value is one of: CREATE: A new resource has been created. UPDATE: The resource state (model) has been updated DELETE: The resource has been deleted.
Optional
properties	string[]	The resoruce model's properties whose values changed, only in case of `UPDATE` change event. The field is unset in case of any other kind of change event, i.e. `CREATE` or `DELETE`. Each property could be either a single property name, in case of an immediate property of the resource model or a property path (chain) of property names, separated with `/` symbol to indicate a child property, e.g. `relatives/father`. Optional. Unset in case of CREATE or DELETE change kind.
parent_resources	dynamic_ID[]	Identifier of the parent resource(s), in case the changed resource is part of a hierarchy/inventory of resources and it cannot exist without its parent(s). In some domains, the resource may have more than one parent, hence the list of identifiers. The backend service that provides the change event may choose not to set this property in case that incurs significant overhead and there are no known use cases that will suffer from its omission. Optional. May be unset per backend service provider discretion.