ケースコメントの管理🔗
ケースのコメントを追加、更新、検索、削除します。コメントでは、ユーザーに通知するための @mentions がサポートされています。
コメントの追加🔗
ケースに新しいコメントを追加します。コメントには @mentions を含めることができ、メンションされたユーザーに通知が送信されます。
Mutation🔗
mutation addCaseComment($input: AddCaseComment!) {
addCaseComment(input: $input) {
id
comment
createdAt
authorId
mentionsIds
}
}
Variables🔗
{
"input": {
"caseId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"comment": "Found additional indicators of compromise. @sophos please review."
}
}
Response Example🔗
{
"data": {
"addCaseComment": {
"id": "550e8400-e29b-41d4-a716-446655440300",
"comment": "Found additional indicators of compromise. @sophos please review.",
"createdAt": "2024-08-14T16:00:00Z",
"authorId": "550e8400-e29b-41d4-a716-446655440010",
"mentionsIds": ["550e8400-e29b-41d4-a716-446655440020"]
}
}
}
コメントの更新🔗
既存のコメントを更新します。コメントを更新できるのはコメント作成者のみです。
Mutation🔗
mutation updateCaseComment($input: UpdateCaseCommentInput!) {
updateCaseComment(input: $input) {
id
comment
updatedAt
authorId
mentionsIds
}
}
Variables🔗
{
"input": {
"commentId": "550e8400-e29b-41d4-a716-446655440300",
"comment": "Found additional indicators of compromise and verified malware signatures. @sophos please review.",
"markAsRead": false
}
}
Response Example🔗
{
"data": {
"updateCaseComment": {
"id": "550e8400-e29b-41d4-a716-446655440300",
"comment": "Found additional indicators of compromise and verified malware signatures. @sophos please review.",
"updatedAt": "2024-08-14T16:15:00Z",
"authorId": "550e8400-e29b-41d4-a716-446655440010",
"mentionsIds": ["550e8400-e29b-41d4-a716-446655440020"]
}
}
}
注意🔗
- コメントを更新できるのはコメント作成者のみです。
markAsReadは、trueに設定すると、現在のユーザーに対してそのコメントを既読としてマークします。- 新しい @mentions を含めてコメントを更新すると、新しい通知がトリガーされますが、すでにメンションされているユーザーには再通知されません。
コメントの削除🔗
既存のコメントを削除します。コメントを削除できるのはコメント作成者のみです。
Mutation🔗
mutation deleteCaseComment($input: DeleteCaseCommentInput!) {
deleteCaseComment(input: $input) {
id
deletedAt
}
}
Variables🔗
Response Example🔗
{
"data": {
"deleteCaseComment": {
"id": "550e8400-e29b-41d4-a716-446655440300",
"deletedAt": "2024-08-14T16:20:00Z"
}
}
}
注意🔗
- これは完全削除です。データは復元できません。
- コメントを削除できるのはコメント作成者のみです。
コメントの検索とフィルタリング🔗
ページネーションを使用してケースのコメントを取得します。
Query🔗
query caseComments($arguments: CaseCommentsArguments!) {
caseComments(arguments: $arguments) {
comments {
id
authorId
createdAt
updatedAt
comment
mentionsIds
readByIds
}
totalCount
totalUnreadCount
}
}
Variables🔗
{
"arguments": {
"caseId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"orderBy": "DESCENDING",
"page": 1,
"perPage": 20
}
}
Response Example🔗
{
"data": {
"caseComments": {
"comments": [
{
"id": "550e8400-e29b-41d4-a716-446655440300",
"authorId": "550e8400-e29b-41d4-a716-446655440010",
"createdAt": "2024-08-14T16:00:00Z",
"updatedAt": "2024-08-14T16:15:00Z",
"comment": "Found additional indicators of compromise and verified malware signatures.",
"mentionsIds": ["550e8400-e29b-41d4-a716-446655440020"],
"readByIds": [
"550e8400-e29b-41d4-a716-446655440010",
"550e8400-e29b-41d4-a716-446655440020"
]
},
{
"id": "550e8400-e29b-41d4-a716-446655440301",
"authorId": "550e8400-e29b-41d4-a716-446655440020",
"createdAt": "2024-08-14T16:05:00Z",
"updatedAt": "2024-08-14T16:05:00Z",
"comment": "Confirmed. Escalating to SOC team.",
"mentionsIds": [],
"readByIds": ["550e8400-e29b-41d4-a716-446655440020"]
}
],
"totalCount": 2,
"totalUnreadCount": 0
}
}
}
注意🔗
caseCommentsは内部コメント以外のみを返します。内部のパートナー専用コメントが、お客様の呼び出し元に返されることはありません。totalUnreadCountはページネーションやorderByフィルターの影響を受けません。常に、現在のユーザーに対するケースの未読総数を反映します。
ページネーション🔗
コメントではオフセットベースのページネーションがサポートされています。
page: 1 から始まるページ番号（デフォルト: 1）perPage: 1 ページあたりの結果数、最大 100（デフォルト: 25）
コメントのメンション🔗
コメント内のメンションは、特定のユーザーまたはグループに通知します。通知をトリガーするには、コメントテキストに @mentions を含めます。
ユーザー ID とグループ ID🔗
メンションでは複数の形式を使用できます。
- ユーザー ID:
@を接頭辞として付けた特定のユーザーの UUID（例:@550e8400-e29b-41d4-a716-446655440010） - ユーザー名:
@username形式（お客様のテナントから解決されます） - グループ ID:
@を接頭辞として付けたチームまたはグループの UUID - グループ名:
@groupname形式（お客様のテナントから解決されます）
特殊メンション🔗
コメントでは、通知を特定のロールまたはチームにルーティングする特殊メンションがサポートされています。利用可否は、お客様のテナントタイプとサービスレベルによって異なります。
| Mention | 利用可能な場合 | 用途 |
|---|---|---|
@customer |
XDR テナント以外のみ | お客様の組織に通知 |
@admin |
Cases API を使用する XDR テナント | 管理者に通知 |
@authorized_contacts |
Taegis MDR テナントのみ | 承認された Taegis MDR 連絡先に通知 |
@sophos |
すべてのテナント（パートナー制限あり） | Sophos チームに通知 |
パートナー制限付きメンション（@sophos）は、サービス契約によっては利用できない場合があります。
お客様のサービスパートナーは、契約に固有のカスタムメンションを定義している場合があります。利用可能なメンションオプションについては、パートナーまたはアカウントチームにお問い合わせください。
ユーザー ID の検索🔗
お客様のテナントのユーザー ID を見つけるには、Users API を使用して利用可能なユーザーをクエリします。
メンションを含む例🔗
{
"input": {
"caseId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"comment": "@550e8400-e29b-41d4-a716-446655440020 please review. @customer this is for your information."
}
}
注意🔗
- メンションは、メンションされたユーザーまたはグループに通知をトリガーします。
- @mentions はコメントテキストから抽出され、レスポンスの
mentionsIdsに追加されます。 - 新しい @mentions を含めてコメントを更新すると、新しくメンションされたユーザーに通知がトリガーされます。
- コメントの以前のバージョンですでにメンションされているユーザーには再通知されません。
- 特殊メンションは、テナントタイプとサービス契約によって制限される場合があります。
コメントの並べ替え🔗
作成タイムスタンプでコメントを並べ替えます。
並べ替えオプション:
ASCENDING- 古い順（orderByを省略した場合のデフォルト）DESCENDING- 新しい順