ChecklistNode

A Checklist Node model used for checklist payloads.

Required properties:

id – Identifier of the Checklist Node
name – Checklist node name
parentId – Identifier of the checklist parent. It can be set to null when it's root checklist.
sfi – SFI Code (only if has been set for node)

Properties:

Property	Type	Format	Required	Description
`id`	`string`	`uuid`	true	Identifier of the checklist node
`name`	`string`		true	Checklist name
`parentId`	`string`	`uuid`	true*	Identifier of the checklist parent
`sfi`	`string`		true*	SFI Code
`status`	`number`	`float`	false	Checklist status. Available statuses: `unknown`, `incomplete`, `inProgress`, `complete`, `verified`, `irrelevant`
`progress`	`number`	`float`	false	Current progress
`hoursPlanned`	`number`	`float`	false	Planned hours
`hoursSpent`	`number`	`float`	false	Spent hours
`notes`	`string`		false	Notes
`description`	`string`		false	Description
`relevantURL`	`string`		false	Relevant URL
`externalId`	`string`		false	External identifier (available to set for integration purposes)
`dueDate`	`string`	`date-time`	false	Due date in UTC format (ISO_8601)
`plannedStartDate`	`string`	`date-time`	false	Planned start date in UTC format (ISO_8601)
`startedAt`	`string`	`date-time`	false	Start date UTC format (ISO_8601)
`completedAt`	`string`	`date-time`	false	Completion date in UTC format (ISO_8601)
`verifiedAt`	`string`	`date-time`	false	Verification date in UTC format (ISO_8601)

Example:

{
    "id": "3f582b1f-0ea4-46aa-b6c2-03a68b8e7805",
    "parentId": "e5ac0f71-591f-4d1d-8373-f5a394e799ee",
    "name": "Some checklists update",
    "sfi": "2.22.00030",
    "progress": "50",
    "externalId": "1",
    "status": "incomplete",
    "dueDate": null,
    "hoursPlanned": null,
    "hoursSpent": null,
    "notes": null,
    "description": null,
    "relevantURL": null,
    "plannedStartDate": null,
    "startedAt": null,
    "completedAt": null,
    "verifiedAt": null
  }

results matching ""

No results matching ""