Skip to content

Support guestbook responses when launching file external tools - #509

Open
ChengShi-1 wants to merge 1 commit into
developfrom
fix/1164-js-dataverse-external-tool-guestbook
Open

ChengShi-1 wants to merge 1 commit into
developfrom
fix/1164-js-dataverse-external-tool-guestbook

Conversation

@ChengShi-1

@ChengShi-1 ChengShi-1 commented Nov 18, 2026 •

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:

Adds an optional guestbookResponse to getFileExternalToolResolved. The SDK reuses the download API’s Guestbook response type and sends the completed form in the file tool’s /toolUrl request. Dataverse can then include the resulting Guestbook record ID in the tool callback. This supports both embedded preview and opening the same tool in a new window.

Which issue(s) this PR closes:

Related Dataverse PRs:

Special notes for your reviewer:

  • The file-specific launch options are exported as GetFileExternalToolDTO. The guestbookResponse field is optional for existing callers.

Suggestions on how to test this:

  • Run npm run test:unit -- --runInBand test/unit/externalTools to verify the SDK request body.

Is there a release notes or changelog update needed for this change?:

Yes. Added an entry under Unreleased in CHANGELOG.md.

Additional documentation:

Updated the Get File External Tool Resolved example in docs/useCases.md.

@ChengShi-1 ChengShi-1 added Size: 3 A percentage of a sprint. 2.1 hours. SPA labels Nov 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Size: 3 A percentage of a sprint. 2.1 hours. SPA

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant