api.jobs.on_hold.add_comment

POST /job/{jobDisplayId}/onhold/{onHoldId}/comment — ACPortal

Python

api.jobs.on_hold.add_comment(job_display_id: int, on_hold_id: str, *, data: OnHoldCommentRequest | dict) -> OnHoldNoteDetails

CLI

ab jobs on_hold add_comment <job_display_id> <on_hold_id> [--data ...]

Append a comment to an on-hold record.

Request model: :class:OnHoldCommentRequest.

Request body — OnHoldCommentRequest

Field

Type

Required

Description

comment

Optional[str]

no

Comment text

Response

Returns OnHoldNoteDetails.

Field

Type

Required

Description

id

Optional[str]

no

Comment ID

comment

Optional[str]

no

Comment text

author

Optional[str]

no

Author name

date

Optional[str]

no

Comment date


← Back to api.jobs