Request body parameters

Request body parameters are used when clients send data to the API. Generally, parameters are shipped in a JSON object in POST, PUT, or PATCH requests.

The JSON object is included in the request body, so these parameters are called request body parameters. The endpoint remains simple, like /subscriptions/{subscriptionId}, but you can include a JSON object with many key-value pairs in the request body.

Copy

{
     "DateRangeStart": "2023-1-1",
     "DateRangeEnd": "2023-5-3",
     "MaxRows": "10"
   }

Any available but not required parameter that is not sent in a request is treated as ‘any.’ For example, the following request returns all rows that match the date range with no other filtering.

Copy

   {
     "DateRangeStart": "2023-1-1",
     "DateRangeEnd": "2023-5-3"
   }

Any parameter that is an empty string “” is treated as the query looking for an empty string. For example, the following request returns rows where DateRangeStart equals an empty string (and likely no results).

Copy

{
     "DateRangeStart": "",
     "DateRangeEnd": "2023-5-3",
     "MaxRows": "10"
   }