Documentation Powered by ReDoc

Tocaro Web API (0.16.1)

Download OpenAPI specification:Download

概要

Tocaro Web API は、Tocaro の各種データについて外部からアクセスするための REST API です。

認証方式

OAuth 2.0 の Bearer Token を用いて API の認証を実現しています。

API を実行するときは、HTTP のリクエストヘッダーに Authorization を設定します。

Authorization: Bearer {Token}

Token キーに対して Scope を設定することで Readonly / Writeonly などの Access Control を付与することができます。

Scope Description Access Control
read グループ・連絡先・メッセージ・ファイル、タスクデータへの読み込みのみ可能 GET
write グループ・連絡先・メッセージ・ファイル、タスクデータへの書き込みのみ可能 POST/PUT/DELETE

HTTP ステータスコード

HTTP Status Code Reason
200
(OK)		 リクエストは成功
201
(Created)		 新規作成に成功
400
(Bad Request)		 リクエスト内容に誤りがある不正なリクエスト
401
(Unauthorized)		 Token切れや不正なToken
403
(Forbidden)		 権限を超えたエンドポイントにアクセスされたときに発生させるエラーコード
404
(Not Found)		 存在しないAPIへのアクセス
422
(Unprocessable Entity)		 バリデーションエラーが発生した場合
429
(Too many query)		 大量リクエストなどで制限に達した場合
500
(Internal Server Error)		 サーバーサイドにエラーが発生した場合

Authentication

bearerAuth

Security scheme type: HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Users

ユーザー関連の操作

契約内ユーザー検索

概要

  • Bot を作成したユーザーと同一の契約に所属しているユーザーを検索する
Authorizations:
bearerAuth
query Parameters
query
string

検索対象のメールアドレスもしくはユーザ名(前方一致)

page
integer [ 1 .. 100 ]
Default: 1

検索結果のページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

検索結果のデータ件数

Responses

200

OK

get /users
https://api.tocaro.im/users

Request samples

Copy
curl -X GET -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN' \
  https://api.tocaro.im/users

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "meta":
    {
    },
  • "users":
    [
    ]
}

Groups

グループデータ関連の操作

グループ検索

概要

Bot ユーザーが所属するグループの一覧を取得する

Authorizations:
bearerAuth
query Parameters
query
string

検索対象のグループ名

page
integer [ 1 .. 100 ]
Default: 1

検索結果のページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

検索結果のデータ件数

Responses

200

OK

get /groups
https://api.tocaro.im/groups

Request samples

Copy
curl -X GET -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN' \
  https://api.tocaro.im/groups

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "meta":
    {
    },
  • "groups":
    [
    ]
}

グループ新規作成

概要

  • グループ名を指定してグループを新規作成する

  • Bot および Bot を作成したユーザーをグループのオーナーとする

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string

作成するグループ名

purpose
string

グループの目的

Responses

201

Created

post /groups
https://api.tocaro.im/groups

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "API 連携テストグループ",
  • "purpose": "API の動作確認を実施するグループです。"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "gr11111111",
  • "name": "テストグループ",
  • "purpose": "API 連携の確認グループ",
  • "numMembers": 2,
  • "members":
    [
    ],
  • "owners":
    [
    ]
}

グループ招待

概要

  • グループコードとユーザコードを指定してグループにユーザを招待する
Authorizations:
bearerAuth
path Parameters
group
required
string
Example: grymgdhmlv
Request Body schema: application/json
members
Array of strings

グループメンバーのユーザーコード

Responses

201

Created

post /groups/{group}/invite
https://api.tocaro.im/groups/{group}/invite

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "members":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "gr11111111",
  • "name": "テストグループ",
  • "purpose": "API 連携の確認グループ",
  • "numMembers": 2,
  • "members":
    [
    ],
  • "owners":
    [
    ]
}

グループメンバー取得

概要

  • グループコードを指定してグループのメンバーを取得する
Authorizations:
bearerAuth
path Parameters
group
required
string
Example: grymgdhmlv

Responses

200

OK

get /groups/{group}/members
https://api.tocaro.im/groups/{group}/members

Request samples

Copy
curl -X GET https://api.tocaro.im/groups/$GROUP/members \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "us11111111",
  • "name": "API Testee",
  • "email": "string",
  • "guest": false,
  • "isDeleted": false,
  • "isOwner": false,
  • "isBot": false
}

Messages

メッセージ関連の操作

メッセージ投稿

概要

  • 対象のグループにメッセージを投稿する
Authorizations:
bearerAuth
Request Body schema: application/json
group
string

投稿先のグループコード( group/user のいずれかを指定 )

user
string

投稿先のユーザーコード( group/user のいずれかを指定 )

text
required
string

投稿するメッセージ メンションは<@user_code>で指定可能

attachments
Array of objects (Attachment)

メッセージの付加情報

Responses

201

Created

post /messages
https://api.tocaro.im/messages

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group": "grymgdhmlv",
  • "text": "<@user_code> Hello World!"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ts": 1567994783289,
  • "text": "Hello World!",
  • "mentions": [ ],
  • "user":
    {
    },
  • "group":
    {
    }
}

Files

ファイル関連の操作

ファイル検索

概要

  • ファイル一覧を取得する
Authorizations:
bearerAuth
query Parameters
group
string
Example: group=grxxxxxxxxx

グループコード

user
string
Example: user=usxxxxxxxxx

ユーザーコード

query
string
Example: query=%E3%83%86%E3%82%B9%E3%83%88

検索対象のリクエストタイトル

page
integer [ 1 .. 100 ]
Default: 1

検索結果のページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

検索結果のデータ件数

sort
string
Enum: "title" "createdAt"
Example: sort=createdAt

ソート対象カラム

order
string
Enum: "asc" "desc"
Example: order=desc

昇順 or 降順

Responses

200

OK

get /files
https://api.tocaro.im/files

Request samples

Copy
curl -X GET https://api.tocaro.im/files \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "meta":
    {
    },
  • "files":
    [
    ]
}

ファイルアップロード

概要

  • 対象のグループもしくはユーザーとのトークにファイルアップロードする
Authorizations:
bearerAuth
Request Body schema: multipart/form-data
file
required
string <binary>
group
string
user
string
initialComment
string

Responses

201

Created

post /files
https://api.tocaro.im/files

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group":
    {
    },
  • "file":
    {
    },
  • "comment":
    {
    }
}

ファイルコメント投稿

概要

  • ファイルコードを指定してファイルにコメントを投稿する
Authorizations:
bearerAuth
path Parameters
file
required
string
Example: flxxxxxxxx

ファイルコード

Request Body schema: application/json
text
required
string

コメント

Responses

201

Created

post /files/{file}/comments
https://api.tocaro.im/files/{file}/comments

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "text": "テストメッセージ"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "file":
    {
    },
  • "comment":
    {
    }
}

Requests

リクエスト(依頼書)関連の操作

リクエスト検索

概要

  • リクエスト一覧を取得する
Authorizations:
bearerAuth
query Parameters
group
required
string
Example: group=grxxxxxxxxx

グループコード

query
string
Example: query=%E3%83%86%E3%82%B9%E3%83%88

検索対象のリクエストタイトル

page
integer [ 1 .. 100 ]
Default: 1

検索結果のページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

検索結果のデータ件数

type
string
Enum: "action" "approval"
Example: type=action

リクエストタイプ

status
string
Enum: "draft" "inprogress" "rejected" "completed"
Example: status=inprogress

リクエストのステータス(複数指定の場合はカンマ区切りで指定)

sort
string
Enum: "title" "status" "createdAt"
Example: sort=createdAt

ソート対象カラム

order
string
Enum: "asc" "desc"
Example: order=desc

昇順 or 降順

Responses

200

OK

get /request-fors
https://api.tocaro.im/request-fors

Request samples

Copy
curl -X GET https://api.tocaro.im/request-fors?group=$GROUP \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "meta":
    {
    },
  • "requestFors":
    [
    ]
}

リクエスト作成

概要

  • リクエストを作成する
Authorizations:
bearerAuth
Request Body schema: application/json
group
required
string

グループコード

title
required
string [ 2 .. 50 ] characters

リクエストのタイトル

detail
required
string <= 3000 characters

リクエストの詳細

type
string
Default: "approval"
Enum: "action" "approval"

リクエストのタイプ

approvers
object (RequestApprovalAssignee)

承認者の指定(typeをapprovalで作成するときは必須)

workers
Array of strings

作業者の指定(typeをactionで作成するときは必須)

Responses

201

Created

post /request-fors
https://api.tocaro.im/request-fors

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group": "grxxxxxxxxx",
  • "title": "2023/04の月末処理の作業依頼",
  • "detail": "2023/4 の経費精算などの月末処理をお願いします",
  • "type": "action",
  • "approvers":
    {
    },
  • "workers":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "wfxxxxxxxx",
  • "title": "string",
  • "detail": "string",
  • "type": "action",
  • "status": "draft",
  • "rev": 0,
  • "currentSequence": 0,
  • "approvers":
    {
    },
  • "workers":
    {
    }
}

リクエストコメント投稿

概要

  • リクエストコードを指定してリクエストにコメントを投稿する
Authorizations:
bearerAuth
path Parameters
request
required
string
Example: wfxxxxxxxx

リクエストコード

Request Body schema: application/json
text
required
string

コメント

Responses

201

Created

post /request-fors/{request}/comments
https://api.tocaro.im/request-fors/{request}/comments

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "text": "テストメッセージ"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestFor":
    {
    },
  • "comment":
    {
    }
}

リクエストファイル添付

概要

  • リクエストコードを指定してリクエストにファイルを追加する
Authorizations:
bearerAuth
path Parameters
request
required
string
Example: wfxxxxxxxx

リクエストコード

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

201

Created

post /request-fors/{request}/attachments
https://api.tocaro.im/request-fors/{request}/attachments

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "requestFor":
    {
    },
  • "file":
    {
    }
}

Projects

プロジェクト関連の操作

プロジェクト検索

概要

  • プロジェクト一覧を取得する
Authorizations:
bearerAuth
query Parameters
group
required
string
Example: group=grxxxxxxxxx

グループコード

query
string
Example: query=%E3%83%86%E3%82%B9%E3%83%88

検索対象のプロジェクト名

page
integer [ 1 .. 100 ]
Default: 1

検索結果のページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

検索結果のデータ件数

sort
string
Enum: "name" "duetime"
Example: sort=name

ソート対象カラム

order
string
Enum: "asc" "desc"
Example: order=asc

昇順 or 降順

afterDueTime
any

指定されたUnixTime(ミリ秒)よりも後に設定されている期日のプロジェクトのみにフィルタリングします。

get /projects
https://api.tocaro.im/projects

Request samples

Copy
curl -X GET https://api.tocaro.im/projects?group=$GROUP \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

プロジェクト作成

概要

  • グループにプロジェクトを作成する
Authorizations:
bearerAuth
Request Body schema: application/json
group
required
string

プロジェクトを関連づけるグループコード

name
required
string

作成するプロジェクト名

Responses

201

Created

post /projects
https://api.tocaro.im/projects

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group": "grymgdhmlv",
  • "name": "Tocaro v3 Development"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "trxxxxxxxxx",
  • "name": "テストプロジェクト",
  • "dueTime": 1706102863000
}

Tasks

タスク関連の操作

タスク検索

概要

  • タスクの一覧を取得する
Authorizations:
bearerAuth
query Parameters
project
required
string
Example: project=trmymlfojt

プロジェクトコード

query
string
Example: query=%E3%83%86%E3%82%B9%E3%83%88

検索対象のタスクタイトル

page
integer [ 1 .. 100 ]
Default: 1

検索結果のページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

検索結果のデータ件数

priority
string
Enum: "low" "middle" "high"
Example: priority=low

優先度

status
string
Enum: "unstart" "inprogress" "confirming" "reject" "done"
Example: status=unstart

ステータス

sort
string
Enum: "title" "priority" "status" "dueTime" "createdAt"
Example: sort=dueTime

ソート対象カラム

direction
string
Enum: "asc" "desc"
Example: direction=desc

昇順 or 降順

lastUpdatedAfter
long
Example: lastUpdatedAfter=1699801200000

指定されたUnixTime(ミリ秒)よりも後に更新があったタスクを取得したいときに利用します。 このプロパティが指定されるとすべての更新情報を取得するためページングの指定とソートの指定はできません。 更新された日付の昇順でレスポンスを返します。

Responses

200

OK

get /tasks
https://api.tocaro.im/tasks

Request samples

Copy
curl -X GET https://api.tocaro.im/tasks\
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "meta":
    {
    },
  • "tasks":
    [
    ]
}

タスク作成

概要

  • タスクを作成する
Authorizations:
bearerAuth
Request Body schema: application/json
project
required
string

プロジェクトコード

title
required
string

タスクタイトル

description
string

タスク概要

status
string
Default: "unstart"
Enum: "unstart" "inprogress" "confirming" "reject" "done"

ステータス

priority
string
Default: "low"
Enum: "low" "middle" "high"

重要度

assignees
Array of strings

担当者を指定

Responses

201

Created

post /tasks
https://api.tocaro.im/tasks

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "project": "trxxxxxxxx",
  • "title": "テストタスク",
  • "description": "テストタスクの概要です。",
  • "status": "unstart",
  • "priority": "middle",
  • "assignees":
    [
    ]
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": "tkxxxxxxxxx",
  • "title": "テストタスク",
  • "description": "テストタスクの概要です。",
  • "priority": "middle",
  • "status": "unstart",
  • "assignees":
    [
    ],
  • "dueAt": "string",
  • "updatedAt": "string"
}

タスクコメントの取得

概要

  • タスクに投稿されたコメントを取得する
Authorizations:
bearerAuth
query Parameters
ulid
string

過去のメッセージを取得するときに指定するコメントID(取得したコメントの最後のアイテムのコメントIDを指定)

lastUpdatedAfter
long
Example: lastUpdatedAfter=1699801200000

指定されたUnixTime(ミリ秒)よりも後に更新があったタスクコメントを取得したいときに利用します。 更新された日付の昇順でレスポンスを返します。

Responses

200

OK

get /tasks/{task}/comments
https://api.tocaro.im/tasks/{task}/comments

Request samples

Copy
curl -X GET https://api.tocaro.im/tasks/{task}/comments \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

タスクコメント投稿

概要

  • タスクコードを指定してタスクにコメントを投稿する
Authorizations:
bearerAuth
path Parameters
task
required
string
Example: tkmymlfojt

タスクコード

Request Body schema: application/json
text
required
string

コメント

Responses

201

Created

post /tasks/{task}/comments
https://api.tocaro.im/tasks/{task}/comments

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "text": "テストメッセージ"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "task":
    {
    },
  • "comment":
    {
    }
}

タスクファイル添付

概要

  • タスクコードを指定してタスクにファイルを追加する
Authorizations:
bearerAuth
path Parameters
task
required
string
Example: tkmymlfojt

タスクコード

Request Body schema: multipart/form-data
file
required
string <binary>

Responses

201

Created

post /tasks/{task}/attachments
https://api.tocaro.im/tasks/{task}/attachments

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "task":
    {
    },
  • "file":
    {
    }
}

Information

契約内全体通知機能の操作

契約内全体通知のお知らせを作成

概要

  • 契約内全体通知のお知らせを作成する
  • お知らせは公開日時・終了日時を指定したスケジュール公開が可能です。
  • スケジュール公開を利用するにはお知らせのステータス(isPublic) に false を指定し、公開日時(publishedTime) と 終了日時(endedTime) を UnixTime(ミリ秒)で指定します。
  • 公開日時(publishedTime) より後の日時に 終了日時(endedTime) を設定する必要があります。
  • 終了日時(endedTime) を指定しない場合は、お知らせ作成日から３ヶ月後に配信を終了いたします。
Authorizations:
bearerAuth
Request Body schema: application/json
title
required
string [ 2 .. 200 ] characters

契約内全体通知のタイトル

detail
required
string <= 5000 characters

契約内全体通知の説明

isPublic
boolean
Default: true

ステータス

commentable
boolean
Default: true

コメント投稿可能かどうか

publishedTime
number
Default: null

お知らせの配信日時(UnixTimeミリ秒)

endedTime
number
Default: null

お知らせの配信終了日時(UnixTimeミリ秒)

Responses

201

Created

post /information
https://api.tocaro.im/information

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "title": "お知らせテスト配信",
  • "detail": "テスト配信です。",
  • "isPublic": true,
  • "commentable": true,
  • "publishedTime": null,
  • "endedTime": null
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ulid": "01XXXXXXXXXXXXXXXXXXXXXXXX",
  • "title": "お知らせテスト配信",
  • "detail": "テスト配信です。",
  • "isPublic": true,
  • "commentable": true,
  • "creator":
    {
    },
  • "publishedAt": null,
  • "endedAt": null
}

契約内全体通知のお知らせを編集

概要

  • 契約内全体通知のお知らせを編集する
  • お知らせは公開日時・終了日時を指定したスケジュール公開が可能です。
  • スケジュール公開を利用するにはお知らせのステータス(isPublic) に false を指定し、公開日時(publishedTime) と 終了日時(endedTime) を UnixTime(ミリ秒)で指定します。
  • 公開日時(publishedTime) より後の日時に 終了日時(endedTime) を設定する必要があります。
  • 終了日時(endedTime) を指定しない場合は、終了日時は更新されません。
Authorizations:
bearerAuth
path Parameters
information
required
string
Example: 01GGVJ3D9BAJQ31TBW0AYR1GGA

インフォメーションID

Request Body schema: application/json
title
required
string [ 2 .. 200 ] characters

契約内全体通知のタイトル

detail
required
string <= 5000 characters

契約内全体通知の説明

isPublic
boolean

ステータス

commentable
boolean
Default: true

コメント投稿可能かどうか

publishedTime
number
Default: null

お知らせの配信日時(UnixTimeミリ秒)

endedTime
number
Default: null

お知らせの配信終了日時(UnixTimeミリ秒)

Responses

200

OK

put /information/{information}
https://api.tocaro.im/information/{information}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "title": "お知らせテスト配信",
  • "detail": "テスト配信です。",
  • "isPublic": true,
  • "commentable": true,
  • "publishedTime": null,
  • "endedTime": null
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "ulid": "01XXXXXXXXXXXXXXXXXXXXXXXX",
  • "title": "お知らせテスト配信",
  • "detail": "テスト配信です。",
  • "isPublic": true,
  • "commentable": true,
  • "creator":
    {
    },
  • "publishedAt": null,
  • "endedAt": null
}

全体通知のお知らせにファイル添付

概要

  • インフォメーションIDを指定してお知らせにファイルを追加する
Authorizations:
bearerAuth
path Parameters
information
required
string
Example: 01GGVJ3D9BAJQ31TBW0AYR1GGA

インフォメーションID

Request Body schema: multipart/form-data
file
string <binary>

Responses

201

Created

post /information/{information}/attachments
https://api.tocaro.im/information/{information}/attachments

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "information":
    {
    },
  • "file":
    {
    }
}

全体通知のお知らせにコメント投稿

概要

  • インフォメーションIDを指定して全体通知のお知らせにコメントを投稿する
Authorizations:
bearerAuth
path Parameters
information
required
string
Example: 01GGVJ3D9BAJQ31TBW0AYR1GGA

インフォメーションID

Request Body schema: application/json
text
required
string <= 3000 characters

コメント

Responses

201

Created

post /information/{information}/comments
https://api.tocaro.im/information/{information}/comments

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "text": "テストメッセージ"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "information":
    {
    },
  • "comment":
    {
    }
}

Tickets

ServiceDesk 関連の操作

チケット検索

概要

  • チケット一覧を取得する
Authorizations:
bearerAuth
query Parameters
group
required
string
Example: group=gr11111111

グループコード(サービスデスクの問い合わせグループ)

query
string
Example: query=%E3%83%86%E3%82%B9%E3%83%88

検索対象のタイトル

page
integer [ 1 .. 100 ]
Default: 1

検索結果のページ番号

perPage
integer [ 1 .. 100 ]
Default: 20

検索結果のデータ件数

status
string
Enum: "open" "inprogress" "pending" "solved" "closed"
Example: status=open

ステータス

sort
string
Enum: "title" "status" "createdAt" "updatedAt"
Example: sort=title

ソート対象カラム

direction
string
Enum: "asc" "desc"
Example: direction=desc

昇順 or 降順

lastUpdatedAfter
long
Example: lastUpdatedAfter=1699801200000

指定されたUnixTime(ミリ秒)よりも後に更新があったタスクを取得したいときに利用します。 このプロパティが指定されるとすべての更新情報を取得するためページングの指定とソートの指定はできません。 更新された日付の昇順でレスポンスを返します。

Responses

200

OK

get /tickets
https://api.tocaro.im/tickets

Request samples

Copy
curl -X GET https://api.tocaro.im/tickets\
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "meta":
    {
    },
  • "tickets":
    [
    ]
}

チケットコメントの取得

概要

  • チケットに投稿されたコメントを取得する
Authorizations:
bearerAuth
query Parameters
group
required
string
Example: group=gr11111111

グループコード(サービスデスクの問い合わせグループ)

ulid
string

過去のメッセージを取得するときに指定するコメントID(取得したコメントの最後のアイテムのコメントIDを指定)

lastUpdatedAfter
long
Example: lastUpdatedAfter=1699801200000

指定されたUnixTime(ミリ秒)よりも後に更新があったタスクコメントを取得したいときに利用します。 更新された日付の昇順でレスポンスを返します。

Responses

200

OK

get /tickets/{tikcet}/comments
https://api.tocaro.im/tickets/{tikcet}/comments

Request samples

Copy
curl -X GET https://api.tocaro.im/tickets/{ticket}/comments \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $TOKEN'

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]