title | description | ms.custom | ms.date | ms.reviewer | ms.topic |
---|---|---|---|---|---|
How to: Use OData to Return-Obtain a JSON Document |
Learn about how to use OData to obtain a JSON document |
bap-template |
01/28/2024 |
jswymer |
conceptual |
You can publish a page as a web service and consume it using JavaScript Object Notation (JSON).
-
You can build applications that consume and display [!INCLUDEprod_short] data using JSON. This example assumes that you have registered and published a page web service in [!INCLUDEprod_short].
-
Start a supported web browser, such as Microsoft Edge. In the Address field, enter a URI in this format:
https://<Server>:<WebServicePort>/<ServerInstance>/ODataV4/<web service>?$format=json
If [!INCLUDEserver] is running on the local computer and is using the default [!INCLUDEserver] instance and OData port, and you have published a web service that is based on page 21 that is called Customer, then the address is:
https://localhost:7048/BC230/ODataV4/Customer?$format=json
This generates a text file that contains metadata and data from the web service. You can open the file from the browser, or you can save it to disk.
[!NOTE]
The value of the format attribute must be lowercase:?$format=json
.If you want to consume the web service as JSON-P, you can add the
?$callback=<callback function name>
parameter.You can use a similar URI to return the web service as an AtomPub document, in which case the attribute is
?$format=atom
. For more information, see Using OData to Return-Obtain an AtomPub Document.