voice-tag-api (1.0)

Download OpenAPI specification:Download

Authentication

idtoken

GoogleログインのIDトークン

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer

auth

file

ファイルアップロード

ファイル（PDF）のアップロード

Authorizations:

idtoken

Request Body schema: multipart/form-data

file required	string <binary> アップロードするPDFファイル
name required	string ファイル名

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "file": "ファイル",
  "name": "ファイル名"
}

Response samples

201
400
401

Content type

application/json

{"result": "success",
"data": {"type": "own",
"file": {"id": "string",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"name": "filename",
"postedAt": "2019-08-24T14:15:22Z",
"url": "http://example.com",
"thumbnail": "http://example.com"
},
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
}
}
}

ファイル一覧

自分がアクセスできるファイルのリストを取得する（つまり、自分がアップロードしたファイルおよび共有されたファイルのリストを取得する）

Authorizations:

idtoken

Responses

Response samples

200
401

Content type

application/json

{"result": "success",
"data": [{"type": "own",
"file": {"id": "file_id",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"name": "filename",
"postedAt": "2019-08-24T14:15:22Z",
"url": "http://example.com",
"thumbnail": "http://example.com"
},
"updatedAt": "2019-08-25T14:15:22Z",
"updatedBy": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
}
},
{"type": "shared",
"file": {"id": "file_id2",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"name": "filename",
"postedAt": "2019-08-24T14:15:22Z",
"url": "http://example.com",
"thumbnail": "http://example.com"
},
"updatedAt": "2019-08-25T14:15:22Z",
"updatedBy": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
}
}
]
}

ファイル詳細

ファイルの詳細情報を取得する

Authorizations:

idtoken

path Parameters

fileId

required

string

ファイルID

Responses

Response samples

200
401

Content type

application/json

{"result": "success",
"data": {"fileSnapshot": {"type": "own",
"file": {"id": "string",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"name": "filename",
"postedAt": "2019-08-24T14:15:22Z",
"url": "http://example.com",
"thumbnail": "http://example.com"
},
"updatedAt": "2019-08-24T14:15:22Z",
"updatedBy": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
}
},
"stamps": [{"id": 0,
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"comments": [{"id": 1,
"dataType": "audio",
"content": "http://example.com/audio",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"postedAt": "2019-08-24T14:15:22Z"
},
{"id": 2,
"dataType": "text",
"content": "コメント",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"postedAt": "2019-08-25T14:15:22Z"
}
],
"position": {"page": 0,
"x": 0.3,
"y": 0.45
}
}
]
}
}

スタンプ投稿

スタンプと、スレッドの一つめのコメントを投稿する

Authorizations:

idtoken

path Parameters

fileId

required

string

Request Body schema: multipart/form-data

page required	integer スタンプを追加するページ
x required	integer 該当ページの左上を原点としたx座標（0~1に正規化）
y required	integer 該当ページの左上を原点としたy座標（0~1に正規化）
dataType required	string (schemas) Enum: "audio" "text" コメントのデータの種類（音声 or テキスト）
content required	string 文字列（テキスト）または音声ファイル（オーディオ）
title	string コメントのタイトル（音声データの場合のみ含む）

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "page": 1,
  "x": 0.2,
  "y": 0.8,
  "dataType": "audio",
  "content": "string"
}

Response samples

201
400
401

Content type

application/json

{"result": "success",
"data": {"id": 0,
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"comments": [{"id": 1,
"dataType": "audio",
"content": "audio file binary or url to audio file",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"postedAt": "2019-08-24T14:15:22Z",
"title": "タイトル"
}
],
"position": {"page": 0,
"x": 0,
"y": 0
}
}
}

コメント投稿

コメントを投稿する

Authorizations:

idtoken

path Parameters

fileId required	string
stampId required	string

Request Body schema: multipart/form-data

dataType required	string (schemas) Enum: "audio" "text" コメントのデータの種類（音声 or テキスト）
content required	string 文字列（テキスト）または音声バイナリ（オーディオ）
title	string コメントのタイトル（音声データの場合のみ含む）

Responses

Request samples

Payload

Content type

multipart/form-data

{
  "dataType": "audio",
  "content": "string",
  "title": "タイトル"
}

Response samples

201
400
401

Content type

application/json

{"result": "success",
"data": {"id": 1,
"dataType": "audio",
"content": "string",
"author": {"id": "qwerty",
"name": "joen doe",
"iconUrl": "http://example.com/icon/qwerty.png"
},
"postedAt": "2019-08-24T14:15:22Z",
"title": "タイトル"
}
}