Top Menu

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

      or sign in with your existing account

      Google

Side Menu

  • Overview
  • Activity
  • Roadmap
  • Work packages
  • Calendars
  • Team planners
  • Boards
  • Forums
  • Feature tour
    • 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 a work package with API

Added by Otmane Azeroual over 6 years ago

Hi,

I’m able to connect and list work packages via API 3.0
But the creation doesn’t work.

I have tried to create with this code a work packages:

var http= new XMLHttpRequest();
var url = “mydomain/openproject/api/v3/projects/test/work_packages/”;
var data = ‘{subject subject“,”description“: { ”format“: ”textile“, ”raw“: ”My raw textile formatted description. Bye guys!" }, “_links”: {“type”: {href, status, priority }}’;
http.open(“POST”, url, true);
http.setRequestHeader(“Content-type”, “application/json”);
http.onreadystatechange = function() {
if (http.readyState 4 && http.status 200) {
// do something with response
console.log(http.responseText);
}
console.log(http.readyState + “-” + http.status);
};
http.send(data);

Can someone explain why is not work? Any assistance would be greatly appreciated!

Kind regards
Otmane


Replies (7)

RE: Create a project with API - Added by Kersten Mitte over 6 years ago

Hi Otmane,

do you want create a project or a work_package.

Your json string looks like creating a work_package.
For a work_package I think you need add: (the user 3 must exist)

“assignee”: {
“href”: “/api/v3/users/3”
}

i use php and this json worked for me:

{
“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”
}
}
}

2. I could not find something like “auth:apikey” in your code.

Best
Kersten

RE: Create a project with API - Added by Otmane Azeroual over 6 years ago

Hallo Kersten,

Thank you for your response. i have used
“assignee”: {
“href”: “/api/v3/users/3” and auth:apikey but is not function!

can you show me please your example with auth:apikey?

thank you for your help!

Best regards
Otmane

RE: Create a work package with API - Added by Otmane Azeroual over 6 years ago

I tried to add the authentification to json string as follows:

var url = “mydomain/openproject/api/v3/projects/kdsf/work_packages/”;
var auth=‘xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’;
var json_upload =
‘{
auth
apikey
},
data
subject subject“,
”description“:{
”format“:”textile“,
”raw“:”My raw textile formatted description. Bye guys!"
},
_links
type
href,
title
},
status
href
},
priority
href,
title
},
assignee
href
}
}
}
}’;

var xhr2 = new XMLHttpRequest();
xhr2.open(“POST”, url, true);
xhr2.setRequestHeader(“Content-type”, “application/json”);
xhr2.onreadystatechange = function() {
if (xhr2.readyState 4 && xhr2.status 200) {
// do something with response
console.log(xhr2.responseText);
}
console.log(xhr2.readyState + “-” + xhr2.status);
};
xhr2.send(JSON.stringify(json_upload));

Still i only get readyState == 4 and status = 0 in the console. the user admin is existing.

Do you know what the problem is?

Thank you for your help!

Best regards
Otmane

RE: Create a work package with API - Added by Kersten Mitte over 6 years ago

Hi Otmane,

- “auth” … belongs to the header like “Conten-type” and not to the json data.

maybe this php code can help you a litte:

fputs($fp, “Content-type: application/json\r\n”);
fputs($fp, “Authorization: Basic ”.base64_encode(“apikey:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx”).“\r\n”);
fputs($fp, “Content-length: ”. strlen($data) .“\r\n”);
fputs($fp, “Connection: close\r\n\r\n”);
fputs($fp, $json_data);

best
kersten

RE: Create a work package with API - Added by Otmane Azeroual over 6 years ago

Hey Kersten,

Can you please send me the complete code php.

Thank you for your help!

Best regards
Otmane

RE: Create a work package with API - Added by Otmane Azeroual over 6 years ago

Hi Kersten,

I have a question, you have the API folder in the installation of OpenProject. I want to address the API folders (/openproject/api/v3/projects) because I always get readyState == 4 and status = 0 in the console. I have looked at all Api documentation und my code is correct. Something does not work right with me. Can you please help me or tell me what the problem ist ? I would be very grateful

Thank you for you help!

Best,
Otmane

RE: Create a work package with API - Added by Kersten Mitte about 6 years ago

Hi Otmane,

i must use a connection with http:// an not https://.

Best
Kersten

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