API: Custom Objects

Linked Properties

Link Description Type Constraints Supported operations
self This custom object CustomObject not null READ

Local Properties

Property Description Type Constraints Supported operations
id The identifier Integer   READ
value The value defined for this custom object String   READ

Custom objects are options of list custom fields.

Methods

View custom object

id
integer

required path

The custom object’s identifier

Example:
1

200

OK

{
  "_links": {
    "self": {
      "href": "/api/v3/custom_objects/1"
    }
  },
  "_type": "CustomObject",
  "value": "Foo"
}

Custom_ObjectModel

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "The identifier",
      "readOnly": true
    },
    "value": {
      "type": "string",
      "description": "The value defined for this custom object",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This custom object\n\n**Resource**: CustomObject",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "example": {
    "_links": {
      "self": {
        "href": "/api/v3/custom_objects/1"
      }
    },
    "_type": "CustomObject",
    "value": "Foo"
  }
}

404

Returned if the custom object does not exist or the client does not have sufficient permissions to see it.

Required permission: view work package in any project the custom object’s custom field is active in.

{
  "_type": "Error",
  "errorIdentifier": "urn:openproject-org:api:v3:errors:NotFound",
  "message": "The requested resource could not be found."
}