Skip to content

Item

Overview

This explains the layout of the JSON data of the "Record" of the Table that are retrieved using the Record Retrieval API of the API.

JSON Data Layout

No Property name Column name Data type Notes
1 SiteId "Site ID column" long
2 UpdatedTime "Update Datetime Column" DateTime
3 IssueId or ResultId "ID Column" long
4 Ver "Version Column" int
5 Title "Title Column" string
6 Body "Body Column" string
7 StartTime "Start Column" DateTime Only for time-limited tables
8 CompletionTime "Complete Column" DateTime Only for time-limited tables
9 WorkValue "Work Volume Column" decimal Only for time-limited tables
10 ProgressRate "Progression Rate Column" decimal Only for time-limited tables
11 RemainingWorkValue "Remaining Work Volume Column" decimal Only for time-limited tables
12 Status "Status Column" int
13 Manager "Manager Column" int
14 Owner "Owner Column" int
15 Locked "Lock Column" bool
16 Comments "Comment Column" string
17 Creator "Creator Column" int User ID
18 Updator "Updater Column" int User ID
19 CreatedTime "Created Datetime Column" DateTime
20 ItemTitle "Title Column" string
21 ClassHash "Class Column" Dictionary See the setting example below
22 NumHash "Numerical Value Column" Dictionary See the setting example below
23 DateHash "Date Column" Dictionary See the setting example below
24 DescriptionHash "Description Column" Dictionary See the setting example below
25 CheckHash "Check Column" Dictionary See the setting example below
26 AttachmentsHash "Attachment Column" Dictionary See the "Attachments object" and setting example below

Attachments Object

Property name Data type Notes
Guid String Attachment GUID
Name String Attachment file name
ContentType String Content Type
Base64 String File data encoded in Base64

Setting Example

ClassHash、NumHash、DateHash、DescriptionHash、CheckHash setting example (json)

"ClassHash": {
    "ClassA": "Classification",
    "ClassB": "Unclassified",
    "ClassC": "Other"
},
"NumHash": {
    "NumA": 100,
    "NumB": 200
},
"DateHash": {
    "DateA": "2019/01/01",
    "DateB": "2020/01/01"
},
"DescriptionHash": {
    "DescriptionA": "Description",
    "DescriptionB": "Summary",
    "DescriptionC": "Additional Information"
},
"CheckHash": {
    "CheckA": true,
    "CheckB": false
}

AttachmentsHash setting example (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…'
        }
    ]
}