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. Development

API Access with Python

Added by Joseph O. over 8 years ago

All,

Any and all help from everyone is very appreciated!

I’ve been trying to do some performance metrics based upon tasks in my project. I’ve written the following code which pulls the work packages by project.

theParams = {"pageSize": 1, "offset": 1, } r = requests.get('http://myurl.com/api/v3/projects/myID/work_packages/', auth=('apikey', 'mySuperFakeAPIKey12345'), params=theParams) print (r.json())

I really could use some assistance here. While I’m able to retrieve, I’d really could use some help regarding the syntax needed to filter the work packages by date. I’d like to pull only the last months worth of data back or all work packages between two dates.

Thanks for your assistance!

Joseph


Replies (5)

RE: API Access with Python - Added by Oliver Günther over 8 years ago

Hey Joseph,

I fully understand your need for assistance. Our own APIv3 queries in the work packages still uses the syntax from a previous API and filtering work packages is not really documented in our APIv3 documentation.
You can observe the GET requests to /api/experimental/projects/<project>/work_packages to receive information on the filter syntax in the meta.query response of that object.

A typical query filters object will look something like:

[{name: "status", operator: "o", values: null}, {name: "type", operator: "=", values: ["1"]}]

and means Filter attribute "status" by operator "open" (no value required) AND Filter attribute "type" for ID=1.
There are numerous operators and filters that I don’t know by heart. The method Query#sql_for_field contains a joyful case statement with some 20+ possible values.

Unfortunately, the APIv3 doesn’t accept the filter string as above, but needs to be slightly modified to the syntax attribute: { operator: X, values: Y }

To list work packages that were created in the last 30 days, you can use the following APIv3 filter URL

http://myurl.com/api/v3/work_packages?filters=[{"createdAt": {"operator": ">t-" ,"type": "date_past", "values":["30"]}}].

Best,
Oliver

RE: API Access with Python - Added by Joseph O. over 8 years ago

Oliver! You’re assistance is great appreciated.

I’ve done experimentation this morning and it looks like the “values” parameter is the number of days. Hence my query looks something like this to pull back the last 30 days worth:

http://myurl.com/api/v3/work_packages?filters=[{"createdAt": {"operator": ">t-" ,"type": "date_past", "values":["30"]}}]

Would you happen to have an example for filtering on “createdAt” which falls between two dates? This would be extremely useful if I needed to calculate metrics by “week” such that I were calculated between May 16 and May 23 as an example.

Thanks!

Joseph

RE: API Access with Python - Added by Oliver Günther over 8 years ago

Hey Joseph,

Unfortunately, there seems to be no between filter operator for dates.

Best,
Oliver

RE: API Access with Python - Added by Anto pare over 7 years ago

Hi all,

any news about searching between two dates?

Thanks

RE: API Access with Python - Added by Oliver Günther over 7 years ago

Hi Anto,

Yes! Good news, with OpenProject 7.0.,its possible to search for a between range of dates and datetimes.

See this example for a filter of tickets updated in the last week:

https://community.openproject.com/api/v3/work_packages/?filters=[{"updatedAt":{"operator":"<>d","values":["2017-06-10T22:00:00Z","2017-06-14T22:00:00Z"]}}]

Best,
Oliver

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