Session Comment

Data Structures

SessionCommentModel

Attribute	Type	Required	Description
id	string		Read-only. Unique.
parent_id	string		Immutable.
session_id	string	yes	ID of the session to comment. Immutable.
text	string	yes	Text content of the session comment.
start_at	datetime	yes	Value format: time. Expensive to use.
finish_at	datetime	yes	Value format: time. Expensive to use.
created_at	datetime		Read-only. Timestamp of creation.
modified_at	datetime		Read-only. Timestamp of modification.
modified_by	string		Read-only.
modified_by_name	string		Read-only. Expensive to use.
removed	boolean		Read-only.

Retrieve Available Attributes of the SessionCommentModel

Request

Method	GET
Path	/api/v2/objspec/session_comment

GET /api/v2/objspec/session_comment

Example Request

curl -s -k -X GET \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  'https://10.0.214.98/api/v2/objspec/session_comment'

Get Session Comments

Request

Method	GET
Path	/api/v2/session/<session_id>/comment

GET /api/v2/session/<session_id>/comment

Example Request

curl -s -k -X GET \
     -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
     'https://10.31.92.108/api/v2/session/8169529724050079753/comment'

Response

{
    "result": "success",
    "session_comment": [
        {
            "id": "8169529724050079745",
            "session_id": "8169529724050079753",
            "text": "Comment no 1",
            "start_at": "00:00:14",
            "finish_at": "00:00:15",
            "created_at": "2025-07-08 14:19:29.001496-07",
            "modified_at": "2025-07-08 14:19:29.001496-07",
            "modified_by": "8169529724050079745",
            "modified_by_name": "admin"
        },
        {
            "id": "8169529724050079746",
            "session_id": "8169529724050079753",
            "text": "Comment no 2",
            "start_at": "00:00:26",
            "finish_at": "00:00:27",
            "created_at": "2025-07-08 14:19:57.31709-07",
            "modified_at": "2025-07-08 14:19:57.31709-07",
            "modified_by": "8169529724050079745",
            "modified_by_name": "admin"
        }
    ]
}

Get Session Comment by ID

Request

Method	GET
Path	/api/v2/session/<session_id>/comment/<id>

GET /api/v2/session/<session_id>/comment/<id>

Example Request

curl -s -k -X GET \
     -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
     'https://10.31.92.108/api/v2/session/8169529724050079753/comment/8169529724050079746'

Response

{
    "result": "success",
    "session_comment": [
        {
            "id": "8169529724050079746",
            "session_id": "8169529724050079753",
            "text": "Comment no 2",
            "start_at": "00:00:26",
            "finish_at": "00:00:27",
            "created_at": "2025-07-08 14:19:57.31709-07",
            "modified_at": "2025-07-08 14:19:57.31709-07",
            "modified_by": "8169529724050079745",
            "modified_by_name": "admin"
        }
    ]
}

Add Session Comment

Request

Method	POST
Path	/api/v2/session/<session_id>/comment
Headers	Content-Type: Application/json
Body	SessionCommentModel

POST /api/v2/session/<session_id>/comment

Example Request

curl -s -k -X POST \
  -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
  -H 'Content-Type: application/json' \
  https://10.31.92.108/api/v2/session/4665729213955833865/comment \
  -d '{"text": "Text content of the session comment.","start_at":"00:01:00","finish_at":"00:01:00"}'

Response

{
    "result": "success",
    "session_comment": {
        "id": "4665729213955833859"
    }
}

Modify Session Comment

Request

Method	PATCH
Path	/api/v2/session/<session_id>/comment/<id>
Headers	Content-Type: Application/json
Body	SessionCommentModel

PATCH /api/v2/session/<session_id>/comment/<id>

Example Request

curl -s -k -X PATCH \
     -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
         -H 'Content-Type: application/json' \
         https://10.31.92.108/api/v2/session/8169529724050079753/comment/8169529724050079746 \
         -d '{"text": "Changed session comment content.","start_at":"00:01:00","finish_at":"00:01:00"}'

Response

{
    "result": "success"
}

Delete Session Comment

Request

Method	DELETE
Path	/api/v2/session/<session_id>/comment/<id>

DELETE /api/v2/session/<session_id>/comment/<id>

Example Request

curl -s -k -X DELETE \
     -H 'Authorization: sgfeea6jsaz4mum9su8w6' \
     'https://10.31.92.108/api/v2/session/8169529724050079753/comment/8169529724050079746'

Response

{
    "result": "success"
}