v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Stock reports

Update report rules by id

Update a single report's rules.

Note: The API may throw a HTTP 404 if there are no reports found with a given id.

The API returns a 200 OK if the update was successful.

put/datainsights/v1.1/stock_reports/{stock_report_id}/rules

Path parameters

stock_report_idinteger required

Stock report id of the resource

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

feature_idsstring[] nullable

Stock Report Feature ids, one to many relationship to associate a stock report with all properties with any number of Feature.

property_idsinteger[] nullable

Stock Report Property ids, one to many relationship to associate a stock report with any number of property ID.

country_codesstring[] nullable

Stock Report Country Codes, one to many relationship to associate a stock report with any number of country codes.

property_typesstring[] nullable

Property Type

Example request

{
  "feature_ids": [
    "1"
  ],
  "country_codes": [
    "US"
  ]
}

Response

OK

feature_idsstring[] nullable

Stock Report Feature ids, one to many relationship to associate a stock report with all properties with any number of Feature.

property_idsinteger[] nullable

Stock Report Property ids, one to many relationship to associate a stock report with any number of property ID.

country_codesstring[] nullable

Stock Report Country Codes, one to many relationship to associate a stock report with any number of country codes.

property_typesstring[] nullable

Property Type

Example response

{
  "feature_ids": [
    "1"
  ],
  "country_codes": [
    "US"
  ]
}