Top Menu

Jump to content
Home
    • Projects
    • Work packages
    • 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
    • Professional 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?
      Create a new account

      or sign in with your existing account

      Google

Side Menu

  • Overview
  • Activity
  • Roadmap
  • Work packages
  • Calendars
  • Team planners
  • Boards
  • Forums
  • Wiki
    • Table of contents
      • Expanded. Click to collapseCollapsed. Click to showDeveloper
        • Hierarchy leafAccessibility Checklist
        • Hierarchy leafCode Review Guidelines
        • Expanded. Click to collapseCollapsed. Click to showContribution
          • Hierarchy leafGit Workflow
          • Hierarchy leafTranslations
        • Expanded. Click to collapseCollapsed. Click to showDeveloping Plugins
          • Hierarchy leafDeveloping an OmniAuth Authentication Plugin
        • Hierarchy leafRelease Process
        • Hierarchy leafReport a bug
        • Hierarchy leafSecurity
        • Hierarchy leafSetting up an OpenLDAP server for testing
        • Hierarchy leafTheme Features
      • Hierarchy leafDownload
      • Expanded. Click to collapseCollapsed. Click to showFeature tour
        • Hierarchy leafRelease Notes OpenProject 30
        • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 30 - Overview
          • Hierarchy leafGlossary
          • Hierarchy leafRelease Notes - Accessibility
          • Hierarchy leafRelease Notes - Accessibility changes
          • Hierarchy leafRelease Notes - Add work package queries as menu items to sidebar
          • Hierarchy leafRelease Notes - Copy projects based on Templates
          • Hierarchy leafRelease Notes - Design changes
          • Hierarchy leafRelease Notes - Fixed Bugs
          • Hierarchy leafRelease Notes - Keyboard Shortcuts
          • Hierarchy leafRelease Notes - Project settings
          • Hierarchy leafRelease Notes - Ruby&Rails Update
          • Hierarchy leafRelease Notes - Security
          • Hierarchy leafRelease Notes - Timelines
          • Hierarchy leafRelease Notes - Work packages
      • Hierarchy leafHowto create animated gifs
      • Hierarchy leafMigration Squashing
      • Hierarchy leafMod security
      • Hierarchy leafNew work package page
      • Hierarchy leafOP3 to OP4 Debian upgrade
      • Hierarchy leafOP4 Ubuntu1404 Stable with MySQL in production
      • Hierarchy leafOpenProject 40 Development Setup
      • Expanded. Click to collapseCollapsed. Click to showOpenProject Foundation
        • Hierarchy leafBoards
        • Hierarchy leafMembers
        • Hierarchy leafOPF-Meetings
        • Hierarchy leafStatutes
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes
        • Hierarchy leafOpenProject released on Bitnami
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 40 - Overview
        • Hierarchy leafRelease Notes OpenProject 40 - Accessibility improvements
        • Hierarchy leafRelease Notes OpenProject 40 - Column header functions in work package table
        • Hierarchy leafRelease Notes OpenProject 40 - Improved Design
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated query title on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated toolbar on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - OmniAuth integration for OpenProject
        • Hierarchy leafRelease Notes OpenProject 40 - Work package details pane
      • Expanded. Click to collapseCollapsed. Click to showSecurity and privacy
        • Hierarchy leafFAQ
      • Expanded. Click to collapseCollapsed. Click to showSupport
        • Expanded. Click to collapseCollapsed. Click to showDownload and Installation
          • Hierarchy leafInstallation MacOS
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 3 0
            • Hierarchy leafDebian Stable with MySQL in production
            • Hierarchy leafInstallation Ubuntu
            • Hierarchy leafInstallation Windows
            • Hierarchy leafInstallation on Centos 65 x64 with Apache and PostgreSQL 93
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 40
            • Hierarchy leafOP4 Debian Stable with MySQL in production
          • Expanded. Click to collapseCollapsed. Click to showMigration paths
            • Hierarchy leafFrom Chilliproject to OpenProject
            • Hierarchy leafMigration 15 to 30
            • Hierarchy leafMigration 24 to 30
            • Hierarchy leafMigration Redmine 2x › OpenProject 30
            • Hierarchy leafOpenProject 3 Migration
          • Hierarchy leafOpenProject 40
        • Expanded. Click to collapseCollapsed. Click to showNews
          • Hierarchy leafNew OpenProject Translations Plugin
          • Hierarchy leafNew Plugin on OpenProjectorg Local Avatars
          • Hierarchy leafNew design for OpenProject
          • Hierarchy leafNews Accessibility workshop for OpenProject
          • Hierarchy leafNews Glossary for OpenProject
          • Hierarchy leafNews Heartbleed fixed
          • Hierarchy leafNews Icon Fonts
          • Hierarchy leafNews OpenProject 30 Release
          • Hierarchy leafNews Release GitHub Integration Plugin
          • Hierarchy leafNews Success Story Deutsche Telekom
          • Hierarchy leafNews Timelines
          • Hierarchy leafOpenProject 3013 released
          • Hierarchy leafOpenProject 3017 released
          • Hierarchy leafOpenProject 40 released
          • Hierarchy leafOpenProject 40 will be coming soon
          • Hierarchy leafOpenProject 405 released
          • Hierarchy leafOpenProject and pkgrio
          • Hierarchy leafOpenProject news moved to a new blog
          • Hierarchy leafOpenProjectBitnami
          • Hierarchy leafPackager version with plugins released ("Community edition")
          • Hierarchy leafRegistration OpenProject-Foundation
          • Hierarchy leafRelease OpenProject AuthPlugins
          • Hierarchy leafUpdates on OpenProject
          • Hierarchy leafWe need your feedback for the the new fullscreen view for work packages
        • Hierarchy leafOpenProject Plug-Ins
      • Expanded. Click to collapseCollapsed. Click to showWiki
        • Hierarchy leaf2nd Level Support
You are here:
  • Forums
  • Development

Content

Create work package with API 3.0

Added by Martin Haedecke over 7 years ago

Hi,

I’m able to connect and list work packages via API 3.0
But the creation doesn’t work.
Has somebody an example or can explain how the creation form is working?
And please, don’t post the API-URL. ;)

Kind regards
Martin


Replies (4)

RE: Create work package with API 3.0 - Added by Oliver Günther over 7 years ago

Hi Martin,

first, let me tell you that the v3 has been heavily worked on and the following applies mainly to the 5.0 (dev) branch of OpenProject.

you can get a look at the required fields for a new work package of a new project using the /api/v3/projects/:identifier/work_packages/form endpoint [1].
It will return a schema that’s also in use by the frontend to distinguish required and optional parameters as well as getting a list of some potential values (e.g., for the status or work package type).
Note that this schema may be highly different for a given project and type due to the way projects and their types can be customized in OpenProject. If you look at the requests from the frontend, you’ll notice requests to /api/v3/work_packages/schemas/<project-id>-<type-id> that returns the appropriate schema for this project and type.

To create a work package in a given project, you ‘simply’ POST the correct values to the endpoint /api/v3/projects/seeded_project/work_packages/. [2]
In the default Task type, the following JSON hash would be acceptable and creates a WP on my local machine:

{
    "subject":"My subject",
    "description": {
        "format": "textile",
        "raw": "My raw @textile@ formatted description. _Bye guys!_"
    },
    "_links": {
        "type": {"href":"/api/v3/types/1"},
        "status":{"href":"/api/v3/statuses/1"},
        "priority":{"href":"/api/v3/priorities/8"}
    }
}

Best regards,
Oliver from OpenProject

[1] Work package form endpoint
[2] Work package create endpoint

RE: Create work package with API 3.0 - Added by Michael Freitter over 7 years ago

Hello,

I have tried to send a HTTP request to my server to create a work packages and have use your example:


POST http://my.domain.com/api/v3/projects/8/work_packages/form?key=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx HTTP/1.1
Content-Type: text/json
Accept-Encoding: gzip, deflate
Host: my.domain.com
Content-Length: 334
Expect: 100-continue

{
subject subject“,
”description“: {
”format“: ”textile“,
”raw“: ”My raw textile formatted description. Bye guys!"
},
“_links”: {
“type”: {href,
status,
priority
}
}
————————————————————————————————-

But I get an error:


HTTP/1.1 406 Not Acceptable
Date: Sun, 06 Dec 2015 13:28:58 GMT
Server: Apache/2.4.7 (Ubuntu)
Status: 406 Not Acceptable
Content-Type: application/hal+json; charset=utf-8
Content-Length: 56
Cache-Control: no-cache
X-Request-Id: ebdb9df2-697c-4073-b4d0-fe25a20c6462
X-Runtime: 0.003627

The requested content-type ‘text/json’ is not supported.
————————————————————————————————-

Unfortunately, I’ve not found in any documentation an example of an whole HTTP request for create a workpackage with API v3.
Have anybody a idee, why this is wrong?

Regards
Michael

RE: Create work package with API 3.0 - Added by Marion Nette over 7 years ago

Hello,

same here, I am not able to create any work packages.
Whatever I send, I get:

type:“Error”
errorIdentifier
message internal error has occured."
embedded

I use 5.0.5, apache httpclient
Anyone has a working example?

Thanks. M.

RE: Create work package with API 3.0 [solved] - Added by Marion Nette over 7 years ago

Works now. The correct content type for posting work_packages is:
“Content-Type: application/json”
not “hal+json”.

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