API: Priorities

The priorities endpoints return collections or single entities of type Priority. The following tables list the different properties of Priority entities.

Linked Properties

Link Description Type Constraints Supported operations
self This priority Priority not null READ

Local Properties

Property Description Type Constraints Supported operations
id Priority id Integer x > 0 READ
name Priority name String not empty READ
position Sort index of the priority Integer x > 0 READ
isDefault Indicates whether this is the default value Boolean READ
isActive Indicates whether the priority is available Boolean READ

Methods

List all priorities

No parameters

200

OK

{
  "_embedded": {
    "elements": [
      {
        "_links": {
          "self": {
            "href": "/api/v3/priorities/1",
            "title": "Low"
          }
        },
        "_type": "Priority",
        "id": 1,
        "isActive": true,
        "isDefault": false,
        "name": "Low",
        "position": 1
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/priorities/2",
            "title": "Normal"
          }
        },
        "_type": "Priority",
        "id": 2,
        "isActive": true,
        "isDefault": true,
        "name": "Normal",
        "position": 2
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/priorities/3",
            "title": "High"
          }
        },
        "_type": "Priority",
        "id": 3,
        "isActive": true,
        "isDefault": false,
        "name": "High",
        "position": 3
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/priorities/4",
            "title": "Immediate"
          }
        },
        "_type": "Priority",
        "id": 4,
        "isActive": true,
        "isDefault": false,
        "name": "Immediate",
        "position": 5
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/api/v3/priorities"
    }
  },
  "_type": "Collection",
  "count": 4,
  "total": 4
}
PriorityCollectionModel
{
  "allOf": [
    {
      "$ref": "#/components/schemas/CollectionModel"
    },
    {
      "type": "object",
      "required": [
        "_links",
        "_embedded"
      ],
      "properties": {
        "_links": {
          "type": "object",
          "required": [
            "self"
          ],
          "properties": {
            "self": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/Link"
                },
                {
                  "properties": {
                    "self": {
                      "allOf": [
                        {
                          "$ref": "#/components/schemas/Link"
                        },
                        {
                          "description": "This priority collection\n\n**Resource**: PriorityCollectionModel"
                        }
                      ]
                    }
                  }
                }
              ],
              "readOnly": true
            }
          }
        },
        "_embedded": {
          "type": "object",
          "required": [
            "elements"
          ],
          "properties": {
            "elements": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/PriorityModel"
              }
            }
          }
        }
      }
    }
  ]
}

403

Returned if the client does not have sufficient permissions.

Required permission: view work package (on any project)

{
  "_type": "Error",
  "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
  "message": "You are not allowed to see the priorities."
}
ErrorResponse
{
  "type": "object",
  "required": [
    "_type",
    "errorIdentifier",
    "message"
  ],
  "properties": {
    "_embedded": {
      "type": "object",
      "properties": {
        "details": {
          "type": "object",
          "properties": {
            "attribute": {
              "type": "string",
              "example": "project"
            }
          }
        }
      }
    },
    "_type": {
      "type": "string",
      "enum": [
        "Error"
      ]
    },
    "errorIdentifier": {
      "type": "string",
      "example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
    },
    "message": {
      "type": "string",
      "example": "Project can't be blank."
    }
  }
}

View priority

id
integer

required path

Priority id

Example:
1

200

OK

{
  "_links": {
    "self": {
      "href": "/api/v3/priorities/1",
      "title": "Low"
    }
  },
  "_type": "Priority",
  "id": 1,
  "isActive": true,
  "isDefault": false,
  "name": "Low",
  "position": 1
}
PriorityModel
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Priority id",
      "readOnly": true,
      "exclusiveMinimum": 0
    },
    "name": {
      "type": "string",
      "description": "Priority name",
      "readOnly": true,
      "minLength": 1
    },
    "position": {
      "type": "integer",
      "description": "Sort index of the priority",
      "readOnly": true,
      "exclusiveMinimum": 0
    },
    "isDefault": {
      "type": "boolean",
      "description": "Indicates whether this is the default value",
      "readOnly": true
    },
    "isActive": {
      "type": "boolean",
      "description": "Indicates whether the priority is available"
    },
    "_links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This priority\n\n**Resource**: Priority",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "example": {
    "_type": "Priority",
    "_links": {
      "self": {
        "href": "/api/v3/priorities/1",
        "title": "Low"
      }
    },
    "id": 1,
    "name": "Low",
    "position": 1,
    "isDefault": false,
    "isActive": true
  }
}

403

Returned if the client does not have sufficient permissions.

Required permission: view work package (on any project)

{
  "_type": "Error",
  "errorIdentifier": "urn:openproject-org:api:v3:errors:MissingPermission",
  "message": "You are not allowed to see this priority."
}
ErrorResponse
{
  "type": "object",
  "required": [
    "_type",
    "errorIdentifier",
    "message"
  ],
  "properties": {
    "_embedded": {
      "type": "object",
      "properties": {
        "details": {
          "type": "object",
          "properties": {
            "attribute": {
              "type": "string",
              "example": "project"
            }
          }
        }
      }
    },
    "_type": {
      "type": "string",
      "enum": [
        "Error"
      ]
    },
    "errorIdentifier": {
      "type": "string",
      "example": "urn:openproject-org:api:v3:errors:PropertyConstraintViolation"
    },
    "message": {
      "type": "string",
      "example": "Project can't be blank."
    }
  }
}