Top Menu

Jump to content
Home
    Modules
      • Projects
      • Activity
      • Work packages
      • Gantt charts
      • Calendars
      • Team planners
      • Boards
      • News
    • Getting started
    • Introduction video
      Welcome to OpenProject Community
      Get a quick overview of project management and team collaboration with OpenProject. You can restart this video from the help menu.
    • Help and support
    • User guides
    • Videos
    • Shortcuts
    • Community forum
    • Enterprise support
    • Additional resources
    • Data privacy and security policy
    • Digital accessibility (DE)
    • OpenProject website
    • Security alerts / Newsletter
    • OpenProject blog
    • Release notes
    • Report a bug
    • Development roadmap
    • Add and edit translations
    • API documentation
  • Sign in
      Forgot your password?

      or sign in with your existing account

      Google

Side Menu

  • Overview
  • Activity
    Activity
  • Roadmap
  • Work packages
    Work packages
  • Gantt charts
    Gantt charts
  • Calendars
    Calendars
  • Team planners
    Team planners
  • Boards
    Boards
  • News
  • Forums
  • Feature tour
    Feature tour

Content

You are here:
  1. Forums
  2. General discussion

#api How to filter with "_links" properties params on API.v3

Added by Thanh Nguyen over 4 years ago

Hi!

I just learned to use "hypermedia rest api" on openproject

I want use "filter" param with "_links" properties on api but not know how

Example:

http:/<my_domain>/target/api/v3/projects/design/work_packages?filters=[{"updatedAt":{"operator":"<>d","values":["2017-06-10T22:00:00Z","2017-07-05T22:00:00Z"]}, "_links":{"type":{"title":{"operator":"=","values":["Box"]}}}]

==> My Question:

  1. i not known use to "_links":{"type":{"title":{"operator":"=","values":["Box"]} params filter. Now, result is not filter for "_links"
  2. And show me books name to learn API for to beginner
    1. ? (https://www.oreilly.com/library/view/restful-web-clients/9781491921890/ch04.html#callout_hal_clients_CO1-1) -> is this ok?

Help me, please!

Thanks!


Replies (3)

RE: #api How to filter with "_links" properties params on API.v3 - Added by Thanh Nguyen over 4 years ago

RE: #api How to filter with "_links" properties params on API.v3 - Added by Thanh Nguyen over 4 years ago

Solved! 

https://stackoverflow.com/questions/62844700/how-to-filter-with-links-properties-params-on-api-v3-in-openproject

RE: #api How to filter with "_links" properties params on API.v3 - Added by Sarah White 11 months ago

To properly filter by "_links" in a hypermedia API, you'll need to refer to the API documentation provided by OpenProject. Typically, hypermedia APIs like HAL (Hypertext Application Language) will have specific ways of navigating and filtering based on the links available.

Regarding your question about learning b2b API integration for beginners, the link you provided (https://www.oreilly.com/library/view/restful-web-clients/9781491921890/ch04.html#callout_hal_clients_CO1-1) seems to be from the book "RESTful Web Clients" by Mike Amundsen. This book is a good resource for understanding RESTful principles, and it covers topics like hypermedia and HAL.

  • (1 - 3/3)
Loading...