1. Types
  2. cdc
  3. change log

cdc change log: change list

Contains a list of ordered resource change events that have been captured in response to a call to get_changes method.

Representation:

{
    "sequence" : "string",
    "changes" : [
        {
            "resource" : {
                "id" : "obj-103",
                "type" : "string"
            },
            "kind" : "CREATE",
            "parent_resources" : [
                {
                    "id" : "obj-103",
                    "type" : "string"
                },
                {
                    "id" : "obj-103",
                    "type" : "string"
                }
            ],
            "properties" : [
                "string",
                "string"
            ]
        },
        {
            "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
sequence string Tthe sequence token that must be used in a subsequent-call to get_changes method, in order to get the next set of changes. This value is opaque to the consumer and should not be parsed nor interpreted in any way.
changes[].resource dynamic_ID The identifier of the resource that has been changed.
changes[].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.
changes[].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.
changes[].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
changes change_event[] The change events that represent all changes that have occurred since the requested sequence token.

Optional. May be missing if no changes occurred.
changes[].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.