Projects

Projects are containers structuring the information (e.g. work packages, wikis) into smaller groups. They can be used in a classic project management approach but also when structuring work by departments.

As containers, they also control behaviour of the elements within them. One of the most important aspects of this is that projects limit permissions by having members with a certain permission set (roles) assigned to them.

Actions

Link Description Condition
update Form endpoint that aids in updating this projet Permission: edit project
updateImmediately Directly update this project Permission: edit project
delete Delete this project Permission: admin
createWorkPackage Form endpoint that aids in preparing and creating a work package Permission: add work packages
createWorkPackageImmediately Directly creates a work package in the project Permission: add work packages

Linked Properties

Link Description Type Constraints Supported operations Condition
self This project Project not null READ
categories Categories available in this project Collection not null READ
types Types available in this project Collection not null READ Permission: view work packages or manage types
versions Versions available in this project Collection not null READ Permission: view work packages or manage versions
memberships Memberships in the project Collection not null READ Permission: view members
workPackages Work Packages of this project Collection not null READ
parent Parent project of the project Project READ/WRITE Permission edit project

Depending on custom fields defined for projects, additional links might exist.

Local Properties

Property Description Type Constraints Supported operations
id Projects’s id Integer x > 0 READ/WRITE
identifier String READ/WRITE
name String READ/WRITE
active Indicates whether the project is currently active or already archived Boolean READ/WRITE
status Denotes the status of the project, so wether the project is on track, at risk is having trouble. String “on track”, “at risk” or “off track” READ/WRITE
statusExplanation A text detailing and explaining why the project has the reported status Formattable READ/WRITE
public Indicates whether the project is accessible for everybody Boolean READ/WRITE
description Formattable READ/WRITE
createdAt Time of creation DateTime READ
updatedAt Time of the most recent change to the project DateTime READ

Depending on custom fields defined for projects, additional properties might exist.

Project 

View project
/api/v3/projects/{id}
  • Parameters
  • id
    integer (required) Example: 1

    Project id

  • Response  200
  • Headers
    Content-Type: application/hal+json
    Body
    {
        "_type": "Project",
        "_links": {
            "self": {
                "href": "/api/v3/projects/1",
                "title": "Lorem"
            },
            "createWorkPackage": {
                "href": "/api/v3/projects/1/work_packages/form",
                "method": "post"
            },
            "createWorkPackageImmediate": {
                "href": "/api/v3/projects/1/work_packages",
                "method": "post"
            },
            "categories": {
                "href": "/api/v3/projects/1/categories"
            },
            "types": {
                "href": "/api/v3/projects/1/types"
            },
            "versions": {
                "href": "/api/v3/projects/1/versions"
            },
            "workPackages": {
                "href": "/api/v3/projects/1/work_packages"
            }
            "memberships": {
                "href": "/api/v3/memberships?filters=[{"project":{"operator":"=","values":["1"]}}]
            },
            "customField456": {
                "href": "/api/v3/users/315",
                "method": "A user"
            },
            "projects": {
              "href": "/api/v3/projects/123"
            }
        },
        "id": 1,
        "identifier": "project_identifier",
        "name": "Project example",
        "active": true,
        "public": false,
        "status": "on track",
        "statusExplanation": {
            "format": "markdown",
            "raw": "Everything **fine**",
            "html": "<p>Everything <strong>fine</strong></p>"
        },
        "description": {
            "format": "markdown",
            "raw": "Lorem **ipsum** dolor sit amet",
            "html": "<p>Lorem <strong>ipsum</strong> dolor sit amet</p>"
        },
        "createdAt": "2014-05-21T08:51:20Z",
        "updatedAt": "2014-05-21T08:51:20Z",
        "customField123": 123
    }
    
  • Response  404
  • Returned if the project does not exist or the client does not have sufficient permissions to see it.

    Required permission: view project

    Note: A client without sufficient permissions shall not be able to test for the existence of a project. That’s why a 404 is returned here, even if a 403 might be more appropriate.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
      "message": "The specified project does not exist."
    }
Update Project
/api/v3/projects/{id}

Updates the given project by applying the attributes provided in the body.

  • Parameters
  • id
    integer (required) Example: 1

    Project id

  • Request  Update project
  • Body
    {
      "name": "A new project name",
      "status": "at risk",
      "_links": {
        "customField35": {
          "href": "/api/v3/users/3"
        }
      }
    }
  • Response  200
  • Body
    {
        "_type": "Project",
        "_links": {
            "self": {
                "href": "/api/v3/projects/1",
                "title": "Lorem"
            },
            "createWorkPackage": {
                "href": "/api/v3/projects/1/work_packages/form",
                "method": "post"
            },
            "createWorkPackageImmediate": {
                "href": "/api/v3/projects/1/work_packages",
                "method": "post"
            },
            "categories": {
                "href": "/api/v3/projects/1/categories"
            },
            "types": {
                "href": "/api/v3/projects/1/types"
            },
            "versions": {
                "href": "/api/v3/projects/1/versions"
            },
            "workPackages": {
                "href": "/api/v3/projects/1/work_packages"
            }
            "memberships": {
                "href": "/api/v3/memberships?filters=[{"project":{"operator":"=","values":["1"]}}]
            },
            "customField456": {
                "href": "/api/v3/users/315",
                "method": "A user"
            },
            "projects": {
              "href": "/api/v3/projects/123"
            }
        },
        "id": 1,
        "identifier": "project_identifier",
        "name": "Project example",
        "active": true,
        "public": false,
        "status": "on track",
        "statusExplanation": {
            "format": "markdown",
            "raw": "Everything **fine**",
            "html": "<p>Everything <strong>fine</strong></p>"
        },
        "description": {
            "format": "markdown",
            "raw": "Lorem **ipsum** dolor sit amet",
            "html": "<p>Lorem <strong>ipsum</strong> dolor sit amet</p>"
        },
        "createdAt": "2014-05-21T08:51:20Z",
        "updatedAt": "2014-05-21T08:51:20Z",
        "customField123": 123
    }
    
  • Response  400
  • Occurs when the client did not send a valid JSON object in the request body.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
      "message": "The request body was not a single JSON object."
    }
  • Response  403
  • Returned if the client does not have sufficient permissions.

    Required permission: edit project for the project to be altered

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
      "message": "You are not authorized to access this resource."
    }
  • Response  404
  • Returned if the project does not exist or the client does not have sufficient permissions to see it.

    Required permission: view project

    Note: A client without sufficient permissions shall not be able to test for the existence of a version. That’s why a 404 is returned here, even if a 403 might be more appropriate.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
      "message": "The requested resource could not be found."
    }
  • Response  422
  • Returned if:

    • a constraint for a property was violated (PropertyConstraintViolation)
    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
      "message": "Name can't be blank.",
      "_embedded": {
        "details": {
          "attribute": "name"
        }
      }
    }
Delete Project
/api/v3/projects/{id}

Deletes the project permanently. As this is a lengthy process, the actual deletion is carried out asynchronously. So the project might exist well after the request has returned successfully. To prevent unwanted changes to the project scheduled for deletion, it is archived at once.

  • Parameters
  • id
    integer (required) Example: 1

    Project id

  • Response  204
  • Returned if the project was successfully deleted. There is currently no end point to query for the actual deletion status. Such an end point might be added in the future.

    Headers
    Content-Type: application/hal+json
  • Response  403
  • Returned if the client does not have sufficient permissions.

    Required permission: admin

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
      "message": "You are not authorized to access this resource."
    }
  • Response  404
  • Returned if the project does not exist or the client does not have sufficient permissions to see it.

    Required permission: view project

    Note: A client without sufficient permissions shall not be able to test for the existence of a version. That’s why a 404 is returned here, even if a 403 might be more appropriate.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
      "message": "The requested resource could not be found."
    }
  • Response  422
  • Returned if the project cannot be deleted. This can happen when there are still references to the project in other projects that need to be severed at first.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
      "message": "Work packages in non descendant projects reference versions of the project or its descendants.",
      "_embedded": {
        "details": {
          "attribute": "base"
        }
      }
    }

Projects 

List projects
/api/v3/projects{?filters,sortBy}

Returns a collection of projects. The collection can be filtered via query parameters similar to how work packages are filtered. In addition to the provided filter, the result set is always limited to only contain projects the client is allowed to see.

  • Parameters
  • filters
    string (optional) Example: [{ "ancestor": { "operator": "=", "values": ['1'] }" }]

    JSON specifying filter conditions. Accepts the same format as returned by the queries endpoint. Currently supported filters are:

    • active: based on the active property of the project

    • ancestor: filters projects by their ancestor. A project is not considered to be it’s own ancestor.

    • created_on: based on the time the project was created

    • latest_activity_at: based on the time the last activity was registered on a project.

    • name_and_identifier: based on both the name and the identifier.

    • parent_id: filters projects by their parent.

    • principal: based on members of the project.

    • type_id: based on the types active in a project.

    • id: based on projects’ id. There might also be additional filters based on the custom fields that have been configured.

    sortBy
    string (optional) Example: [["id", "asc"]]

    JSON specifying sort criteria. Currently supported orders are:

    • id

    • name

    • created_on

    • public

    • latest_activity_at

    • required_disk_space There might also be additional orders based on the custom fields that have been configured.

  • Response  200
  • Headers
    Content-Type: application/hal+json
    Body
    {
      "_links": {
        "self": {
          "href": "/api/v3/projects"
        }
      },
      "_type": "Collection",
      "total": 2,
      "count": 2,
      "_embedded": {
        "elements": [
          {
            "_type": "Project",
            "_links": {
              "self": {
                "href": "/api/v3/projects/6",
                "title": "A project"
              },
              "createWorkPackage": {
                "href": "/api/v3/projects/6/work_packages/form",
                "method": "post"
              },
              "createWorkPackageImmediate": {
                "href": "/api/v3/projects/6/work_packages",
                "method": "post"
              },
              "categories": {
                "href": "/api/v3/projects/6/categories"
              },
              "versions": {
                "href": "/api/v3/projects/6/versions"
              },
              "projects": {
                "href": "/api/v3/projects/123"
              }
            },
            "id": 6,
            "identifier": "a_project",
            "name": "A project",
            "active": true,
            "status": "on track",
            "statusExplanation": {
                "format": "markdown",
                "raw": "Everything **fine**",
                "html": "<p>Everything <strong>fine</strong></p>"
            },
            "public": false,
            "description": {
                "format": "markdown",
                "raw": "Lorem **ipsum** dolor sit amet",
                "html": "<p>Lorem <strong>ipsum</strong> dolor sit amet</p>"
            },
            "createdAt": "2015-07-06T13:28:14+00:00",
            "updatedAt": "2015-10-01T09:55:02+00:00",
            "type": "Customer Project"
          },
          {
            "_type": "Project",
            "_links": {
              "self": {
                "href": "/api/v3/projects/14",
                "title": "Another project"
              },
              "createWorkPackage": {
                "href": "/api/v3/projects/14/work_packages/form",
                "method": "post"
              },
              "createWorkPackageImmediate": {
                "href": "/api/v3/projects/14/work_packages",
                "method": "post"
              },
              "categories": {
                "href": "/api/v3/projects/14/categories"
              },
              "versions": {
                "href": "/api/v3/projects/14/versions"
              },
              "projects": {
                "href": null
              }
            },
            "id": 14,
            "identifier": "another_project",
            "name": "Another project",
            "active": false,
            "status": "off track",
            "statusSxplanation": {
                "format": "markdown",
                "raw": "Uh **oh**",
                "html": "<p>Uh <strong>oh</strong></p>"
            },
            "public": true,
            "description": {
                "format": "markdown",
                "raw": "",
                "html": ""
            },
            "createdAt": "2016-02-29T12:50:20+00:00",
            "updatedAt": "2016-02-29T12:50:20+00:00",
            "type": null
          }]
        }
      }
    }
Create project
/api/v3/projects{?filters,sortBy}

Creates a new project, applying the attributes provided in the body.

You can use the form and schema to be retrieve the valid attribute values and by that be guided towards successful creation.

  • Request  Create project
  • Body
    {
      "identifier": "new_project_identifier",
      "name": "New project name",
      "customField35": "Text custom field value",
      "status": "on track",
      "statusExplanation": {
        "format": "markdown",
        "raw": "Everything **fine**",
        "html": "<p>Everything <strong>fine</strong></p>"
      },
      "_links": {
        "customField12": {
          "href": "/api/v3/users/5"
        },
        "parent": {
          "href": "/api/v3/projects/6"
        }
      }
    }
  • Response  201
  • Body
    {
        "_type": "Project",
        "_links": {
            "self": {
                "href": "/api/v3/projects/1",
                "title": "Lorem"
            },
            "createWorkPackage": {
                "href": "/api/v3/projects/1/work_packages/form",
                "method": "post"
            },
            "createWorkPackageImmediate": {
                "href": "/api/v3/projects/1/work_packages",
                "method": "post"
            },
            "categories": {
                "href": "/api/v3/projects/1/categories"
            },
            "types": {
                "href": "/api/v3/projects/1/types"
            },
            "versions": {
                "href": "/api/v3/projects/1/versions"
            },
            "workPackages": {
                "href": "/api/v3/projects/1/work_packages"
            }
            "memberships": {
                "href": "/api/v3/memberships?filters=[{"project":{"operator":"=","values":["1"]}}]
            },
            "customField456": {
                "href": "/api/v3/users/315",
                "method": "A user"
            },
            "projects": {
              "href": "/api/v3/projects/123"
            }
        },
        "id": 1,
        "identifier": "project_identifier",
        "name": "Project example",
        "active": true,
        "public": false,
        "status": "on track",
        "statusExplanation": {
            "format": "markdown",
            "raw": "Everything **fine**",
            "html": "<p>Everything <strong>fine</strong></p>"
        },
        "description": {
            "format": "markdown",
            "raw": "Lorem **ipsum** dolor sit amet",
            "html": "<p>Lorem <strong>ipsum</strong> dolor sit amet</p>"
        },
        "createdAt": "2014-05-21T08:51:20Z",
        "updatedAt": "2014-05-21T08:51:20Z",
        "customField123": 123
    }
    
  • Response  400
  • Occurs when the client did not send a valid JSON object in the request body.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
      "message": "The request body was not a single JSON object."
    }
  • Response  403
  • Returned if the client does not have sufficient permissions.

    Required permission: add project which is a global permission

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
      "message": "You are not authorized to access this resource."
    }
  • Response  422
  • Returned if:

    • a constraint for a property was violated (PropertyConstraintViolation)
    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
      "message": "Name can't be blank.",
      "_embedded": {
        "details": {
          "attribute": "name"
        }
      }
    }

Projects schema 

View project schema
/api/v3/projects/schemas
  • Response  200
  • Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Schema",
      "_dependencies": [],
      "id": {
        "type": "Integer",
        "name": "ID",
        "required": true,
        "hasDefault": false,
        "writable": false
      },
      "name": {
        "type": "String",
        "name": "Name",
        "required": true,
        "hasDefault": false,
        "writable": true,
        "minLength": 1,
        "maxLength": 255
      },
      "identifier": {
        "type": "String",
        "name": "Identifier",
        "required": true,
        "hasDefault": false,
        "writable": true,
        "minLength": 1,
        "maxLength": 100
      },
      "description": {
        "type": "Formattable",
        "name": "Description",
        "required": false,
        "hasDefault": false,
        "writable": true
      },
      "public": {
        "type": "Boolean",
        "name": "Public",
        "required": true,
        "hasDefault": false,
        "writable": true
      },
      "active": {
        "type": "Boolean",
        "name": "Active",
        "required": true,
        "hasDefault": true,
        "writable": true
      },
      "status": {
        "type": "String",
        "name": "Status",
        "required": true,
        "hasDefault": true,
        "writable": true
      },
      "statusExplanation": {
        "type": "Formattable",
        "name": "Status explanation",
        "required": false,
        "hasDefault": false,
        "writable": true
      },
      "parent": {
        "type": "Project",
        "name": "Subproject of",
        "required": false,
        "hasDefault": false,
        "writable": true,
        "visibility": "default",
        "_links": {}
      },
      "createdAt": {
        "type": "DateTime",
        "name": "Created on",
        "required": true,
        "hasDefault": false,
        "writable": false
      },
      "updatedAt": {
        "type": "DateTime",
        "name": "Updated on",
        "required": true,
        "hasDefault": false,
        "writable": false
      },
      "customField30": {
        "type": "Integer",
        "name": "Integer project custom field",
        "required": false,
        "hasDefault": false,
        "writable": true,
        "visibility": "default"
      },
      "customField31": {
        "type": "CustomOption",
        "name": "List project custom field",
        "required": false,
        "hasDefault": false,
        "writable": true,
        "visibility": "default",
        "_links": {}
      },
      "customField32": {
        "type": "Version",
        "name": "Version project custom field",
        "required": false,
        "hasDefault": false,
        "writable": true,
        "visibility": "default",
        "_links": {}
      },
      "customField34": {
        "type": "Boolean",
        "name": "Boolean project custom field",
        "required": false,
        "hasDefault": false,
        "writable": true,
        "visibility": "default"
      },
      "customField35": {
        "type": "String",
        "name": "Text project custom field",
        "required": true,
        "hasDefault": false,
        "writable": true,
        "visibility": "default"
      },
      "_links": {
        "self": {
          "href": "/api/v3/projects/schema"
        }
      }
    }

Project create form 

This endpoint returns a form allowing a guided creation of new projects.

For more details and all possible responses see the general specification of Forms.

Project create form
/api/v3/projects/form
  • Request  Create project form
  • Body
    {
      "identifier": "new_project_identifier",
      "name": "New project name",
      "customField35": "Text custom field value"
    }
  • Response  200
  • Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Form",
      "_embedded": {
        "payload": {
          "identifier": "new_project_identifier",
          "name": "New project name",
          "active": true,
          "public": false,
          "description": {
            "format": "markdown",
            "raw": null,
            "html": ""
          },
          "customField30": null,
          "customField34": null,
          "customField35": "Text custom field value",
          "customField41": {
            "format": "markdown",
            "raw": "",
            "html": ""
          },
          "customField42": null,
          "status": null,
          "statusExplanation": {
            "format": "markdown",
            "raw": null,
            "html": "<p></p>"
          },
          "_links": {
            "customField26": {
              "href": null,
              "title": null
            },
            "customField31": {
              "href": null,
              "title": null
            },
            "parent": {
              "href": null
            }
          }
        },
        "schema": {
          "_type": "Schema",
          "_dependencies": [],
          "id": {
            "type": "Integer",
            "name": "ID",
            "required": true,
            "hasDefault": false,
            "writable": false
          },
          "name": {
            "type": "String",
            "name": "Name",
            "required": true,
            "hasDefault": false,
            "writable": true,
            "minLength": 1,
            "maxLength": 255
          },
          "identifier": {
            "type": "String",
            "name": "Identifier",
            "required": true,
            "hasDefault": false,
            "writable": true,
            "minLength": 1,
            "maxLength": 100
          },
          "description": {
            "type": "Formattable",
            "name": "Description",
            "required": false,
            "hasDefault": false,
            "writable": true
          },
          "public": {
            "type": "Boolean",
            "name": "Public",
            "required": true,
            "hasDefault": false,
            "writable": true
          },
          "active": {
            "type": "Boolean",
            "name": "Active",
            "required": true,
            "hasDefault": true,
            "writable": true
          },
          "status": {
            "type": "String",
            "name": "Status",
            "required": true,
            "hasDefault": true,
            "writable": true
          },
          "parent": {
            "type": "Project",
            "name": "Subproject of",
            "required": false,
            "hasDefault": false,
            "writable": true,
            "visibility": "default",
            "_links": {
              "allowedValues": {
                "href": "/api/v3/projects/available_parent_projects"
              }
            }
          },
          "createdAt": {
            "type": "DateTime",
            "name": "Created on",
            "required": true,
            "hasDefault": false,
            "writable": false
          },
          "updatedAt": {
            "type": "DateTime",
            "name": "Updated on",
            "required": true,
            "hasDefault": false,
            "writable": false
          },
          "customField26": {
            "type": "User",
            "name": "Project user",
            "required": false,
            "hasDefault": false,
            "writable": true,
            "visibility": "default",
            "_links": {
              "allowedValues": {
                "href": "/api/v3/principals?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22%21%22%2C%22values%22%3A%5B%220%22%2C%223%22%5D%7D%7D%2C%7B%22type%22%3A%7B%22operator%22%3A%22%3D%22%2C%22values%22%3A%5B%22User%22%5D%7D%7D%2C%7B%22member%22%3A%7B%22operator%22%3A%22%3D%22%2C%22values%22%3A%5B%22%22%5D%7D%7D%5D&pageSize=0"
              }
            }
          },
          "customField30": {
            "type": "Integer",
            "name": "some project cf",
            "required": false,
            "hasDefault": false,
            "writable": true,
            "visibility": "default"
          },
          "customField31": {
            "type": "CustomOption",
            "name": "list project cf",
            "required": false,
            "hasDefault": false,
            "writable": true,
            "visibility": "default",
            "_embedded": {
              "allowedValues": [
                {
                  "_type": "CustomOption",
                  "id": 513,
                  "value": "abc",
                  "_links": {
                    "self": {
                      "href": "/api/v3/custom_options/513",
                      "title": "abc"
                    }
                  }
                },
                {
                  "_type": "CustomOption",
                  "id": 514,
                  "value": "def",
                  "_links": {
                    "self": {
                      "href": "/api/v3/custom_options/514",
                      "title": "def"
                    }
                  }
                },
                {
                  "_type": "CustomOption",
                  "id": 515,
                  "value": "ghi",
                  "_links": {
                    "self": {
                      "href": "/api/v3/custom_options/515",
                      "title": "ghi"
                    }
                  }
                }
              ]
            },
            "_links": {
              "allowedValues": [
                {
                  "href": "/api/v3/custom_options/513",
                  "title": "abc"
                },
                {
                  "href": "/api/v3/custom_options/514",
                  "title": "def"
                },
                {
                  "href": "/api/v3/custom_options/515",
                  "title": "ghi"
                }
              ]
            }
          },
          "customField34": {
            "type": "Boolean",
            "name": "Bool Project CF",
            "required": false,
            "hasDefault": false,
            "writable": true,
            "visibility": "default"
          },
          "customField35": {
            "type": "String",
            "name": "text project cf",
            "required": true,
            "hasDefault": false,
            "writable": true,
            "visibility": "default"
          },
          "customField41": {
            "type": "Formattable",
            "name": "Long text project cf",
            "required": false,
            "hasDefault": false,
            "writable": true,
            "visibility": "default"
          },
          "customField42": {
            "type": "Date",
            "name": "Date project cf",
            "required": false,
            "hasDefault": false,
            "writable": true,
            "visibility": "default"
          },
          "_links": {}
        },
        "validationErrors": {
          "identifier": {
            "_type": "Error",
            "errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
            "message": "Identifier has already been taken.",
            "_embedded": {
              "details": {
                "attribute": "identifier"
              }
            }
          }
        }
      },
      "_links": {
        "self": {
          "href": "/api/v3/projects/form",
          "method": "post"
        },
        "validate": {
          "href": "/api/v3/projects/form",
          "method": "post"
        }
      }
    }
  • Response  400
  • Occurs when the client did not send a valid JSON object in the request body.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
      "message": "The request body was not a single JSON object."
    }
  • Response  403
  • Returned if the client does not have sufficient permissions.

    Required permission: add project which is a global permission

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
      "message": "You are not authorized to access this resource."
    }

Project update form 

This endpoint returns a form allowing a guided modification of existing projects. The returned payload part of the form will be contain a merge between the already existing properties’ values (as long as they are writeable) and the provided values with the later having precedence.

For more details and all possible responses see the general specification of Forms.

Project update form
/api/v3/projects/{id}/form
  • Request  Update project form
  • Body
    {
      "identifier": "new_project_identifier",
      "name": "New project name",
      "customField35": "Text custom field value"
    }
  • Response  200
  • Headers
    Content-Type: application/hal+json
    Body
    {
        "_type": "Form",
        "_embedded": {
            "payload": {
                "identifier": "new_project_identifier",
                "name": "New project name",
                "active": true,
                "public": false,
                "description": {
                    "format": "markdown",
                    "raw": null,
                    "html": ""
                },
                "customField30": null,
                "customField34": null,
                "customField35": "Text custom field value",
                "customField41": {
                    "format": "markdown",
                    "raw": "",
                    "html": ""
                },
                "customField42": null,
                "status": "at risk",
                "statusExplanation": {
                    "format": "markdown",
                    "raw": "There is some risk of failure",
                    "html": "<p>There is some risk of failure</p>"
                },
                "_links": {
                    "customField26": {
                        "href": null,
                        "title": null
                    },
                    "customField31": {
                        "href": null,
                        "title": null
                    },
                    "parent": {
                        "href": "/api/v3/projects/45"
                    }
                }
            },
            "schema": {
                "_type": "Schema",
                "_dependencies": [],
                "id": {
                    "type": "Integer",
                    "name": "ID",
                    "required": true,
                    "hasDefault": false,
                    "writable": false
                },
                "name": {
                    "type": "String",
                    "name": "Name",
                    "required": true,
                    "hasDefault": false,
                    "writable": true,
                    "minLength": 1,
                    "maxLength": 255
                },
                "identifier": {
                    "type": "String",
                    "name": "Identifier",
                    "required": true,
                    "hasDefault": false,
                    "writable": true,
                    "minLength": 1,
                    "maxLength": 100
                },
                "description": {
                    "type": "Formattable",
                    "name": "Description",
                    "required": false,
                    "hasDefault": false,
                    "writable": true
                },
                "public": {
                    "type": "Boolean",
                    "name": "Public",
                    "required": true,
                    "hasDefault": false,
                    "writable": true
                },
                "active": {
                    "type": "Boolean",
                    "name": "Active",
                    "required": true,
                    "hasDefault": true,
                    "writable": true,
                },
                "status": {
                    "type": "String",
                    "name": "Status",
                    "required": true,
                    "hasDefault": true,
                    "writable": true,
                },
                "parent": {
                    "type": "Project",
                    "name": "Subproject of",
                    "required": false,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default",
                    "_links": {
                        "allowedValues": {
                            "href": "/api/v3/projects/available_parent_projects?of=123"
                        }
                    }
                },
                "createdAt": {
                    "type": "DateTime",
                    "name": "Created on",
                    "required": true,
                    "hasDefault": false,
                    "writable": false
                },
                "updatedAt": {
                    "type": "DateTime",
                    "name": "Updated on",
                    "required": true,
                    "hasDefault": false,
                    "writable": false
                },
                "customField26": {
                    "type": "User",
                    "name": "Project user",
                    "required": false,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default",
                    "_links": {
                        "allowedValues": {
                            "href": "/api/v3/principals?filters=%5B%7B%22status%22%3A%7B%22operator%22%3A%22%21%22%2C%22values%22%3A%5B%220%22%2C%223%22%5D%7D%7D%2C%7B%22type%22%3A%7B%22operator%22%3A%22%3D%22%2C%22values%22%3A%5B%22User%22%5D%7D%7D%2C%7B%22member%22%3A%7B%22operator%22%3A%22%3D%22%2C%22values%22%3A%5B%22%22%5D%7D%7D%5D&pageSize=0"
                        }
                    }
                },
                "customField30": {
                    "type": "Integer",
                    "name": "some project cf",
                    "required": false,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default"
                },
                "customField31": {
                    "type": "CustomOption",
                    "name": "list project cf",
                    "required": false,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default",
                    "_embedded": {
                        "allowedValues": [
                            {
                                "_type": "CustomOption",
                                "id": 513,
                                "value": "abc",
                                "_links": {
                                    "self": {
                                        "href": "/api/v3/custom_options/513",
                                        "title": "abc"
                                    }
                                }
                            },
                            {
                                "_type": "CustomOption",
                                "id": 514,
                                "value": "def",
                                "_links": {
                                    "self": {
                                        "href": "/api/v3/custom_options/514",
                                        "title": "def"
                                    }
                                }
                            },
                            {
                                "_type": "CustomOption",
                                "id": 515,
                                "value": "ghi",
                                "_links": {
                                    "self": {
                                        "href": "/api/v3/custom_options/515",
                                        "title": "ghi"
                                    }
                                }
                            }
                        ]
                    },
                    "_links": {
                        "allowedValues": [
                            {
                                "href": "/api/v3/custom_options/513",
                                "title": "abc"
                            },
                            {
                                "href": "/api/v3/custom_options/514",
                                "title": "def"
                            },
                            {
                                "href": "/api/v3/custom_options/515",
                                "title": "ghi"
                            }
                        ]
                    }
                },
                "customField34": {
                    "type": "Boolean",
                    "name": "Bool Project CF",
                    "required": false,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default"
                },
                "customField35": {
                    "type": "String",
                    "name": "text project cf",
                    "required": true,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default"
                },
                "customField41": {
                    "type": "Formattable",
                    "name": "Long text project cf",
                    "required": false,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default"
                },
                "customField42": {
                    "type": "Date",
                    "name": "Date project cf",
                    "required": false,
                    "hasDefault": false,
                    "writable": true,
                    "visibility": "default"
                },
                "_links": {}
            },
            "validationErrors": {
                "identifier": {
                    "_type": "Error",
                    "errorIdentifier": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation",
                    "message": "Identifier has already been taken.",
                    "_embedded": {
                        "details": {
                            "attribute": "identifier"
                        }
                    }
                }
            }
        },
        "_links": {
            "self": {
                "href": "/api/v3/projects/5/form",
                "method": "post"
            },
            "validate": {
                "href": "/api/v3/projects/5/form",
                "method": "post"
            }
        }
    }
  • Response  400
  • Occurs when the client did not send a valid JSON object in the request body.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:InvalidRequestBody",
      "message": "The request body was not a single JSON object."
    }
  • Response  403
  • Returned if the client does not have sufficient permissions.

    Required permission: edit projects in the project

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
      "message": "You are not authorized to access this resource."
    }

Available parent project candidates 

List available parent project candidates
/api/v3/projects/available_parent_projects{?filters,of,sortBy}

Lists projects which can become parent to another project. Only sound candidates are returned. For instance a project cannot become parent of itself or it’s children.

To specify the project for which a parent is queried for, the of parameter can be provided. If no of parameter is provided, a new project is assumed. Then, the check for the hierarchy is omitted as a new project cannot be part of a hierarchy yet.

Candidates can be filtered. Most commonly one will want to filter by name or identifier. You can do this through the filters parameter which works just like the work package index.

For instance to find all parent candidates with “rollout” in their name:

?filters=[{"name_and_identifier":{"operator":"~","values":["rollout"]}}]
  • Parameters
  • filters
    string (optional) Example: [{ "ancestor": { "operator": "=", "values": ['1'] }" }]

    JSON specifying filter conditions.

    of
    number or identifier (optional) Example: 123

    The id or identifier of the project the parent candidate is determined for

    sortBy
    string (optional) Example: [["id", "asc"]]

    JSON specifying sort criteria. Accepts the same format as returned by the queries endpoint and allows all the filters and sortBy supported by the project list end point.

  • Response  200
  • Headers
    Content-Type: application/hal+json
    Body
    {
      "_links": {
        "self": {
          "href": "/api/v3/projects/available_parent_projects?of=123"
        }
      },
      "_type": "Collection",
      "total": 2,
      "count": 2,
      "_embedded": {
        "elements": [
          {
            "_type": "Project",
            "_links": {
              "self": {
                "href": "/api/v3/projects/6",
                "title": "A project"
              },
              "createWorkPackage": {
                "href": "/api/v3/projects/6/work_packages/form",
                "method": "post"
              },
              "createWorkPackageImmediate": {
                "href": "/api/v3/projects/6/work_packages",
                "method": "post"
              },
              "categories": {
                "href": "/api/v3/projects/6/categories"
              },
              "versions": {
                "href": "/api/v3/projects/6/versions"
              }
            },
            "id": 6,
            "identifier": "a_project",
            "name": "A project",
            "active": true,
            "status": "on track",
            "statusExplanation": {
                "format": "markdown",
                "raw": "Everything **fine**",
                "html": "<p>Everything <strong>fine</strong></p>"
            },
            "public": false,
            "description": {
                "format": "markdown",
                "raw": "Lorem **ipsum** dolor sit amet",
                "html": "<p>Lorem <strong>ipsum</strong> dolor sit amet</p>"
            },
            "createdAt": "2015-07-06T13:28:14+00:00",
            "updatedAt": "2015-10-01T09:55:02+00:00",
            "type": "Customer Project"
          },
          {
            "_type": "Project",
            "_links": {
              "self": {
                "href": "/api/v3/projects/14",
                "title": "Another project"
              },
              "createWorkPackage": {
                "href": "/api/v3/projects/14/work_packages/form",
                "method": "post"
              },
              "createWorkPackageImmediate": {
                "href": "/api/v3/projects/14/work_packages",
                "method": "post"
              },
              "categories": {
                "href": "/api/v3/projects/14/categories"
              },
              "versions": {
                "href": "/api/v3/projects/14/versions"
              }
            },
            "id": 14,
            "identifier": "another_project",
            "name": "Another project",
            "active": true,
            "status": "on track",
            "statusExplanation": {
                "format": "markdown",
                "raw": "Everything super **fine**",
                "html": "<p>Everything super <strong>fine</strong></p>"
            },
            "public": true,
            "description": {
                "format": "markdown",
                "raw": "",
                "html": ""
            },
            "createdAt": "2016-02-29T12:50:20+00:00",
            "updatedAt": "2016-02-29T12:50:20+00:00",
            "type": null
          }]
        }
      }
    }
  • Response  403
  • Returned if the client does not have sufficient permissions.

    Required permission: edit project in a project or the global add project permission

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
      "message": "You are not authorized to access this resource."
    }

Projects by version 

List projects with version
/api/v3/versions/{id}/projects

This endpoint lists the projects where the given version is available.

The projects returned depend on the sharing settings of the given version, but are also limited to the projects that the current user is allowed to see.

  • Parameters
  • id
    integer (required) Example: 1

    Version id

  • Response  200
  • Headers
    Content-Type: application/hal+json
    Body
    {
      "_links": {
        "self": {
          "href": "/api/v3/versions/2/projects"
        }
      },
      "total": 1,
      "count": 1,
      "_type": "Collection",
      "_embedded": {
        "elements": [
          {
            "_type": "Project",
            "_links": {
              "self": {
                "href": "/api/v3/projects/1",
                "title": "Lorem"
              },
              "categories": {
                "href": "/api/v3/projects/1/categories"
              },
              "versions": {
                "href": "/api/v3/projects/1/versions"
              }
            },
            "id": 1,
            "identifier": "project_identifier",
            "name": "Project example",
            "description": {
              "format": "markdown",
              "raw": "Lorem **ipsum** dolor sit amet",
              "html": "<p>Lorem <strong>ipsum</strong> dolor sit amet</p>"
            },
            "active": true,
            "status": "on track",
            "statusExplanation": {
              "format": "markdown",
              "raw": "Everything **fine**",
              "html": "<p>Everything <strong>fine</strong></p>"
            },
            "createdAt": "2014-05-21T08:51:20Z",
            "updatedAt": "2014-05-21T08:51:20Z"
          }
        ]
      }
    }
  • Response  404
  • Returned if the version does not exist or the client does not have sufficient permissions to see it.

    Required permission: view work packages or manage versions (any project where the given version is available)

    Note: A client without sufficient permissions shall not be able to test for the existence of a version. That’s why a 404 is returned here, even if a 403 might be more appropriate.

    Headers
    Content-Type: application/hal+json
    Body
    {
      "_type": "Error",
      "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
      "message": "The specified version does not exist."
    }