Dataverse WebAPI swagger json description

Like (0) Share

Report

Posted on 7 Oct 2022 07:07:50 by Michael_U

Hello to all,

As part of the integration of the standard WebApi Odata ( https://xxx.api.crm4.dynamics.com/api/... ) of Dataverse / Dynamics on other systems, a partner asks us to provide a swagger file to facilitate the integration. The operations to manage will be CRUD and execute multiple on some standard / custom tables. Can you tell me if this is possible and how ?

Many Thanks !

Cheers,

Michaël

Categories:

Microsoft Dataverse

Entities

Tables

I have the same question (0)

All responses (3)

Answers (1)

alx.kpk 46 on 29 Mar 2024 at 12:08:23

Like (0)

Report

Re: Dataverse WebAPI swagger json description

There seems to be an undocumented endpoint under [DataverseOrgUrl]/api/flow/openapi which provides a valid Swagger 2.0 JSON

Source: Microsoft Dataverse OpenApi endpoint – Hacking Power Platform

Was this reply helpful? Yes No
Michael_U 2 on 08 Oct 2022 at 08:01:42

Like (0)

Report

Re: Dataverse WebAPI swagger json description

Hello Guido,

Thanks for the response. I came to the same conclusion. Thank you for contributing with Dataverse REST Builder tool !
Hoping Microsoft will provide a more standard way to achieve it soon. I will check in ideas it this is planned or not.

Michaël

Was this reply helpful? Yes No
Verified answer

Guido Preite 1,488 Super User 2024 Season 1 on 07 Oct 2022 at 18:09:16

Like (2)

Report

Re: Dataverse WebAPI swagger json description

It can be complicated but this is the only way I know.

You can use my tool Dataverse REST Builder to create the requests, after you can export the collection to Postman. After you have the Postman collection you can convert it to a Swagger/OpenAPI file using a service like https://www.apimatic.io/transformer/

Was this reply helpful? Yes No