Task Status

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/cgwire/zou/llms.txt

Use this file to discover all available pages before exploring further.

​

Introduction

​

Task Status Structure

​

Model Fields

{
  "id": "a24a6ea4-ce75-4665-a070-57453082c25",
  "name": "Work In Progress",
  "short_name": "wip",
  "description": "Task is being actively worked on",
  "color": "#3498db",
  "priority": 3,
  "is_done": false,
  "is_artist_allowed": true,
  "is_client_allowed": false,
  "is_retake": false,
  "is_feedback_request": false,
  "is_default": false,
  "is_wip": true,
  "for_concept": false,
  "archived": false,
  "shotgun_id": null,
  "created_at": "2024-01-10T09:00:00Z",
  "updated_at": "2024-01-10T09:00:00Z"
}

​

Field Descriptions

• name: Display name (e.g., “Work In Progress”, “Waiting for Approval”)
• short_name: Abbreviated code for UI (e.g., “wip”, “wfa”, “done”)
• description: Explanation of what this status means
• color: Hex color for visual identification (#RRGGBB format)
• priority: Display order (lower numbers shown first)
• is_done: Marks task as completed
• is_artist_allowed: Artists can set tasks to this status
• is_client_allowed: Clients can set tasks to this status
• is_retake: Marks task as requiring rework
• is_feedback_request: Marks task as submitted for review
• is_default: Used as initial status for new tasks
• is_wip: Marks task as actively in progress
• for_concept: Status is for concept tasks only
• archived: Hidden from active use when true

​

Standard Task Statuses

​

Todo

{
  "name": "Todo",
  "short_name": "todo",
  "color": "#f5f5f5",
  "is_default": true,
  "is_artist_allowed": true,
  "is_client_allowed": false
}

​

Work In Progress (WIP)

{
  "name": "Work In Progress",
  "short_name": "wip",
  "color": "#3498db",
  "is_wip": true,
  "is_artist_allowed": true,
  "is_client_allowed": false
}

​

Waiting for Approval

{
  "name": "Waiting for Approval",
  "short_name": "wfa",
  "color": "#f39c12",
  "is_feedback_request": true,
  "is_artist_allowed": true,
  "is_client_allowed": false
}

​

Retake

{
  "name": "Retake",
  "short_name": "retake",
  "color": "#ff3860",
  "is_retake": true,
  "is_artist_allowed": false,
  "is_client_allowed": false
}

​

Done

{
  "name": "Done",
  "short_name": "done",
  "color": "#22d160",
  "is_done": true,
  "is_artist_allowed": false,
  "is_client_allowed": false
}

​

Concept Task Statuses

​

Neutral

{
  "name": "Neutral",
  "short_name": "neutral",
  "color": "#CCCCCC",
  "is_default": true,
  "for_concept": true
}

​

To Review

{
  "name": "To Review",
  "short_name": "pndng",
  "color": "#f39c12",
  "is_feedback_request": true,
  "for_concept": true
}

​

Approved/Rejected

[
  {
    "name": "Approved",
    "short_name": "approved",
    "color": "#22d160",
    "is_done": true,
    "for_concept": true
  },
  {
    "name": "Rejected",
    "short_name": "rejected",
    "color": "#ff3860",
    "is_retake": true,
    "for_concept": true
  }
]

​

Status Behavior Flags

​

is_done

• Sets done_date when transitioning to this status
• Excludes task from active work queries
• Used in completion statistics
• Typically restricted from artist access

​

is_feedback_request

• Sets end_date on first transition to this status
• Triggers review notifications
• Used to filter tasks requiring feedback
• Often allows artist access for submissions

​

is_retake

• Increments retake_count on transition from non-retake status
• Tracks quality and iteration metrics
• Usually supervisor/manager only

​

is_wip

• Sets real_start_date on first transition to WIP status
• Distinguishes planned vs actively worked tasks
• Used for capacity and workload tracking

​

is_default

• Only one default status per concept/standard type
• Standard tasks use “Todo” as default
• Concept tasks use “Neutral” as default

​

is_artist_allowed

• When true: Artists can set tasks to this status
• When false: Only supervisors/managers can set this status
• Use for final approval statuses (Done, Retake)

​

is_client_allowed

• When true: Clients can set tasks to this status
• When false: Clients cannot set this status
• Useful for client review workflows

​

Managing Task Statuses

​

Create or Get Status

from zou.app.services import tasks_service

status = tasks_service.get_or_create_status(
    name="Work In Progress",
    short_name="wip",
    color="#3498db",
    is_wip=True,
    is_artist_allowed=True,
    is_client_allowed=False
)

status = tasks_service.get_or_create_status(
    name="To Review",
    short_name="pndng",
    color="#f39c12",
    is_feedback_request=True,
    for_concept=True
)

​

List All Statuses

statuses = tasks_service.get_task_statuses()

GET /api/data/task-status

​

Get Status Details

status = tasks_service.get_task_status(status_id)

​

Update Status

status = tasks_service.update_task_status(status_id, {
    "color": "#3498db",
    "priority": 2,
    "description": "Updated description"
})

PUT /api/data/task-status/{status_id}

{
  "color": "#3498db",
  "priority": 2
}

​

Status Automation

​

Real Start Date

if new_status.is_wip and task.real_start_date is None:
    task.real_start_date = datetime.utcnow()

​

End Date

if new_status.is_feedback_request and task.end_date is None:
    task.end_date = datetime.utcnow()

​

Done Date

if new_status.is_done:
    task.done_date = datetime.utcnow()

​

Retake Count

if new_status.is_retake and not previous_status.is_retake:
    task.retake_count += 1

​

Status Filtering

​

Get Tasks by Status

GET /api/data/tasks/open-tasks?task_status_id={status_id}

​

Get Tasks Requiring Feedback

from zou.app.services import tasks_service

tasks = tasks_service.get_person_tasks_to_check(
    project_ids=["project-id"],
    department_ids=["dept-id"]
)

​

Get Done Tasks

GET /api/data/persons/{person_id}/done-tasks

​

Workflow Examples

​

Standard Production Flow

Todo → WIP → Waiting for Approval → Done

1. Task created with “Todo” status
2. Artist starts work, sets to “WIP” (sets real_start_date)
3. Artist completes work, sets to “Waiting for Approval” (sets end_date)
4. Supervisor approves, sets to “Done” (sets done_date)

​

Retake Flow

WIP → Waiting for Approval → Retake → WIP → Waiting for Approval → Done

1. Task submitted for review with “Waiting for Approval”
2. Supervisor finds issues, sets to “Retake” (increments retake_count)
3. Artist fixes issues, sets back to “WIP”
4. Artist resubmits with “Waiting for Approval”
5. Supervisor approves, sets to “Done”

​

Concept Review Flow

Neutral → To Review → Approved

Neutral → To Review → Rejected → To Review → Approved

​

Priority and Ordering

[
  {"name": "Todo", "priority": 1},
  {"name": "WIP", "priority": 2},
  {"name": "Waiting for Approval", "priority": 3},
  {"name": "Retake", "priority": 4},
  {"name": "Done", "priority": 5}
]

​

Best Practices

​

Naming Conventions

• Use clear, action-oriented names
• short_name should be 2-10 characters
• Keep naming consistent across projects

​

Color Coding

• Gray/White: Not started (Todo, Neutral)
• Blue: In progress (WIP)
• Yellow/Orange: Review needed (Waiting for Approval)
• Red: Issues/Retakes
• Green: Completed (Done, Approved)

​

Permission Configuration

• is_artist_allowed=true: Todo, WIP, Waiting for Approval
• is_artist_allowed=false: Done, Retake (supervisor only)
• is_client_allowed=true: Rarely used, mostly for client review statuses

​

Automation Flags

• One is_default=true status for standard tasks
• One is_default=true, for_concept=true status for concepts
• is_wip=true for primary working status
• is_feedback_request=true for review status
• is_retake=true for rejection status
• is_done=true for completion status

​

Archiving

{
  "archived": true
}

​

Related Resources

• Tasks Overview - Task lifecycle and workflow
• Task Types - Task categorization
• Task Endpoints - Complete API reference
• Comments API - Status change comments