REST API on Taskschmiede

Approvals

Mon, 01 Jan 0001 00:00:00 +0000

Approval decisions

Endpoints

Method	Path	Summary
`GET`	`/api/v1/approvals`	List approvals
`POST`	`/api/v1/approvals`	Create approval
`GET`	`/api/v1/approvals/{id}`	Get approval

List approvals

GET /api/v1/approvals

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`entity_type`	query	string
`entity_id`	query	string

Responses

Code	Description
`200`	Approval list

Create approval

POST /api/v1/approvals

Requires authentication.

Request Body

Field	Type	Required
`comment`	string
`entity_id`	string	Yes
`entity_type`	string	Yes
`metadata`	object
`role`	string
`verdict`	string	Yes

Responses

Code	Description
`201`	Approval created

Get approval

GET /api/v1/approvals/{id}

Artifacts

Mon, 01 Jan 0001 00:00:00 +0000

Documents, links, and deliverables

Endpoints

Method	Path	Summary
`GET`	`/api/v1/artifacts`	List artifacts
`POST`	`/api/v1/artifacts`	Create artifact
`GET`	`/api/v1/artifacts/{id}`	Get artifact
`PATCH`	`/api/v1/artifacts/{id}`	Update artifact

List artifacts

GET /api/v1/artifacts

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`endeavour_id`	query	string
`task_id`	query	string
`kind`	query	string
`search`	query	string

Responses

Code	Description
`200`	Artifact list

Create artifact

POST /api/v1/artifacts

Auth

Mon, 01 Jan 0001 00:00:00 +0000

Authentication and user profile

Endpoints

Method	Path	Summary
`POST`	`/api/v1/auth/change-password`	Change password
`POST`	`/api/v1/auth/forgot-password`	Request password reset
`POST`	`/api/v1/auth/login`	Login
`POST`	`/api/v1/auth/logout`	Logout (invalidate token)
`PATCH`	`/api/v1/auth/profile`	Update profile
`POST`	`/api/v1/auth/register`	Register new user
`POST`	`/api/v1/auth/resend-verification`	Resend verification code
`POST`	`/api/v1/auth/reset-password`	Reset password with code
`POST`	`/api/v1/auth/verify`	Verify email with code
`GET`	`/api/v1/auth/whoami`	Get current user profile with tier info

Change password

POST /api/v1/auth/change-password

Requires authentication.

Request Body

Field	Type	Required	Description
`current_password`	string	Yes
`new_password`	string	Yes

Responses

Code	Description
`200`	Password changed
`400`

Request password reset

POST /api/v1/auth/forgot-password

Comments

Mon, 01 Jan 0001 00:00:00 +0000

Discussion on any entity

Endpoints

Method	Path	Summary
`GET`	`/api/v1/comments`	List comments
`POST`	`/api/v1/comments`	Create comment
`GET`	`/api/v1/comments/{id}`	Get comment
`PATCH`	`/api/v1/comments/{id}`	Update comment
`DELETE`	`/api/v1/comments/{id}`	Delete comment (soft delete)

List comments

GET /api/v1/comments

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`entity_type`	query	string
`entity_id`	query	string

Responses

Code	Description
`200`	Comment list

Create comment

POST /api/v1/comments

Demands

Mon, 01 Jan 0001 00:00:00 +0000

Work requests (stories, bugs, spikes, etc.)

Endpoints

Method	Path	Summary
`GET`	`/api/v1/demands`	List demands
`POST`	`/api/v1/demands`	Create demand
`GET`	`/api/v1/demands/{id}`	Get demand
`PATCH`	`/api/v1/demands/{id}`	Update demand

List demands

GET /api/v1/demands

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`status`	query	string
`endeavour_id`	query	string
`type`	query	string
`priority`	query	string
`search`	query	string

Responses

Code	Description
`200`	Demand list

Create demand

POST /api/v1/demands

DoD

Mon, 01 Jan 0001 00:00:00 +0000

Definition of Done policies and endorsements

Endpoints

Method	Path	Summary
`GET`	`/api/v1/dod-endorsements`	List endorsements
`POST`	`/api/v1/dod-endorsements`	Create endorsement
`GET`	`/api/v1/dod-policies`	List DoD policies
`POST`	`/api/v1/dod-policies`	Create DoD policy
`GET`	`/api/v1/dod-policies/{id}`	Get DoD policy
`PATCH`	`/api/v1/dod-policies/{id}`	Update DoD policy
`GET`	`/api/v1/dod-policies/{id}/lineage`	Get policy version lineage
`POST`	`/api/v1/dod-policies/{id}/versions`	Create new policy version
`POST`	`/api/v1/endeavours/{id}/dod-policy`	Assign DoD policy to endeavour
`DELETE`	`/api/v1/endeavours/{id}/dod-policy`	Unassign DoD policy from endeavour
`GET`	`/api/v1/endeavours/{id}/dod-status`	Get endeavour DoD status
`POST`	`/api/v1/tasks/{id}/dod-check`	Check task DoD compliance
`POST`	`/api/v1/tasks/{id}/dod-override`	Override DoD for task

List endorsements

GET /api/v1/dod-endorsements

Endeavours

Mon, 01 Jan 0001 00:00:00 +0000

Goal-oriented work containers

Endpoints

Method	Path	Summary
`GET`	`/api/v1/endeavours`	List endeavours
`POST`	`/api/v1/endeavours`	Create endeavour
`GET`	`/api/v1/endeavours/{id}`	Get endeavour
`PATCH`	`/api/v1/endeavours/{id}`	Update endeavour
`GET`	`/api/v1/endeavours/{id}/archive`	Preview archive impact
`POST`	`/api/v1/endeavours/{id}/archive`	Archive endeavour
`GET`	`/api/v1/endeavours/{id}/export`	Export endeavour data

List endeavours

GET /api/v1/endeavours

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`status`	query	string
`organization_id`	query	string
`search`	query	string

Responses

Code	Description
`200`	Endeavour list

Create endeavour

POST /api/v1/endeavours

Messages

Mon, 01 Jan 0001 00:00:00 +0000

Internal messaging

Endpoints

Method	Path	Summary
`GET`	`/api/v1/messages`	List inbox
`POST`	`/api/v1/messages`	Send message
`GET`	`/api/v1/messages/{id}`	Get message
`PATCH`	`/api/v1/messages/{id}`	Mark message as read
`POST`	`/api/v1/messages/{id}/reply`	Reply to message
`GET`	`/api/v1/messages/{id}/thread`	Get message thread

List inbox

GET /api/v1/messages

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`unread`	query	string

Responses

Code	Description
`200`	Inbox messages

Send message

POST /api/v1/messages

Organizations

Mon, 01 Jan 0001 00:00:00 +0000

Organizational units

Endpoints

Method	Path	Summary
`GET`	`/api/v1/organizations`	List organizations
`POST`	`/api/v1/organizations`	Create organization
`GET`	`/api/v1/organizations/{id}`	Get organization
`PATCH`	`/api/v1/organizations/{id}`	Update organization
`GET`	`/api/v1/organizations/{id}/alert-terms`	List alert terms
`PUT`	`/api/v1/organizations/{id}/alert-terms`	Update alert terms
`GET`	`/api/v1/organizations/{id}/archive`	Preview archive impact
`POST`	`/api/v1/organizations/{id}/archive`	Archive organization
`POST`	`/api/v1/organizations/{id}/endeavours`	Add endeavour to organization
`GET`	`/api/v1/organizations/{id}/export`	Export organization data
`POST`	`/api/v1/organizations/{id}/resources`	Add resource to organization

List organizations

GET /api/v1/organizations

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`search`	query	string

Responses

Code	Description
`200`	Organization list

Create organization

POST /api/v1/organizations

Relations

Mon, 01 Jan 0001 00:00:00 +0000

Entity relationships

Endpoints

Method	Path	Summary
`GET`	`/api/v1/relations`	List relations
`POST`	`/api/v1/relations`	Create relation
`DELETE`	`/api/v1/relations/{id}`	Delete relation

List relations

GET /api/v1/relations

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`entity_type`	query	string
`entity_id`	query	string

Responses

Code	Description
`200`	Relation list

Create relation

POST /api/v1/relations

Requires authentication.

Request Body

Field	Type	Required
`metadata`	object
`relationship_type`	string	Yes
`source_entity_id`	string	Yes
`source_entity_type`	string	Yes
`target_entity_id`	string	Yes
`target_entity_type`	string	Yes

Responses

Code	Description
`201`	Relation created

Delete relation

DELETE /api/v1/relations/{id}

Reports

Mon, 01 Jan 0001 00:00:00 +0000

Report generation

Endpoints

Method	Path	Summary
`GET`	`/api/v1/reports/{scope}/{id}`	Generate report
`POST`	`/api/v1/reports/{scope}/{id}/email`	Email report

Generate report

GET /api/v1/reports/{scope}/{id}

Requires authentication.

Parameters

Name	In	Type	Required	Description
`scope`	path	string	Yes
``		string

Responses

Code	Description
`200`	Generated report

Email report

POST /api/v1/reports/{scope}/{id}/email

Requires authentication.

Parameters

Name	In	Type	Required	Description
`scope`	path	string	Yes
``		string

Responses

Code	Description
`200`	Report emailed

Resources

Mon, 01 Jan 0001 00:00:00 +0000

People, teams, and other capacity units

Endpoints

Method	Path	Summary
`GET`	`/api/v1/resources`	List resources
`POST`	`/api/v1/resources`	Create resource
`GET`	`/api/v1/resources/{id}`	Get resource
`PATCH`	`/api/v1/resources/{id}`	Update resource
`DELETE`	`/api/v1/resources/{id}`	Delete resource

List resources

GET /api/v1/resources

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`type`	query	string
`endeavour_id`	query	string
`organization_id`	query	string
`search`	query	string

Responses

Code	Description
`200`	Resource list

Create resource

POST /api/v1/resources

RitualRuns

Mon, 01 Jan 0001 00:00:00 +0000

Ritual execution records

Endpoints

Method	Path	Summary
`GET`	`/api/v1/ritual-runs`	List ritual runs
`POST`	`/api/v1/ritual-runs`	Create ritual run
`GET`	`/api/v1/ritual-runs/{id}`	Get ritual run
`PATCH`	`/api/v1/ritual-runs/{id}`	Update ritual run

List ritual runs

GET /api/v1/ritual-runs

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`ritual_id`	query	string
`status`	query	string

Responses

Code	Description
`200`	Ritual run list

Create ritual run

POST /api/v1/ritual-runs

Rituals

Mon, 01 Jan 0001 00:00:00 +0000

Recurring process templates

Endpoints

Method	Path	Summary
`GET`	`/api/v1/rituals`	List rituals
`POST`	`/api/v1/rituals`	Create ritual
`GET`	`/api/v1/rituals/{id}`	Get ritual
`PATCH`	`/api/v1/rituals/{id}`	Update ritual
`POST`	`/api/v1/rituals/{id}/fork`	Fork ritual (create new version)
`GET`	`/api/v1/rituals/{id}/lineage`	Get ritual version lineage

List rituals

GET /api/v1/rituals

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`endeavour_id`	query	string
`search`	query	string

Responses

Code	Description
`200`	Ritual list

Create ritual

POST /api/v1/rituals

Tasks

Mon, 01 Jan 0001 00:00:00 +0000

Atomic units of work

Endpoints

Method	Path	Summary
`GET`	`/api/v1/tasks`	List tasks
`POST`	`/api/v1/tasks`	Create task
`GET`	`/api/v1/tasks/{id}`	Get task
`PATCH`	`/api/v1/tasks/{id}`	Update task

List tasks

GET /api/v1/tasks

Requires authentication.

Parameters

Name	In	Type	Description
``		string
``		string
`status`	query	string
`endeavour_id`	query	string
`assignee_id`	query	string	Use ‘me’ to filter by current user
`demand_id`	query	string
`search`	query	string
`unassigned`	query	string
`summary`	query	string	Return status counts instead of list

Responses

Code	Description
`200`	Task list

Create task

POST /api/v1/tasks

Templates

Mon, 01 Jan 0001 00:00:00 +0000

Reusable templates

Endpoints

Method	Path	Summary
`GET`	`/api/v1/templates`	List templates
`POST`	`/api/v1/templates`	Create template
`GET`	`/api/v1/templates/{id}`	Get template
`PATCH`	`/api/v1/templates/{id}`	Update template
`POST`	`/api/v1/templates/{id}/fork`	Fork template
`GET`	`/api/v1/templates/{id}/lineage`	Get template lineage

List templates

GET /api/v1/templates

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`scope`	query	string
`search`	query	string

Responses

Code	Description
`200`	Template list

Create template

POST /api/v1/templates

Users

Mon, 01 Jan 0001 00:00:00 +0000

User management

Endpoints

Method	Path	Summary
`GET`	`/api/v1/users`	List users (admin)
`POST`	`/api/v1/users`	Create user (admin)
`GET`	`/api/v1/users/{id}`	Get user
`PATCH`	`/api/v1/users/{id}`	Update user
`POST`	`/api/v1/users/{id}/endeavours`	Add user to endeavour

List users (admin)

GET /api/v1/users

Requires authentication.

Parameters

Name	In	Type
``		string
``		string
`status`	query	string
`user_type`	query	string
`search`	query	string

Responses

Code	Description
`200`	User list

Create user (admin)

POST /api/v1/users