Jump to

• Request
• Response

DSAssetUpdate

post

/ccadmin/v1/webhook/DSAssetUpdate

The Design Studio asset update details

Request

Supported Media Types

• application/json

Body ()

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.

{
    "description":"The details returned when a Design Studio asset has been changed.",
    "properties":{
        "origin":{
            "description":"How the asset changes were made.\n1. UI - indicates a change made in the Design Studio UI. \n2. API - indicates a change made via an endpoint call. \n3. 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: \n- Standard deployment is indicated by the origin assetUpdateDeployWithoutReset. Any newly created assets will be listed. \n- 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",
            "type":"string"
        },
        "assetChangesList":{
            "type":"object",
            "properties":{
                "itemDescriptor":{
                    "description":"The type of the changed asset",
                    "type":"string"
                },
                "filename":{
                    "description":"Filename of the changed asset",
                    "type":"string"
                },
                "displayName":{
                    "description":"Display name of the changed asset",
                    "type":"string"
                },
                "repositoryId":{
                    "description":"Repository ID of the changed asset",
                    "type":"string"
                },
                "action":{
                    "description":"Describes the nature of the change to the asset - will be 0, 1 or 2 for update, delete or create respectively",
                    "type":"string"
                },
                "actionDescription":{
                    "description":"Textual property describing the action performed on the asset. \n- If action = 0, actionDescription = assetUpdate \n- If action = 1, actionDescription = assetDelete \n- If action = 2, actionDescription = assetCreate",
                    "type":"string"
                },
                "layoutRepositoryId":{
                    "description":"Layout repository ID of the changed asset. \nNote 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",
                    "type":"string"
                }
            }
        },
        "applicationId":{
            "description":"ID of the OSF application that the asset changes were made on.",
            "type":"string"
        },
        "locale":{
            "description":"The default locale of the default site.",
            "type":"string"
        },
        "userId":{
            "description":"ID of the user who made the asset changes.",
            "type":"string"
        }
    }
}

Nested Schema : assetChangesList

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "itemDescriptor":{
            "description":"The type of the changed asset",
            "type":"string"
        },
        "filename":{
            "description":"Filename of the changed asset",
            "type":"string"
        },
        "displayName":{
            "description":"Display name of the changed asset",
            "type":"string"
        },
        "repositoryId":{
            "description":"Repository ID of the changed asset",
            "type":"string"
        },
        "action":{
            "description":"Describes the nature of the change to the asset - will be 0, 1 or 2 for update, delete or create respectively",
            "type":"string"
        },
        "actionDescription":{
            "description":"Textual property describing the action performed on the asset. \n- If action = 0, actionDescription = assetUpdate \n- If action = 1, actionDescription = assetDelete \n- If action = 2, actionDescription = assetCreate",
            "type":"string"
        },
        "layoutRepositoryId":{
            "description":"Layout repository ID of the changed asset. \nNote 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",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

No response is returned as this is an event webhook

Body ()

Root Schema : emptyResponse

Show Source

{
    "properties":{
    }
}

Back to Top