Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Favorites

Update a rank

Update the rank of a favorite. If there is already a favorite in the new position, it will be updated with the current rank, swapping the position

Notes

  • There is not possible to have 2 ranks with the same value could not be duplicated.
  • The maximum numbers of reports to favorite is 12.
  • Example: If you want to update a favorite to the rank 1, being your favorite in the position 2. The rank in the position 1 will be moved to the 2 and the 2 to the 1
patch/datainsights/v1.1/favorites/{id}

Path parameters

idinteger required

Favorite Id of the resource

Headers

X-PROPERTY-IDinteger required

Property id of the client

Request body

rankinteger required

Rank associated to the favorite in order to display the reports

Response

OK

idinteger required

Favorite Id

rankinteger required

Rank associated to the favorite in order to display the reports

report_idinteger

Report, Stock Report or Hub Id favorited

entity_idinteger

Report, Stock Report or Hub Id favorited

report_kind'report' | 'stock_report' | 'hub'

Report Kind

kind'report' | 'stock_report' | 'hub'

Favorite Kind

Example response

{
  "id": 1,
  "report_kind": "stock_report",
  "kind": "stock_report"
}