Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Save note

PUT
/api/v1/ttx/{ttx_id}/run/notes

Write the note on an inject (or the general one); empty deletes it. Answers all the caller’s notes as as.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
as
Any of:
string
<= 16 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
RunNoteWrite

The note on an inject (inject_code) or the general one (“”): its whole text – empty deletes it.

object
inject_code
Inject Code
string
"" <= 16 characters
room_code
Any of:
string
<= 16 characters
text
Text
string
"" <= 10000 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
RunNoteListResponse
object
items
required
Items
Array<object>
RunNoteRead
object
id
required
Id
string format: uuid
inject_code
required
Inject Code
string
room_code
Room Code
string
""
text
required
Text
string
updated_at
required
Updated At
string format: date-time

Example 

{
  "items": [
    {
      "room_code": ""
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}