Checklists

The published portal's Task list blocks. Tasks are written in the builder; progress belongs to each tenant and is what progress get / progress update / progress delete read and change. The progress file commands handle the file a tenant uploads for a Request task.

Command	HTTP	Description
`checklists list`	`GET /v1/checklists`	List checklists
`checklists get`	`GET /v1/checklists/{id}`	Get checklist
`checklists progress get`	`GET /v1/checklists/{id}/progress`	Get tenant progress
`checklists progress update`	`PUT /v1/checklists/{id}/progress`	Update tenant progress
`checklists progress delete`	`DELETE /v1/checklists/{id}/progress`	Reset tenant progress
`checklists progress file get`	`GET /v1/checklists/{id}/progress/file`	Download task file
`checklists progress file create`	`POST /v1/checklists/{id}/progress/file`	Upload task file
`checklists progress file delete`	`DELETE /v1/checklists/{id}/progress/file`	Remove task file

Examples

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List checklists
kobana dashboards checklists list --fields "id,title,page_path"

# Get tenant progress
kobana dashboards checklists progress get \
  --params '{"id": "CHECKLIST_ID", "tenant_id": "TENANT_ID"}'

# Update tenant progress
kobana dashboards checklists progress update \
  --params '{"id": "CHECKLIST_ID"}' \
  --json '{"tenant_id": "TENANT_ID", "task_ids": ["TASK_ID"], "status": "done"}'

# Download task file
kobana dashboards checklists progress file get \
  --params '{"id": "CHECKLIST_ID", "tenant_id": "TENANT_ID", "task_id": "TASK_ID"}' \
  --output arquivo.pdf

Next steps

Comments
Portal builder
Schema introspection — every parameter this resource accepts.

Examples​

Next steps​

Examples

Next steps