List of extension items available in the content structure
The content structure includes the following four field items by default.
- ID/Slug
- Date
- Title
- Content(Wysiwyg)
Field items can be added in the item settings of the Content structure editor.
Reference: [Contents structure edit Item settings](/docs/management/content-structure-topics-group/#Item settings)
In addition, extended items can be configured for input restrictions and the content to be displayed by clicking on "Settings" to open the settings screen.
The available settings vary depending on the item, so please refer to the following.
Additional fields list
Single-line text
Single-line text (autocomplete)
Multi-line text
WYSIWYG
HTML
Dropdown selection
Multiple choice (checkbox)
Date picker
Master selection
Relational data selection
Bool
Image (upload to KurocoFiles)
File (upload to KurocoFiles)
File (upload to GCS)
File (upload to S3)
File (from File manager)
Counter
Link
Location
Number
Table
Depending on when you applied for Kuroco, the response for each item may be ext_col_XX
instead of ext_X
.
If this does not work, please check the response in the Swagger UI.
Text
Single-line text
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Input restriction | You can restrict the strings that can be entered. | |
Regular expression | If "Regular Expression" is selected for Input restriction, fill in the Regular expression. | |
Character limit | Set the minimum and maximum number of characters. | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": "Text",
},
Single-line text (autocomplete)
Display of Contents Editing Screen
Field settings
Field | Settings | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Additional items | Content structure ID | Set the content definition group ID to display autocomplete. |
Field | Set the extension number for displaying autocomplete. Ex:ext_col_04 | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X":"Blog",
},
Multi-line text
Display of Contents Editing Screen
Field settings
Field | Settings | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Additional items | Width | Set the width of the text area to be displayed. |
Height | Set the height of the text area to be displayed. | |
Character limit | Set the minimum and maximum number of characters. | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": "Multi-line text",
},
WYSIWYG
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Additional items | Width | Set the width of the text area to be displayed. |
Height | Set the height of the text area to be displayed. | |
Delete plugin | Remove unwanted components from the toolbar (example: font, format) Please refer to The WYSIWYG editor for details on how to set up | |
Custom colors | Set the color code to be set for the color palette. Please refer to WYSIWYG custom color settings for details on how to set up | |
Large color palette | If checked, color codes of 16 or more colors can be set. | |
Simple toolbar | If checked, this field will be a simple toolbar. | |
Use font size px | If checked, the font size will be specified in px. | |
Custom CSS | Custom CSS file for editor content. It will be used for ALL CKEditors on the page! | |
Resource | Enter a path to specify the directory path to be displayed when ckfinder is started. e.g.: /file/user/ | |
Automatically convert to iframely code during API output | If checked, the code is automatically converted to use iframely when output to the API. | |
WYSIWYG Placeholders | Enter a list of placeholders for use in the WYSIWYG editor, with each placeholder separated by commas(,). | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
"details": {
"ext_X": "<p><strong>Wysiwyg</strong> Text area</p>",
},
HTML
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Additional items | Width | Set the width of the html input area to be displayed. |
Height | Set the height of the html input area to be displayed. | |
Allow all tags | If checked, all tags will be available. | |
Enable simple text editor | If checked, the html input will be a simple text area. | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": "<div>\r\nhtml <p>Textarea</p>\r\n</div>",
},
Selection
Dropdown selection
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Options | key | Enter the Key for the selection. |
Value | Enter the Value for the selection. | |
Default | If checked, it will be selected as default. | |
Add | Add selections. | |
Delete | Delete selections. | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"key": "1",
"label": "Option1"
},
},
Multiple choice (checkbox)
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Options | key | Enter the Key for the selection. |
Value | Enter the Value for the selection. | |
Default | If checked, it will be selected as default. | |
Add | Add selections. | |
Delete | Delete selections. | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": [
{
"key": "1",
"label": "Option1"
},
{
"key": "2",
"label": "Option2"
}
],
},
Date picker
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Additional items | Also include time(hh:mm) | If checked, the time can be set. |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X":"2023-06-04",
},
Master selection
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Additional items | Master | Enter the ID of the master to be used. |
Key | Enter the column number to be used as the key. | |
Value | Enter the column number to be used as the value. | |
Default | Enter the value that should be already selected in the initial display. | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"key": "key",
"label": "0"
},
},
Relational data selection
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Additional items | Module | Select the functions to be selected as related information. |
Content structure ID | When content is selected in the module settings, enter the ID of the group to be selected as related information. Comma-separated "," content group ID (For EC, enter the ID of the parent content group) | |
Category ID | When content is selected in the module settings, enter the ID of the category to be selected as related information. Comma-separated "," category IDs (optional, for content module only) | |
Filter by authority settings | Filter the data by authorization settings. Allowed values are "insert", "update", and "delete". If the user does not have the authorization settings for the targeted module data, then the data will be filtered out. | |
Self only | Only return/can update data corresponding to logged-in user (own data) | |
Secure off | Disable viewing limits (0 | |
Sort | Set the sort order. Example 1: topics_id=ASC Example 2: subject=ASC,topics_id=ASC | |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"module_type": "topics",
"module_id": 959
},
},
BoolRelease version: β / RCversion
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Searchable | If checked, this field will be indexed for improved search performance. | |
Additional items | default | Select the default value to be either true or false. |
JSON Response
details: {
"ext_X": false
},
Files
Image (upload to KurocoFiles)
Display of Contents Editing Screen
Field settings
Item | Description | ||
---|---|---|---|
Input type | Required | If checked, this field will be a required field. | |
Additional items | Extension | Value | Enter the image extensions for which you want to allow uploads. |
Add | Add image extensions that allow uploads. | ||
Delete | Remove image extensions that allow uploads. | ||
Maximum upload size(MB) | Limit the size of uploadable images. | ||
Hide caption | If checked, hides the image description entry field on the content edit screen. | ||
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"id": "sample_0",
"url": "https://sample.g.kuroco-img.app/v=1623673449/files/topics/sample.png",
"desc": "",
"url_org": "https://test.g.kuroco-img.app/files/topics/sample.png"
},
},
File (upload to KurocoFiles)
Display of Contents Editing Screen
Field settings
Item | Description | ||
---|---|---|---|
Input type | Required | If checked, this field will be a required field. | |
Additional items | Set file extensions | Value | Enter the file extensions for which you want to allow uploads. |
Add | Add file extensions that allow uploads. | ||
Delete | Remove file extensions that allow uploads. | ||
Hide caption | If checked, hides the file name entry field on the content edit screen. | ||
Maximum upload size(MB) | Limit the size of uploadable images. | ||
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"id": "sample_0",
"url": "https://sample.g.kuroco-img.app/v=1623673449/files/topics/sample_0.pdf",
"url_org": "https://sample.g.kuroco-img.app/files/topics/sample_0.pdf",
"dl_link": "https://sample.g.kuroco.app/direct/topics/topics_file_download/?topics_id=960&ext_no=09&index=0",
"desc": "test"
},
},
File (upload to GCS)
File (upload to GCS) is available after integration with Firebase. Please refer to the following document for details on how to work with Firebase. Cloud storage integration with Firebase
Display of Contents Editing Screen
Field settings
Item | Description | ||
---|---|---|---|
Input type | Required | If checked, this field will be a required field. | |
Additional items | Set file extensions | Value | Enter the file extensions that you want to allow uploading. |
Add | Add file extensions that allow uploads. | ||
Delete | Remove file extensions that are allowed to be uploaded. | ||
Hide the input field | If checked, hides the file name entry field on the content edit screen. | ||
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"id": "sample_0",
"url": "https://storage.googleapis.com/kuroco-test.appspot.com/files/topics/sample.png?X-Goog-Algorithm=xxxxx",
"desc": ""
},
},
File (upload to S3)
File (upload to S3) is available after integration with Amazon S3. Please refer to the following document for details on how to work with Amazon S3. Integrating and storing files with Amazon S3
Display of Contents Editing Screen
Field settings
Item | Description | ||
---|---|---|---|
Input type | Required | If checked, this field will be a required field. | |
Additional items | Set file extensions | Value | Enter the file extensions that you want to allow uploading. |
Add | Add file extensions for which you want to allow uploads. | ||
Delete | Remove file extensions that are allowed to be uploaded. | ||
Hide the input field | If checked, hides the file name entry field on the content edit screen. | ||
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"id": "sample_0",
"url": "https://kuroco-sample.s3.ap-northeast-1.amazonaws.com/files/topics/sample_0.jpeg?response-content-disposition=xxxxx",
"desc": ""
},
},
File (from File manager)
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Additional items | Resource | Enter the directory path you want to display when ckfinder starts. e.g./file/user/ |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X":"https://sample.g.kuroco-img.app/v=1621239477/files/user/sample.png",
},
Video (Vimeo)
Video(Vimeo) is available after integration with Vimeo. Please refer to the following document for details on how to work with Vimeo. Integrating and storing files with Amazon S3
Display of Contents Editing Screen
Field settings
Item | Description | ||
---|---|---|---|
Input type | Required | If checked, this field will be a required field. | |
Additional items | Set file extensions | Value | Enter the file extensions that you want to allow uploading. |
Add | Add file extensions for which you want to allow uploads. | ||
Delete | Remove file extensions that are allowed to be uploaded. | ||
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSONレスポンス
details: {
"ext_col_14": {
"id": "sample_0",
"url": "https://player.vimeo.com/video/xxxxxxxxx",
"desc": "",
"image_url": "https://sample.g.kuroco-img.app/v=1234567890/files/topics/sample_0.jpg"
},
}
Other
Counter
The counter can be increased or decreased in value by hitting the Topics::increment endpoint. This is used to set the number of PV number etc. Implementing view-based page rankings in Google Analytics
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Searchable | If checked, this field will be indexed for improved search performance. |
JSON Response
details: {
"ext_X": X,
},
Link
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"url": "https://kuroco.app/",
"title": "Kuroco"
},
},
Location
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input type | Required | If checked, this field will be a required field. |
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"gmap_x": "139.7435938",
"gmap_y": "35.7009012",
"gmap_zoom": "16",
"gmap_type": "roadmap",
"gmap_place_id": "ChIJbSFfyl2MGGARIoFxX2bg0hE",
"jp_lon": "139.0.11.2",
"jp_lat": "34.59.48.2"
},
},
Number
Display of Contents Editing Screen
Field settings
Item | Description | |
---|---|---|
Input-related | Required | If checked, this field will be a required field. |
Input restriction | You can restrict the input to certain values. | |
Numeric range | Specify the range of allowable numeric values. | |
Searchable | If checked, this field will be indexed for improved search performance. |
JSON Response
details: {
"ext_X":123,
},
Table
Display of Contents Editing Screen
Field settings
Item | Description | ||
---|---|---|---|
Input type | Required | If checked, this field will be a required field. | |
Additional items | Number of rows | Enter the number of rows in the table. | |
Number of columns | Enter the number of columns in the table. | ||
Cell settings | Cell | Enter the cell where the settings are to be made. To specify the cell in the second row from the top and the third column from the left, enter 2-3 .The header row that is automatically added is row 0. | |
Value | Enter the value to be initially displayed. | ||
LOCK | If checked, cell editing is locked. | ||
Add | Add cell settings. | ||
Delete | Remove cell settings. | ||
Custom template | Template editor | Enter if you want to change the input form when editing content. |
JSON Response
details: {
"ext_X": {
"1": {
"1": "1-1",
"2": "1-2",
"3": "1-3"
},
"2": {
"1": "2-1",
"2": "2-2",
"3": "2-3"
}
},
},
Support
If you have any other questions, please contact us or check out Our Slack Community.