Checklist Resource¶

Get Checklist¶

HTTP Request

GET /api/checklists/{id}

📋 Description: Retrieves the details of a specific checklist identified by its unique ID, enabling users to access and review checklist information for effective task management.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ChecklistDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string"
}

Update Checklist¶

HTTP Request

PUT /api/checklists/{id}

📋 Description: Updates the specified checklist identified by its unique ID, allowing for modifications to its content and status to enhance task management and team collaboration.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	ChecklistDTO	true	Request body containing the updated checklist details, including title, description, and status, to ensure accurate tracking and management of tasks.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Delete Checklist¶

HTTP Request

DELETE /api/checklists/{id}

📋 Description: Deletes a specified checklist by its unique identifier, ensuring the removal of associated tasks and data from the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

Get All Checklists¶

HTTP Request

GET /api/checklists

📋 Description: Fetches a list of available checklists, enabling users to efficiently manage and review tasks within their operational workflows.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "description": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ChecklistDTO]	false	none	[Data transfer object representing a checklist used for task management and compliance verification, facilitating streamlined operations and ensuring adherence to business standards.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» name	string	false	none	Name of the resource
» description	string	false	none	Description of the resource

Create Checklist¶

HTTP Request

POST /api/checklists

📋 Description: Creates a new checklist entry in the system, enabling users to organize tasks and streamline project management processes.

Parameters

Name	In	Type	Required	Description
body	body	ChecklistDTO	true	Request body containing the checklist details, including title, description, and associated tasks for effective project management.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	integer

Example Responses