Create

Description

Create a note on the storyboard. Story or Group ID must be provided. If change control is enabled on the story the request will be performed on the test story.

Request

HTTP Method: POST

Parameter Description
story_id Optional ID of story to which the note should be added.
group_id Optional ID of group to which the note should be added.
content The note Markdown formatted content.
position Optional An object describing the XY coordinates of the position on the story diagram.

Sample request

curl -X POST \
  https://<<META.tenant.domain>>/api/v1/notes/ \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'
  -d '{
        "story_id": 813,
        "content": "# Header\n This is a list \n - item 1"
      }'

Response

A successful request will return a JSON object describing the created note.

Field description

Parameter Description
id The note ID.
story_id ID of story to which the note belongs.
story_mode Mode of the story to which the note belongs LIVE or TEST
group_id ID of group to which the note belongs.
content The note Markdown formatted content.
position An object describing the XY coordinates of the position on the story diagram.

Sample response

{
  "id": 21405,
  "story_id": 813,
  "story_mode": "LIVE",
  "group_id": null,
  "position": {
    "x": 0,
    "y": 0
  },
  "content": "# Header\n This is a list \n - item 1"
}
Was this helpful?