API: Statuses

Linked Properties

Link Description Type Constraints Supported operations
self This status Status not null READ

Local Properties

Property Description Type Constraints Supported operations
id Status id Integer x > 0 READ
name Status name String   READ
position Sort index of the status Integer   READ
isDefault   Boolean   READ
isClosed are tickets of this status considered closed? Boolean   READ
isReadonly are tickets of this status read only? Boolean   READ
defaultDoneRatio The percentageDone being applied when changing to this status Integer 0 <= x <= 100 READ

Methods

List all statuses

No parameters

200

OK

{
  "_embedded": {
    "elements": [
      {
        "_links": {
          "self": {
            "href": "/api/v3/statuses/1"
          }
        },
        "_type": "Status",
        "defaultDoneRatio": 0,
        "id": 1,
        "isClosed": false,
        "isDefault": true,
        "name": "New",
        "position": 1
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/statuses/3"
          }
        },
        "_type": "Status",
        "defaultDoneRatio": 75,
        "id": 3,
        "isClosed": false,
        "isDefault": false,
        "isReadonly": false,
        "name": "Resolved",
        "position": 3
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/statuses/4"
          }
        },
        "_type": "Status",
        "defaultDoneRatio": 25,
        "id": 4,
        "isClosed": false,
        "isDefault": false,
        "name": "Feedback",
        "position": 4
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/statuses/5"
          }
        },
        "_type": "Status",
        "defaultDoneRatio": 100,
        "id": 5,
        "isClosed": true,
        "isDefault": false,
        "name": "Closed",
        "position": 5
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/statuses/6"
          }
        },
        "_type": "Status",
        "defaultDoneRatio": 100,
        "id": 6,
        "isClosed": true,
        "isDefault": false,
        "name": "Rejected",
        "position": 6
      },
      {
        "_links": {
          "self": {
            "href": "/api/v3/statuses/2"
          }
        },
        "_type": "Status",
        "defaultDoneRatio": 50,
        "id": 2,
        "isClosed": false,
        "isDefault": false,
        "name": "In Progress",
        "position": 3
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/api/v3/statuses"
    }
  },
  "_type": "Collection",
  "count": 6,
  "total": 6
}

StatusesModel

{
  "type": "object",
  "example": {
    "_links": {
      "self": {
        "href": "/api/v3/statuses"
      }
    },
    "total": 6,
    "count": 6,
    "_type": "Collection",
    "_embedded": {
      "elements": [
        {
          "_links": {
            "self": {
              "href": "/api/v3/statuses/1"
            }
          },
          "_type": "Status",
          "id": 1,
          "name": "New",
          "position": 1,
          "isDefault": true,
          "isClosed": false,
          "defaultDoneRatio": 0
        },
        {
          "_links": {
            "self": {
              "href": "/api/v3/statuses/3"
            }
          },
          "_type": "Status",
          "id": 3,
          "name": "Resolved",
          "position": 3,
          "isDefault": false,
          "isClosed": false,
          "isReadonly": false,
          "defaultDoneRatio": 75
        },
        {
          "_links": {
            "self": {
              "href": "/api/v3/statuses/4"
            }
          },
          "_type": "Status",
          "id": 4,
          "name": "Feedback",
          "position": 4,
          "isDefault": false,
          "isClosed": false,
          "defaultDoneRatio": 25
        },
        {
          "_links": {
            "self": {
              "href": "/api/v3/statuses/5"
            }
          },
          "_type": "Status",
          "id": 5,
          "name": "Closed",
          "position": 5,
          "isDefault": false,
          "isClosed": true,
          "defaultDoneRatio": 100
        },
        {
          "_links": {
            "self": {
              "href": "/api/v3/statuses/6"
            }
          },
          "_type": "Status",
          "id": 6,
          "name": "Rejected",
          "position": 6,
          "isDefault": false,
          "isClosed": true,
          "defaultDoneRatio": 100
        },
        {
          "_links": {
            "self": {
              "href": "/api/v3/statuses/2"
            }
          },
          "_type": "Status",
          "id": 2,
          "name": "In Progress",
          "position": 3,
          "isDefault": false,
          "isClosed": false,
          "defaultDoneRatio": 50
        }
      ]
    }
  }
}

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 statuses."
}

View status

id
integer

required path

Status id

Example:
1

200

OK

{
  "_links": {
    "self": {
      "href": "/api/v3/statuses/1"
    }
  },
  "_type": "Status",
  "defaultDoneRatio": 0,
  "id": 1,
  "isClosed": false,
  "isDefault": true,
  "name": "New",
  "position": 1
}

StatusModel

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Status id",
      "readOnly": true,
      "minimum": 0,
      "exclusiveMinimum": true
    },
    "name": {
      "type": "string",
      "description": "Status name",
      "readOnly": true
    },
    "position": {
      "type": "integer",
      "description": "Sort index of the status",
      "readOnly": true
    },
    "isDefault": {
      "type": "boolean",
      "readOnly": true
    },
    "isClosed": {
      "type": "boolean",
      "description": "are tickets of this status considered closed?",
      "readOnly": true
    },
    "isReadonly": {
      "type": "boolean",
      "description": "are tickets of this status read only?",
      "readOnly": true
    },
    "defaultDoneRatio": {
      "type": "integer",
      "description": "The percentageDone being applied when changing to this status",
      "maximum": 100
    },
    "_links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This status\n\n**Resource**: Status",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "example": {
    "_links": {
      "self": {
        "href": "/api/v3/statuses/1"
      }
    },
    "_type": "Status",
    "id": 1,
    "name": "New",
    "position": 1,
    "isDefault": true,
    "isClosed": false,
    "defaultDoneRatio": 0
  }
}

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 status."
}