Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Parameter

Description

actions

An array of asset sync actions. See below

Configuration

If custom configuration is supplied. This is included in this property.

TenantId

Value controlled by KeyShot describing the tenant.

The actions are defined as follows

Parameter

Description

type

The sync type. Can be

  • sync

  • deleted

where sync covers both create and update. If the state is not null then the asset is tracked and hence the sync can be considered an update

asset

This is the full asset response object. See example in API documentation DC 5.10 Getting assets by Id

integrationState

This is a state managed by the integration. See description below

assetStateHash

This is a hash of the above state

assetId

The assetId of the asset being synced

TenantId

Value controlled by KeyShot describing the tenant.

The integrationState is an object controlled by the integration. For the KeyShot API it is just serialized into a json string and saved in the database. This state is then parsed along in the API request if the asset has already been synchronized before. This means that the integration it self controls what is in the state and it receives it on update to be used to determine what should happen with the asset.

...