API ReferenceChecklist

Create

Creates a new checklist with the provided checks and functions.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
commitMessagestringRequired
assigneeRidstringRequired
titlestringRequired
descriptionstringRequired
functionsmap from strings to objectsRequired

The keys of the map are references that can be used for checks to reference functions in the same request, before the function RIDs have been created.

checkslist of objectsRequired
propertiesmap from strings to stringsRequired
labelsset of stringsRequired
checklistVariableslist of objectsRequired

Variables that can be used in checks and functions. Variables are resolved in order of declaration. If variable a depends on variable b, then b must be defined before a in the list.

isPublishedbooleanOptional

Default value is true.

workspacestringOptional

The workspace in which to create the checklist. If not provided, the checklist will be created in the default workspace for the user’s organization, if the default workspace for the organization is configured.

Response

This endpoint returns an object.
ridstring
metadataobject
commitobject
functionslist of objects

A list of functions that are available to be used by checks in this checklist.

checkslist of objects
checklistVariableslist of objects

Variables that can be used in checks and functions. Variables are resolved in order of declaration. If variable a depends on variable b, then b must be defined before a in the list.