Permissions

If the payload returned from the custom command contains resourceId or resourceIds fields, these fields are used to perform the authorization check before event delivery (as with normal commands). Otherwise, the server uses only the collectionUrn to perform the authorization check.

Defined Entity Event Types

To specify a type of event to subscribe to, you need to know the full name of the event type for that event. The table below lists all the event types for the different entities that emit events. All combinations of entity types are typically supported.

The table shows the name and version of the corresponding event. To get the full type name for use in the Subscribe API call, prefix the name in the table below with autodesk.data.assetgraph:. For example, autodesk.data.assetgraph:events.asset.created-1.0.0.

Data Fields

Most non-command event types share the same field definitions. They have the Command Data Object fields listed above, in addition to the fields in the table that follows.

Created and Updated Event Payloads

{
    "commandid" : <commandid>,
    "acescopeurn" : <aceScopeURN>,
    "collectionurn": <CollectionURN>,
    "entitytype" : <EntityType>,
    "attributes": [
        {..}, {..}
    ],
    "components": [
        {..}, {..}
    ]
}

{
    "commandid" : <commandid>,
    "acescopeurn" : <aceScopeURN>,
    "collectionurn": <CollectionURN>,
    "entitytype" : <EntityType>,
    "spaceid": <SpaceId>,
    "attributes": [
        {..}, {..}
    ],
    "components": [
        {..}, {..}
    ]
}

{
    "commandid" : <commandid>,
    "acescopeurn" : <aceScopeURN>,
    "collectionurn": <CollectionURN>,
    "entitytype" : <EntityType>,
    "category": "Relationship",
    "ispinned": true,
    "attributes": [
        {..}, {..}
    ],
    "components": [
        {..}, {..}
    ]
}

    "commandid" : <commandid>,
    "acescopeurn" : <aceScopeURN>,
    "collectionurn": <CollectionURN>,
    "entitytype" : <EntityType>,
    "modificationtype": <ModificationType>,
    "attributes": [
        {..}, {..}
    ],
    "components": [
        {..}, {..}
    ],
    "assetIds"; ["assetId1", "assetId2"],
    "relationshipIds"; ["relaionshipId1", "relationshipId2"]
}

Deleted, Purged, and Restored Event Payloads

General events for deleted,` purged`, and restored events return a payload with the following schema.

{
    "commandid" : <commandid>,
    "acescopeurn" : <aceScopeURN>,
    "collectionurn": <CollectionURN>
}

Explicit Events

Deletion events require special consideration for events. The Data Events Service only supports explicit deletion. For example, a space.deleted event implies that all the assets in that space are marked for deletion. Forge Events does not auto-generate asset.deleted events for the (potentially huge) number of assets in the space. The same is true for collecion.deleted and spaces, and also applies to relationship.deleted events and their associated From asset. Clients might need to subscribe to higher-level parent or associated asset deletion events in order to correctly understand the lifetime of all Data Model entity types using the Data Events Service.

Event Subject

The event subject (as defined by the CloudEvent Spec) can only have a single value. Commands are often often about multiple entities (for example, commands such as CopyAssetBatch). The event subject cannot be about all the entities affected by the command. The event subject is just a URN representation of the commandId.

Data Fields

The following table lists field definitions for command event types.

CommandResult

The following table describes the fields of a type definition for the resultpayload field.

These are the accommodations for result payloads for custom commands.

ResultPayload Contents

The resultPayload for custom events is defined by the service that implements the command. If the payload returned from the custom command contains the resourceId(s) and resourceType(s) fields at the top level (as do non-custom commands), the resultPayload field of the event contains the full payload returned from the custom command. If it does not contain the resourceId(s) and resourceType(s) fields, then the resultPayload is empty.

Permissions

If the payload returned from the custom command contains resourceId or resourceIds fields, these fields are used to perform the authorization check before event delivery (as with normal commands). Otherwise, the server uses only the collectionUrn to perform the authorization check.

The following is a sample data field payload from the command.completed event.

{
    "commandid" <CommandId>,
    "commandtype": "Create<Entity>Command",
    "collectionurn": <CollectionURN>,
    "status": "SUCCESS",
    "isbatch": false,
    "resultpayload" : {
       "resourceIds" : ["co.Ic6p9JSuTM-ZUl8wKTLbsw"],
       "resourceUrns" : ["/collections/co.Ic6p9JSuTM-ZUl8wKTLbsw"],
       "revisionId" : "TWgcZd2NV8sfPDRiUcW5uG",
       "resourceTypes: ["collection"]
    }
}

The following is a sample data field payload from the command.failed event.

{
    "commandid" <CommandId>,
    "commandtype": "Create<Entity>Command",
    "collectionurn": <CollectionURN>,
    "status": "NOT_PROCESSED",
    "isbatch": false,
    "resultpayload" : {
       "resourceIds" : ["co.Ic6p9JSuTM-ZUl8wKTLbsw"],
       "resourceUrns" : ["/collections/co.Ic6p9JSuTM-ZUl8wKTLbsw"],
       "revisionId" : "TWgcZd2NV8sfPDRiUcW5uG",
       "resourceTypes: ["collection"]
    }
}