openproject/docs/api/apiv3/components/schemas/project_model.yml

# Schema: ProjectModel
---
type: object
properties:
  id:
    type: integer
    description: Projects' id
    minimum: 0
    exclusiveMinimum: true
  identifier:
    type: string
  name:
    type: string
  active:
    type: boolean
    description: Indicates whether the project is currently active or already archived
  statusExplanation:
    allOf:
    - "$ref": "./formattable.yml"
    - description: A text detailing and explaining why the project has the reported
        status
  public:
    type: boolean
    description: Indicates whether the project is accessible for everybody
  description:
    allOf:
    - "$ref": "./formattable.yml"
    - {}
  createdAt:
    type: string
    format: date-time
    description: Time of creation
    readOnly: true
  updatedAt:
    type: string
    format: date-time
    description: Time of the most recent change to the project
    readOnly: true
  _links:
    type: object
    required:
    - self
    - categories
    - types
    - versions
    - memberships
    - workPackages
    properties:
      update:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Form endpoint that aids in updating this project

            # Conditions

            **Permission**: edit project            
          readOnly: true
      updateImmediately:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Directly update this project

            # Conditions

            **Permission**: edit project            
          readOnly: true
      delete:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Delete this project

            # Conditions

            **Permission**: admin            
          readOnly: true
      createWorkPackage:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Form endpoint that aids in preparing and creating a work package

            # Conditions

            **Permission**: add work packages            
          readOnly: true
      createWorkPackageImmediately:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Directly creates a work package in the project

            # Conditions

            **Permission**: add work packages            
          readOnly: true
      self:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            This project

            **Resource**: Project            
          readOnly: true
      categories:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Categories available in this project

            **Resource**: Collection            
          readOnly: true
      types:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Types available in this project

            **Resource**: Collection

            # Conditions

            **Permission**: view work packages or manage types            
          readOnly: true
      versions:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Versions available in this project

            **Resource**: Collection

            # Conditions

            **Permission**: view work packages or manage versions            
          readOnly: true
      memberships:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Memberships in the  project

            **Resource**: Collection

            # Conditions

            **Permission**: view members            
          readOnly: true
      workPackages:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Work Packages of this project

            **Resource**: Collection            
          readOnly: true
      parent:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Parent project of the project

            **Resource**: Project

            # Conditions

            **Permission** edit project            
      status:
        allOf:
        - "$ref": "./link.yml"
        - description: |-
            Denotes the status of the project, so whether the project is on track, at risk or is having trouble.

            **Resource**: ProjectStatus

            # Conditions

            **Permission** edit project