Item
概要¶
「レコード取得API」や「レコード作成API」で用いるテーブルの「レコード」のJSONデータのレイアウトについて説明します。
JSONデータのレイアウト¶
| No | プロパティ名 | 項目名 | データ型 | 備考 |
|---|---|---|---|---|
| 1 | SiteId | 「サイトID項目」 | long | |
| 2 | UpdatedTime | 更新日時項目 | DateTime | |
| 3 | IssueIdまたはResultId | ID項目 | long | |
| 4 | Ver | バージョン項目 | int | |
| 5 | Title | タイトル項目 | string | |
| 6 | Body | 内容項目 | string | |
| 7 | StartTime | 開始項目 | DateTime | 期限付きテーブルのみ |
| 8 | CompletionTime | 完了項目 | DateTime | 期限付きテーブルのみ |
| 9 | WorkValue | 作業量項目 | decimal | 期限付きテーブルのみ |
| 10 | ProgressRate | 進捗率項目 | decimal | 期限付きテーブルのみ |
| 11 | RemainingWorkValue | 残作業量項目 | decimal | 期限付きテーブルのみ |
| 12 | Status | 状況項目 | int | |
| 13 | Manager | 管理者項目 | int | |
| 14 | Owner | 担当者項目 | int | |
| 15 | Locked | ロック項目 | bool | |
| 16 | Comments | コメント項目 | string | |
| 17 | Creator | 作成者項目 | int | ユーザID |
| 18 | Updator | 更新者項目 | int | ユーザID |
| 19 | CreatedTime | 作成日時項目 | DateTime | |
| 20 | ItemTitle | タイトル項目 | string | |
| 21 | ClassHash | 分類項目 | Dictionary | 後述の設定例を参照 |
| 22 | NumHash | 数値項目 | Dictionary | 後述の設定例を参照 |
| 23 | DateHash | 日付項目 | Dictionary | 後述の設定例を参照 |
| 24 | DescriptionHash | 説明項目 | Dictionary | 後述の設定例を参照 |
| 25 | CheckHash | チェック項目 | Dictionary | 後述の設定例を参照 |
| 26 | AttachmentsHash | 添付ファイル項目 | Dictionary | 後述の「Attachmentsオブジェクト」および設定例を参照 |
| 27 | VerUp | 「新バージョンとして保存」 | bool | trueを指定する場合は新バージョンで保存します。falseを指定する場合およびプロパティを指定しない場合は、レコード操作の時は「テーブルの管理:エディタ:自動バージョンアップ」の設定に従います。サイト操作の時は最新バージョンと比較して更新日または更新者のどちらかが異なる場合に新バージョンで保存します。 |
Attachments オブジェクト¶
| プロパティ名 | データ型 | 備考 |
|---|---|---|
| Guid | 文字列 | 添付ファイルのGUID |
| Name | 文字列 | 添付ファイル名 |
| ContentType | 文字列 | Content Type |
| Base64 | 文字列 | ファイルデータをBase64エンコーディングしたもの |
設定例¶
ClassHash、NumHash、DateHash、DescriptionHash、CheckHashの設定例(json)
"ClassHash": {
"ClassA": "分類",
"ClassB": "未分類",
"ClassC": "その他"
},
"NumHash": {
"NumA": 100,
"NumB": 200
},
"DateHash": {
"DateA": "2019/01/01",
"DateB": "2020/01/01"
},
"DescriptionHash": {
"DescriptionA": "説明",
"DescriptionB": "概要",
"DescriptionC": "補足"
},
"CheckHash": {
"CheckA": true,
"CheckB": false
}
AttachmentsHashの設定例(json)
AttachmentsHash: {
AttachmentsA: [
{
ContentType: 'text/plain',
Name: 'Readme.txt',
Base64: '5yY5Trfi4…'
},
{
ContentType: 'text/csv',
Name: 'data.csv',
Base64: 'Rgfc2g3ZSe…'
}
],
AttachmentsB: [
{
ContentType: 'image/jpeg',
Name: 'logo.jpeg',
Base64: 'b4yT5HJfg2…'
}
]
}
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.5.6.0 以降 | VerUpを追加 |
関連情報¶
- 開発者ガイド:API
- 開発者ガイド:API:テーブル操作:複数レコード取得
- テーブル機能
- テーブルの管理:項目:更新日時
- テーブルの管理:項目:ID
- テーブルの管理:項目:バージョン
- テーブルの管理:項目:タイトル
- テーブルの管理:項目:内容
- テーブルの管理:項目:開始
- テーブルの管理:項目:完了
- テーブルの管理:項目:作業量
- テーブルの管理:項目:進捗率
- テーブルの管理:項目:残作業量
- テーブルの管理:項目:状況
- テーブルの管理:項目:管理者
- テーブルの管理:項目:担当者
- テーブルの管理:項目:ロック
- テーブルの管理:項目:コメント
- テーブルの管理:項目:作成者
- テーブルの管理:項目:更新者
- テーブルの管理:項目:作成日時
- テーブルの管理:項目:分類
- テーブルの管理:項目:数値
- テーブルの管理:項目:日付
- テーブルの管理:項目:説明
- テーブルの管理:項目:チェック
- テーブルの管理:項目:添付ファイル
