API: Root

The root resource contains links to available resources in the API. By following these links a client should be able to discover further resources in the API.

Note: Currently there is no list action for projects available. A client will therefore have to know links to projects and can’t (yet) discover them.

Link	Description	Type	Supported operations	Condition
configuration	The configuration of this OpenProject instance	Configuration	READ
user	The user currently logged-in	User	READ	logged in
userPreferences	The preferences of the logged-in user	UserPreference	READ	logged in
priorities	List of available priorities	Collection	READ	Permission View work packages in any project
statuses	List of available work package statuses	Collection	READ	Permission View work packages in any project
types	List of available work package types	Collection	READ	Permission View work packages in any project
workPackages	List of all work packages	Collection	READ	Permission View work packages in any project
users	List of all users	Collection	READ	Permission Administrator

Local Properties

Property	Description	Type	Condition	Supported operations
instanceName	The name of the OpenProject instance	String		READ
coreVersion	The OpenProject core version number for the instance	String	Permission requires admin privileges	READ

Methods

View root

Returns the root resource, containing basic information about the server instance and a collection of useful links.

No parameters

200

RootModel

{
  "type": "object",
  "required": [
    "_type",
    "instanceName",
    "_links"
  ],
  "properties": {
    "_type": {
      "type": "string",
      "enum": [
        "Root"
      ]
    },
    "instanceName": {
      "type": "string",
      "description": "The name of the OpenProject instance"
    },
    "coreVersion": {
      "type": "string",
      "description": "The OpenProject core version number for the instance\n\n# Conditions\n\n**Permission** requires admin privileges"
    },
    "_links": {
      "type": "object",
      "required": [
        "self",
        "configuration",
        "memberships",
        "priorities",
        "relations",
        "statuses",
        "time_entries",
        "types",
        "user",
        "userPreferences",
        "workPackages"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This root information object.\n\n**Resource**: Root"
            }
          ]
        },
        "configuration": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The configuration resource.\n\n**Resource**: Configuration"
            }
          ]
        },
        "memberships": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The collection of memberships.\n\n**Resource**: Collection"
            }
          ]
        },
        "priorities": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The collection of priorities.\n\n**Resource**: Collection"
            }
          ]
        },
        "relations": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The collection of relations.\n\n**Resource**: Collection"
            }
          ]
        },
        "statuses": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The collection of statuses.\n\n**Resource**: Collection"
            }
          ]
        },
        "time_entries": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The collection of time entries.\n\n**Resource**: Collection"
            }
          ]
        },
        "types": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The collection of types.\n\n**Resource**: Collection"
            }
          ]
        },
        "user": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The current user resource.\n\n**Resource**: User"
            }
          ]
        },
        "userPreferences": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The current user preferences resource.\n\n**Resource**: UserPreferences"
            }
          ]
        },
        "workPackages": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The work package collection.\n\n**Resource**: Collection"
            }
          ]
        }
      }
    }
  },
  "example": {
    "_type": "Root",
    "instanceName": "OpenProject",
    "coreVersion": "12.1.0",
    "_links": {
      "self": {
        "href": "/api/v3"
      },
      "configuration": {
        "href": "/api/v3/configuration"
      },
      "memberships": {
        "href": "/api/v3/memberships"
      },
      "priorities": {
        "href": "/api/v3/priorities"
      },
      "relations": {
        "href": "/api/v3/relations"
      },
      "statuses": {
        "href": "/api/v3/statuses"
      },
      "time_entries": {
        "href": "/api/v3/time_entries"
      },
      "types": {
        "href": "/api/v3/types"
      },
      "user": {
        "href": "/api/v3/users/3",
        "title": "Anakin Skywalker"
      },
      "userPreferences": {
        "href": "/api/v3/users/3/preferences"
      },
      "workPackages": {
        "href": "/api/v3/work_packages"
      }
    }
  }
}