Valyourise Logo

ValYouRise

DevelopmentApi

Create workspace item

Creates a new objective, key result, or action inside the workspace and recomputes related progress values.

POST
/api/workspaces/{workspaceId}/items

Creates a new objective, key result, or action inside the workspace and recomputes related progress values.

PAT<token>

Personal Access Token

In: header

Path Parameters

workspaceId*string

Request Body

application/json

type*string
Value in"objective" | "key_result" | "action"
title*string
Length1 <= length <= 160
description?string
Lengthlength <= 5000
ownerUserId*string
assigneeUserIds?array<string>
parentId?string
dueDate?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
Formatdate-time
actionStatus?string
Value in"pending" | "work_in_progress" | "done"
storyPoints?string
Value in"0" | "1" | "2" | "3" | "5" | "8" | "13" | "21" | "40" | "?" | "∞"
sortOrder?number
positionX?number
positionY?number
[key: string]?never

Response Body

application/json

curl -X POST "https://loading/api/workspaces/string/items" \  -H "Content-Type: application/json" \  -d '{    "type": "objective",    "title": "string",    "ownerUserId": "string"  }'
{
  "$id": "string",
  "$sequence": 0,
  "$updatedAt": "string",
  "organizationId": "string",
  "workspaceId": "string",
  "type": "objective",
  "title": "string",
  "description": "string",
  "ownerUserId": "string",
  "assigneeUserIds": [
    "string"
  ],
  "parentId": "string",
  "dueDate": "string",
  "actionStatus": "pending",
  "storyPoints": "0",
  "progressComputed": 100,
  "sortOrder": 0,
  "positionX": 0,
  "positionY": 0,
  "visibility": "full",
  "deletedAt": "string",
  "deletedByUserId": "string"
}
Empty
Empty