TimelineNoteResponse

Fields

10 fields

can_edit · required

boolean

created_at

string or null

created_by_name

string or null

ends_on · required

string

id · required

string

project_id · required

string

starts_on · required

string

suite_name

string or null

text · required

string

updated_at

string or null

Raw schema (JSON)

{
  "properties": {
    "can_edit": {
      "title": "Can Edit",
      "type": "boolean"
    },
    "created_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created At"
    },
    "created_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Created By Name"
    },
    "ends_on": {
      "title": "Ends On",
      "type": "string"
    },
    "id": {
      "title": "Id",
      "type": "string"
    },
    "project_id": {
      "title": "Project Id",
      "type": "string"
    },
    "starts_on": {
      "title": "Starts On",
      "type": "string"
    },
    "suite_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Suite Name"
    },
    "text": {
      "title": "Text",
      "type": "string"
    },
    "updated_at": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Updated At"
    }
  },
  "required": [
    "id",
    "project_id",
    "starts_on",
    "ends_on",
    "text",
    "can_edit"
  ],
  "title": "TimelineNoteResponse",
  "type": "object"
}

Used by endpoints

3 endpoints send or return this schema, on its own or inside another schema.

• POST /api/v1/projects/{project_id}/timeline-notes — Create Timeline Note
• PATCH /api/v1/projects/{project_id}/timeline-notes/{note_id} — Update Timeline Note
• GET /api/v1/projects/{project_id}/timeline-notes — List Timeline Notes

Used by schemas

• TimelineNoteList

More details

• Specification: OpenAPI JSON