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
      • Hierarchy leafWiki
You are here:
  • Forums
  • Development

Content

Creating workpackage via api

Added by peter lustig about 4 years ago

Hi together,

at the moment I try to create a workpackage for a project via the rest api.

I try to send a post to backend. that works fine. But I don't know how the post data have to look like and which attributes are mandatory.

http://docs.openproject.org/apiv3-doc/#work-packages-work-packages-by-project-post

My code looks like this:

**val** r = requests.post("http://url/api/v3/projects/36/work_packages",
data = Map("description"->"TEST","subject"->"test11"),
headers = Map("Authorization" -> "Basic base64code"))

Is there an working example which data has to be send via post?
Thanks in advance.


Replies (7)

RE: Creating workpackage via api - Added by peter lustig about 4 years ago

tried this:

 **val** r = requests.post("http://url/api/v3/projects/36/work_packages/form",
//        data = Map("description"->"TEST","subject"->"test11"),
        data = """{
        "subject": "new work_package",
        "description": {
          "format": "textile",
          "raw": "hallo"
        },
        "_links": {
          "type": {
            "href": "/api/v3/types/1",
            "title": "Task"
          },
          "status": {
            "href": "/api/v3/statuses/1"
          },
          "priority": {
            "href": "/api/v3/priorities/8",
            "title": "Normal"
          },
          "assignee": {
            "href": "/api/v3/users/3"
          }
        }
      }""",
        headers = Map("Authorization" -> "Basic Y="))

      println("adasd", r);

Response is:

Response(http://url/api/v3/projects/36/work_packages/form,406,Not Acceptable,Map(server -> Buffer(nginx/1.10.3 + Phusion Passenger 5.1.5), x-request-id -> Buffer(33b6eafd-f00b-4abc-8534-6e987ffd62e8), cache-control -> Buffer(no-cache), keep-alive -> Buffer(timeout=5, max=100), date -> Buffer(Tue, 27 Nov 2018 14:23:29 GMT), 
content-type -> Buffer(application/hal+json; charset=utf-8), status -> Buffer(406 Not Acceptable), via -> Buffer(1.1 url), transfer-encoding -> Buffer(chunked), connection -> Buffer(Keep-Alive), x-powered-by -> Buffer(Phusion Passenger 5.1.5), x-runtime -> Buffer(0.005146), vary -> Buffer(Accept-Encoding), content-encoding -> Buff 
er(gzip)),ResponseBlob(57 bytes),None))

RE: Creating workpackage via api - Added by Jens Ulferts about 4 years ago

Generally speaking, project , type and subject need to be provided. The project does not have to be provided if you are using the project specific create end point /api/v3/projects/:id/work_packages. Both project and type need to be provided as an href in the _links section while subject is a scalar property of work_packages.

A minimal payload could (see below) be:

{ 
  "_links": {
    "project": { "href": "/api/v3/projects/:id" },
    "type": { "href": "/api/v3/types/:id" }
  },
  "subject": "Some subject"
}

But because of custom fields the above is just a general answer and the properties actually required differ based on the configuration.

Because of that, there are quite handy utility end points POST /api/v3/projects/:id/work_packages/form (project specific) or POST /api/v3/work_packages/form which guide a client towards having a valid payload for creating a work package.

When posting to the end point you will receive a response consisting of payload, schema, and validationErrors. The payload can be taken as the body for a POST request either against this form end point or against the actual create end point. Before POSTing to the later however, check the validationErrors section. If it is empty, the payload is valid. If it is not, the client needs to fix the mentioned errors before posting to the create end point. The schema part describes the resource i.e. work package. It e.g. points out the required properties.

Please note that all properties of a resource that are resources themselves need to be provided in the _links section via an href.

RE: Creating workpackage via api - Added by Jens Ulferts about 4 years ago

Based on your error log, your problem is not your payload but you are lacking headers. Therefore a 406 is returned

> Buffer(406 Not Acceptable)

You need to send a Content-Type Header with application/json as well, as the Authorization Header.

RE: Creating workpackage via api - Added by peter lustig about 4 years ago

thanks! works like a charm.

RE: Creating workpackage via api - Added by peter lustig about 4 years ago

I can't add a category to the workpackage my json looks like this:

{
   "_links": {
       "project": {
           "href": "/api/v3/projects/3"
       },
       "type": {
           "href": "/api/v3/types/1"
       }
   },
   "subject": "TITEL",
   "description": {
       "format": "markdown",
       "raw": "test",
       "html": "test"
   },
   "_embedded": {
       "category": {
           "_type": "Category",
           "id": 3,
           "name": "NIST",
           "_links": {
               "self": {
                   "href": "/api/v3/categories/3",
                   "title": "NIST"
               },
               "project": {
                   "href": "/api/v3/projects/3",
                   "title": "nist"
               }
           }
       }
   }
}

what is wrong in my json?

RE: Creating workpackage via api - Added by Jens Ulferts about 4 years ago

Please note that all properties of a resource that are resources themselves need to be provided in the _links section via an href.

{
   "_links": {
       "project": {
           "href": "/api/v3/projects/3"
       },
       "type": {
           "href": "/api/v3/types/1"
       },
       "category": {
           "href": "/api/v3/categories/3"
       }
   },
   "subject": "TITEL",
   "description": {
       "format": "markdown",
       "raw": "test",
       "html": "test"
   }   
}

RE: Creating workpackage via api - Added by peter lustig about 4 years ago

Thanks! Would be nice if the api spec got a working example

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