forma-embedded-view-sdk/dist/internal/experimental/analysis.js

The Forma Embedded View SDK is a JavaScript library for creating custom extensions in Autodesk Forma Site Design (previously Spacemaker).

export class ExperimentalAnalysisApi {
    #iframeMessenger;
    /** @hidden */
    constructor(iframeMessenger) {
        this.#iframeMessenger = iframeMessenger;
    }
    /**
     * Put an item in the catalog for an analysis result that the extension provides. This will make the result available in the list of analyses that has been run in Forma Site Design's UI.
     *
     * @returns
     * Empty body on success.
     *
     * @example
     * await Forma.experimental.analysis.putCatalogItem({
     *   analysisId: "6db10410-9f72-4cc1-b79a-be65230b9104",
     *   status: "SUCCEEDED",
     *   elementUrn:
     *     "urn:adsk-forma-elements:proposal:pro_s3a28a18wi:1a79199e-7ce9-418e-8eb1-42a91ddab09a:1708350177957",
     * })
     */
    async putCatalogItem(request) {
        return await this.#iframeMessenger.sendRequest("analysis/put-catalog-item", request);
    }
}