Get Form Layout

Gets the field layout info of a form in an App.

MethodGET
URLhttps://{subdomain}.kintone.com/k/v1/app/form/layout.json
URL(guest space)https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/app/form/layout.json
AuthenticationAPI Token Authentication , Password Authentication
Content-Typeapplication/json (not needed if specifying the query with a query string)

Contents

Pre-live settings

Apps may hold pre-live settings that have not yet been deployed to the live App.
Access the pre-live settings with the below URL.

URL https://{subdomain}.kintone.com/k/v1/preview/app/form/layout.json
URL(guest space) https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/form/layout.json

Permissions

  • Permission to view records are needed when obtaining information of live Apps.
  • App Management Permissions are needed when obtaining information of pre-live settings.

Request Parameters

Parameter Value Required Description
app String Yes The App ID.

Sample Request

JavaScript (using Kintone REST API Request )

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
var body = {
  'app': 1
};

kintone.api(kintone.api.url('/k/v1/app/form/layout', true), 'GET', body, function(resp) {
  // success
  console.log(resp);
}, function(error) {
  // error
  console.log(error);
});

XMLHttpRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
var url = 'https://{subdomain}.kintone.com/k/v1/app/form/layout.json?app=1';

var xhr = new XMLHttpRequest();
xhr.open('GET', url);
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
xhr.onload = function() {
  if (xhr.status === 200) {
    // success
    console.log(JSON.parse(xhr.responseText));
  } else {
    // error
    console.log(JSON.parse(xhr.responseText));
  }
};
xhr.send();

Response Parameters

Parameter Type Description
layout Array A list of field layouts for each row.
layout[].type String The type of row
- ROW: A normal row of fields.
- SUBTABLE: A Table.
- GROUP: A Group field.
layout[].code String The field code of the Table or Group field. This parameter will not be returned for other row types.
layout[].fields Array A list of fields in the row.
layout[].fields[].type String The type of field.
- CALC: Calculated
- CATEGORY: Category
- CHECK_BOX: Check box
- CREATED_TIME: Created datetime
- CREATOR: Created by
- DATE: Date
- DATETIME: Date and time
- DROP_DOWN: Drop-down
- FILE: Attachment
- HR: Border
- LABEL: Label
- LINK: Link
- MODIFIER: Updated by
- MULTI_LINE_TEXT: Text Area
- MULTI_SELECT: Multi-choice
- NUMBER: Number, or Look-up*
- RADIO_BUTTON: Radio button
- RECORD_NUMBER: Record number
- REFERENCE_TABLE: Related Records
- RICH_TEXT: Rich text
- SINGLE_LINE_TEXT: Text, or Look-up*
- SPACER: Blank space
- STATUS: Process management status
- STATUS_ASSIGNEE: Assignee of the Process Management status
- SUBTABLE: Table
- TIME: Time
- UPDATED_TIME: Updated datetime
- USER_SELECT: User selection
*The type of the Look-up field will be the same type as the Key field it’s looking up.
layout[].fields[].code String The field code.
layout[].fields[].label String The text set in the Label field.
Only returned for Label fields.
layout[].fields[].elementId String The element ID of the Space field.
Only returned for Space fields.
layout[].fields[].size Object An object with data of the field’s size.
layout[].fields[].size.width String The width of the field in pixels.
layout[].fields[].size.height String The height of the field in pixels, including the height of the field name.
layout[].fields[].size.innerHeight String The height of the field in pixels, excluding the height of the field name.
layout[].layout Array A list of field layouts for each row inside a Group field.
revision String The revision number of the App settings.

Sample Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
{
  "revision": "2",
  "layout": [
    {
      "type": "ROW",
      "fields": [
        {
          "type": "SINGLE_LINE_TEXT",
          "code": "Text__single_line_",
          "size": {
            "width": "200"
          }
        }
      ]
    },
    {
      "type": "SUBTABLE",
      "code": "Table",
      "fields": [
        {
          "type": "SINGLE_LINE_TEXT",
          "code": "Text2__single_line_",
          "size": {
            "width": "193"
          }
        },
        {
          "type": "MULTI_LINE_TEXT",
          "code": "Text_Box__multi_line_",
          "size": {
            "width": "315",
            "innerHeight": "125"
          }
        }
      ]
    },
    {
      "type": "ROW",
      "fields": [
        {
          "type": "NUMBER",
          "code": "Number",
          "size": {
            "width": "193"
          }
        }
      ]
    },
    {
      "type": "ROW",
      "fields": [
        {
          "type": "RECORD_NUMBER",
          "code": "Record_number",
          "size": {
            "width": "141"
          }
        },
        {
          "type": "CREATOR",
          "code": "Created_by",
          "size": {
            "width": "136"
          }
        }
      ]
    }
  ]
}