DSAssetUpdate
post
/ccadmin/v1/webhook/DSAssetUpdate
The Design Studio asset update details
Request
Supported Media Types
- application/json
The details returned when a Design Studio asset has been changed.
Root Schema : DSAssetUpdate_request
Type:
object
The details returned when a Design Studio asset has been changed.
Show Source
-
applicationId(optional):
string
ID of the OSF application that the asset changes were made on.
-
assetChangesList(optional):
object assetChangesList
-
locale(optional):
string
The default locale of the default site.
-
origin(optional):
string
How the asset changes were made. 1. UI - indicates a change made in the Design Studio UI. 2. API - indicates a change made via an endpoint call. 3. appDeployment - indicates the deployment of an OSF application. This will be accompanied by one or more webhook response(s), whose origin indicates the type of deployment that took place: - Standard deployment is indicated by the origin assetUpdateDeployWithoutReset. Any newly created assets will be listed. - deployment with the reset flag is indicated by one webhook response whose origin is assetDeletionDeployReset, and then another whose origin is assetCreationDeployReset. These represent the asset deletion and creation stages of a reset deploy - there is no need to list all deleted and created assets in this case
-
userId(optional):
string
ID of the user who made the asset changes.
Nested Schema : assetChangesList
Type:
Show Source
object
-
action(optional):
string
Describes the nature of the change to the asset - will be 0, 1 or 2 for update, delete or create respectively
-
actionDescription(optional):
string
Textual property describing the action performed on the asset. - If action = 0, actionDescription = assetUpdate - If action = 1, actionDescription = assetDelete - If action = 2, actionDescription = assetCreate
-
displayName(optional):
string
Display name of the changed asset
-
filename(optional):
string
Filename of the changed asset
-
itemDescriptor(optional):
string
The type of the changed asset
-
layoutRepositoryId(optional):
string
Layout repository ID of the changed asset. Note that this will be null unless the asset being changed is of type page or a containerized component; therefore, it will be null for all other asset types
-
repositoryId(optional):
string
Repository ID of the changed asset
Response
Supported Media Types
- application/json
200 Response
No response is returned as this is an event webhook