openapi: 3.0.3 info: title: Kintone REST API version: 2026.8.31 description: |- OpenAPI specification for Kintone's REST API. ## Authentication Each operation can be executed with either **API token authentication (recommended)** or **password authentication** (see `security`). Because API tokens are scoped per app, some APIs—such as user/organization/group management (User API) and space administration—cannot be run with a token and require **password authentication**. If **Basic authentication (access restriction)** or **secure access (client certificate)** is enabled on your environment, you must additionally provide an extra gate (`Authorization: Basic ...` header / client certificate) on top of the above. **Session authentication** (browser cookie + CSRF token) is available on virtually all APIs, but this spec targets server-to-server integration and therefore does not include it in `security`. Details of these methods that `security` cannot express are described in a structured form under `x-kintone-additional-auth` at the document root. ## Limitations (Kintone-specific) - **Record schemas are dynamic per app.** Field codes are arbitrary keys (`additionalProperties`) and values are represented as a union per field type (`oneOf`/`anyOf` with a `type` discriminator). The exact types of an individual app cannot be fully expressed, so supplement real app types with examples / fixtures. - **When a GET query is long**, you can avoid URL-length limits by sending `POST` with the `X-HTTP-Method-Override: GET` header and putting parameters in the body (the server processes it as GET). Such GET operations are marked with `x-kintone-method-override: true`. No duplicate operation is defined; the GET definition is authoritative. - **Authentication differs per endpoint.** Which methods (API token / password / OAuth2) each API accepts is taken directly from the "Authentication" row of the official documentation pages (cybozu.dev) via harvest and reflected in `security`. Management APIs that do not support tokens (space/guest administration, app move, plugins, statistics, etc.) end up as password authentication only. Only the OAuth2 scope each operation needs is a best-effort estimate derived from the path family, because no machine-readable scope mapping is published. Copyright (c) 2026 Cybozu, Inc. Licensed under MIT No Attribution (SPDX: MIT-0), which does not require attribution. contact: name: Kintone Developer Program url: https://kintone.dev/en/ email: developer@cybozu.com license: name: MIT No Attribution url: https://opensource.org/license/MIT-0 x-kintone-additional-auth: description: Authentication-related notes that OpenAPI `security` cannot express. Basic auth and secure access are additional gates layered on top of each security method; session auth is out of scope for this spec (intended for in-browser customizations). basic: kind: additional-gate header: Authorization scheme: Basic appliesWhen: when Basic authentication (access restriction) is enabled on the environment note: Not a standalone method; sent on every request in addition to the chosen security method. clientCertificate: kind: additional-gate appliesWhen: when secure access (client certificate) is enabled on the environment note: TLS client certificate, presented during the TLS handshake rather than as an HTTP header. session: kind: out-of-scope mechanism: browser cookie + CSRF token (__REQUEST_TOKEN__) availability: available on virtually all REST APIs (each API supports it per cybozu.dev) inSecurity: false reason: This spec targets server-to-server integration, so it is excluded from `security` (it is a method for in-browser customizations). servers: - url: https://{subdomain}.cybozu.com variables: subdomain: default: example description: The Kintone subdomain — the `` part of `https://.cybozu.com`. The default `example` is a placeholder; replace it with your own. paths: /k/guest/{guestSpaceId}/v1/app.json: get: operationId: getAppForGuestSpace summary: Get app (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: id in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of app/get content: application/json: schema: properties: threadId: type: string nullable: true spaceId: type: string nullable: true createdAt: format: date-time type: string creator: properties: code: type: string name: type: string type: object code: type: string modifiedAt: format: date-time type: string appId: type: string modifier: properties: code: type: string name: type: string type: object name: type: string description: type: string type: object required: - appId - code - createdAt - creator - description - modifiedAt - modifier - name - spaceId - threadId 4XX: $ref: '#/components/responses/Error' description: Gets general information of an App, including the name, description, related Space, creator and updater information. /k/guest/{guestSpaceId}/v1/app/acl.json: get: operationId: getAppAclForGuestSpace summary: Get app acl (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID responses: '200': description: success case of app/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/AppAclGetRight' type: array revision: type: string type: object required: - rights 4XX: $ref: '#/components/responses/Error' description: Gets the App permissions of an App. put: operationId: putAppAclForGuestSpace summary: Put app acl (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/AppAclPutRight' type: array description: |- An array listing data of App permissions, in order of priority. The "Everyone" group will be treated with the lowest priority, wherever it is placed in the list. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - rights type: object responses: '200': description: success case of app/acl/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the App permissions of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/app/actions.json: get: operationId: getAppActionsForGuestSpace summary: Get app actions (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/actions/get content: application/json: schema: properties: actions: type: object additionalProperties: $ref: '#/components/schemas/AppActionsGetAction' revision: type: string type: object required: - actions 4XX: $ref: '#/components/responses/Error' description: Gets the Action settings of the App. /k/guest/{guestSpaceId}/v1/app/adminNotes.json: get: operationId: getAppAdminNotesForGuestSpace summary: Get app admin notes (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: string required: true description: The App ID. responses: '200': description: success case of app/adminNotes/get content: application/json: schema: properties: content: type: string includeInTemplateAndDuplicates: type: boolean revision: type: string type: object required: - content 4XX: $ref: '#/components/responses/Error' description: Gets notes for app administrator and their settings. /k/guest/{guestSpaceId}/v1/app/customize.json: get: operationId: getAppCustomizeForGuestSpace summary: Get app customize (guest space) tags: - APPS security: - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The app ID. responses: '200': description: success case of app/customize/get content: application/json: schema: properties: desktop: properties: css: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array type: object scope: enum: - ALL - ADMIN - NONE type: string mobile: properties: css: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array type: object revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Gets the JavaScript and CSS Customization settings of an App. /k/guest/{guestSpaceId}/v1/app/form/fields.json: get: operationId: getAppFormFieldsForGuestSpace summary: Get app form fields (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/form/fields/get content: application/json: schema: properties: properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/AppFormFieldsGetCalcFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetCategoryFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDateFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDatetimeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDecimalFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetEditorFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetFileFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetGroupFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetGroupSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetLinkFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetLookupFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetModifiedAtFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetModifierFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleCheckFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleLineTextFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetOrganizationSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetRecordIdFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetReferenceTableFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleCheckFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleLineTextFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetStatusAssigneeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetStatusFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetTableForm' - $ref: '#/components/schemas/AppFormFieldsGetTimeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetUserSelectFieldForm' type: object revision: type: string type: object required: - properties - revision 4XX: $ref: '#/components/responses/Error' description: Gets the list of fields and field settings of an App. /k/guest/{guestSpaceId}/v1/app/form/layout.json: get: operationId: getAppFormLayoutForGuestSpace summary: Get app form layout (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of app/form/layout/get content: application/json: schema: properties: layout: items: anyOf: - $ref: '#/components/schemas/AppFormLayoutGetRow' - $ref: '#/components/schemas/AppFormLayoutGetGroupRow' - $ref: '#/components/schemas/AppFormLayoutGetSubtableRow' type: object type: array revision: type: string type: object required: - layout 4XX: $ref: '#/components/responses/Error' description: Gets the field layout info of a form in an App. /k/guest/{guestSpaceId}/v1/app/move.json: post: operationId: postAppMoveForGuestSpace summary: Post app move (guest space) tags: - APPS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. space: format: int64 type: integer description: |- The Space ID of where the App will be moved to. To remove an App from its current space, `null` can be specified. required: - app type: object responses: '200': description: success case of app/move/post content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Changes the Space where an App belongs to. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/app/notifications/general.json: get: operationId: getAppNotificationsGeneralForGuestSpace summary: Get app notifications general (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of app/notifications/general/get content: application/json: schema: properties: notifyToCommenter: type: boolean notifications: items: $ref: '#/components/schemas/AppNotificationsGeneralGetNotification' type: array revision: type: string type: object required: - notifications 4XX: $ref: '#/components/responses/Error' description: Gets the General Notification settings of the App. /k/guest/{guestSpaceId}/v1/app/notifications/perRecord.json: get: operationId: getAppNotificationsPerRecordForGuestSpace summary: Get app notifications per record (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The response parameter `notifications[].filterCond` will include the localized option names in the query string. - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/notifications/perRecord/get content: application/json: schema: properties: notifications: items: $ref: '#/components/schemas/AppNotificationsPerRecordGetNotification' type: array revision: type: string type: object required: - notifications 4XX: $ref: '#/components/responses/Error' description: Gets the Per Record Notification settings of the App. /k/guest/{guestSpaceId}/v1/app/notifications/reminder.json: get: operationId: getAppNotificationsReminderForGuestSpace summary: Get app notifications reminder (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/notifications/reminder/get content: application/json: schema: properties: timezone: format: timezone type: string notifications: items: $ref: '#/components/schemas/AppNotificationsReminderGetNotification' type: array revision: type: string type: object required: - notifications 4XX: $ref: '#/components/responses/Error' description: Gets the Reminder Notification settings of the App. /k/guest/{guestSpaceId}/v1/app/plugins.json: get: operationId: getAppPluginsForGuestSpace summary: Get app plugins (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - JA - EN - ZH - ES type: string description: |- The localized language to retrieve the data in: - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `es`: retrieves the localized Spanish names If ignored, the default names will be retrieved. responses: '200': description: success case of app/plugins/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/AppPluginsGetPluginForm' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of Plug-ins added to an App. /k/guest/{guestSpaceId}/v1/app/reports.json: get: operationId: getAppReportsForGuestSpace summary: Get app reports (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/reports/get content: application/json: schema: properties: reports: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/AppReportsGetReport' - $ref: '#/components/schemas/AppReportsGetReportWithChartMode' type: object revision: type: string type: object required: - reports 4XX: $ref: '#/components/responses/Error' description: Gets the Graph settings of the App. /k/guest/{guestSpaceId}/v1/app/settings.json: get: operationId: getAppSettingsForGuestSpace summary: Get app settings (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The app ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/settings/get content: application/json: schema: properties: enableComments: type: boolean titleField: $ref: '#/components/schemas/AppSettingsGetTitleField' icon: anyOf: - $ref: '#/components/schemas/AppSettingsGetIconPresetForm' - $ref: '#/components/schemas/AppSettingsGetIconFileForm' type: object description: maxLength: 10000 type: string enableThumbnails: type: boolean enableDuplicateRecord: type: boolean revision: type: string enableInlineRecordEditing: type: boolean enableBulkDeletion: type: boolean name: maxLength: 64 minLength: 1 type: string theme: enum: - WHITE - CLIPBOARD - BINDER - PENCIL - CLIPS - RED - GREEN - BLUE - YELLOW - BLACK type: string numberPrecision: $ref: '#/components/schemas/AppSettingsGetNumberPrecision' firstMonthOfFiscalYear: type: string type: object required: - description - enableBulkDeletion - enableComments - enableDuplicateRecord - enableInlineRecordEditing - enableThumbnails - firstMonthOfFiscalYear - icon - name - numberPrecision - revision - theme - titleField 4XX: $ref: '#/components/responses/Error' description: Gets the description, name, icon, revision and color theme of an App. /k/guest/{guestSpaceId}/v1/app/status.json: get: operationId: getAppStatusForGuestSpace summary: Get app status (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/status/get content: application/json: schema: properties: enable: type: boolean actions: items: $ref: '#/components/schemas/AppStatusGetActionForm' type: array states: type: object additionalProperties: $ref: '#/components/schemas/AppStatusGetStateForm' revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the process management settings of an App. /k/guest/{guestSpaceId}/v1/app/views.json: get: operationId: getAppViewsForGuestSpace summary: Get app views (guest space) tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. responses: '200': description: success case of app/views/get content: application/json: schema: properties: views: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/AppViewsGetBuiltinListViewOutputForm' - $ref: '#/components/schemas/AppViewsGetBuiltinCalendarViewOutputForm' - $ref: '#/components/schemas/AppViewsGetListViewOutputForm' - $ref: '#/components/schemas/AppViewsGetCalendarViewOutputForm' - $ref: '#/components/schemas/AppViewsGetCustomViewOutputForm' type: object revision: type: string type: object required: - views 4XX: $ref: '#/components/responses/Error' description: Gets the View settings of an App. /k/guest/{guestSpaceId}/v1/apps.json: get: operationId: getAppsForGuestSpace summary: Get apps (guest space) tags: - APPS security: - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: codes in: query schema: items: type: string type: array description: |- The App Code. Up to 100 App Codes can be specified. Each App Code must be between 1 to 64 characters. An exact match search will be used, and will be case sensitive. If `null` or an empty array is specified, this parameter will be ignored. - name: offset in: query schema: type: integer format: int64 description: |- The number of retrievals that will be skipped. Must be between 0 and 2,147,483,647. If nothing is specified, it will default to 0. - name: name in: query schema: maxLength: 64 type: string description: |- The App Name or a part of it. Each App Name must be specified within 64 characters. A partial search will be used, and the search will be case insensitive. The localized name of the App in the user's locale will also be included in the search. If `null` or an empty array is specified, this parameter will be ignored. - name: limit in: query schema: type: integer format: int64 description: |- The number of Apps to retrieve. Must be between 1 and 100. If nothing is specified, it will default to 100. - name: ids in: query schema: items: format: long type: string type: array description: |- The App IDs. Integers from 1 to 9,223,372,036,854,775,807 can be specified. Up to 100 IDs can be specified. If `null` or an empty array is specified, this parameter will be ignored. - name: spaceIds in: query schema: items: format: long type: string type: array description: |- The Space ID of where the App resides in. Integers from 1 to 9,223,372,036,854,775,807 can be specified. Up to 100 IDs can be specified. If `null` or an empty array is specified, this parameter will be ignored. responses: '200': description: success case of apps/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/AppsGetAppWithSpaceIdForm' type: array type: object required: - apps 4XX: $ref: '#/components/responses/Error' description: Gets general information of multiple Apps, including the name, description, related Space, creator and updater information. /k/guest/{guestSpaceId}/v1/apps/statistics.json: get: operationId: getAppsStatisticsForGuestSpace summary: Get apps statistics (guest space) tags: - APPS security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: offset in: query schema: type: string - name: limit in: query schema: type: string responses: '200': description: success case of apps/statistics/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/AppsStatisticsGetAppForm' type: array type: object 4XX: $ref: '#/components/responses/Error' /k/guest/{guestSpaceId}/v1/bulkRequest.json: post: operationId: postBulkRequestForGuestSpace summary: Post bulk request (guest space) tags: - BULKREQUESTS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: requests: items: $ref: '#/components/schemas/BulkRequestPostRequestForm' type: array description: An array of requests. The maximum number of requests is 20. required: - requests type: object responses: '200': description: success case of bulkRequest/post content: application/json: schema: properties: results: items: anyOf: - $ref: '#/components/schemas/BulkRequestPostRecordPostOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordStatusPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordAssigneesPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsDeleteOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsPostOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsStatusPutOutputForm' type: object type: array type: object required: - results 4XX: $ref: '#/components/responses/Error' description: Runs multiple API requests sequentially to multiple Apps. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/field/acl.json: get: operationId: getFieldAclForGuestSpace summary: Get field acl (guest space) tags: - FIELDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of field/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/FieldAclGetRight' type: array revision: type: string type: object required: - rights 4XX: $ref: '#/components/responses/Error' description: Gets the Field permission settings of an App. put: operationId: putFieldAclForGuestSpace summary: Put field acl (guest space) tags: - FIELDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/FieldAclPutRight' type: array description: An array listing data of field permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - rights type: object responses: '200': description: success case of field/acl/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Field permission settings of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/file.json: get: operationId: downloadFileForGuestSpace summary: Download file (guest space) tags: - FILES security: - apiToken: [] - passwordAuth: [] - oauth2: - k:file:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: fileKey in: query schema: type: string required: true description: The value that is set on the Attachment field in the response data returned when using the Get Record API. responses: '200': description: success case of file/get content: '*/*': schema: type: string format: binary 4XX: $ref: '#/components/responses/Error' description: Downloads files from an attachment field in an app. post: operationId: uploadFileForGuestSpace summary: Upload file (guest space) tags: - FILES security: - apiToken: [] - passwordAuth: [] - oauth2: - k:file:write requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary responses: '200': description: success case of file/post content: application/json: schema: properties: fileKey: type: string type: object required: - fileKey 4XX: $ref: '#/components/responses/Error' description: Uploads a file to Kintone. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/form.json: get: operationId: getFormForGuestSpace summary: Get form (guest space) tags: - FORMS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of form/get content: application/json: schema: properties: properties: items: anyOf: - $ref: '#/components/schemas/FormGetLayoutProperties' - $ref: '#/components/schemas/FormGetLabelProperties' - $ref: '#/components/schemas/FormGetBultinProperties' - $ref: '#/components/schemas/FormGetCalcSimpleProperties' - $ref: '#/components/schemas/FormGetDateSimpleProperties' - $ref: '#/components/schemas/FormGetDatetimeSimpleProperties' - $ref: '#/components/schemas/FormGetDecimalSimpleProperties' - $ref: '#/components/schemas/FormGetEditorSimpleProperties' - $ref: '#/components/schemas/FormGetFileSimpleProperties' - $ref: '#/components/schemas/FormGetLinkSimpleProperties' - $ref: '#/components/schemas/FormGetMultipleLineTextSimpleProperties' - $ref: '#/components/schemas/FormGetMultipleSelectSimpleProperties' - $ref: '#/components/schemas/FormGetSingleLineTextSimpleProperties' - $ref: '#/components/schemas/FormGetSingleSelectSimpleProperties' - $ref: '#/components/schemas/FormGetTimeSimpleProperties' - $ref: '#/components/schemas/FormGetUserSelectSimpleProperties' - $ref: '#/components/schemas/FormGetOrganizationSelectSimpleProperties' - $ref: '#/components/schemas/FormGetGroupSelectSimpleProperties' - $ref: '#/components/schemas/FormGetLookupSimpleProperties' - $ref: '#/components/schemas/FormGetReferenceTableLayoutProperties' - $ref: '#/components/schemas/FormGetSubTableLayoutProperties' - $ref: '#/components/schemas/FormGetSpacerProperties' type: object type: array type: object 4XX: $ref: '#/components/responses/Error' description: Retrieves the form details of an app. /k/guest/{guestSpaceId}/v1/guests.json: delete: operationId: deleteGuestsForGuestSpace summary: Delete guests (guest space) tags: - GUESTS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: guests: items: format: email type: string type: array description: |- A list of email addresses of Guest users. Up to 100 Guests can be deleted. required: - guests type: object responses: '200': description: success case of guests/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes a Guest user from Kintone. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). post: operationId: postGuestsForGuestSpace summary: Post guests (guest space) tags: - GUESTS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: guests: items: $ref: '#/components/schemas/GuestsPostGuestUserForm' type: array description: A list of Guest user data. required: - guests type: object responses: '200': description: success case of guests/post content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Adds Guest users to Kintone. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/plugin.json: delete: operationId: uninstallPluginForGuestSpace summary: Uninstall plugin (guest space) tags: - PLUGINS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: type: string description: The ID of the plug-in. required: - id type: object responses: '200': description: success case of plugin/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Uninstalls a plug-in from the Kintone environment. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). post: operationId: installPluginForGuestSpace summary: Install plugin (guest space) tags: - PLUGINS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fileKey: type: string description: |- The fileKey representing an uploaded file. Use the following API to upload the file and retrieve the fileKey: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) required: - fileKey type: object responses: '200': description: success case of plugin/post content: application/json: schema: properties: id: type: string version: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Imports a plug-in into Kintone. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). put: operationId: putPluginForGuestSpace summary: Put plugin (guest space) tags: - PLUGINS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fileKey: type: string description: |- The fileKey representing an uploaded file. Use the following API to upload the file and retrieve the fileKey: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) id: type: string description: The ID of the plug-in to be updated. required: - fileKey - id type: object responses: '200': description: success case of plugin/put content: application/json: schema: properties: id: type: string version: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates an imported plug-in in Kintone. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/plugin/apps.json: get: operationId: getPluginAppsForGuestSpace summary: Get plugin apps (guest space) tags: - PLUGINS security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: offset in: query schema: type: string description: |- The number of plug-ins to skip from the list of plug-ins. If ignored, this value is 0. - name: limit in: query schema: type: string description: |- The maximum number of plug-ins to retrieve. Must be between 1 and 500. The default number is 100. - name: id in: query schema: type: string required: true description: The ID of the plug-in. responses: '200': description: success case of plugin/apps/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/PluginAppsGetAppDto' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets Apps that have the specified plug-In added. /k/guest/{guestSpaceId}/v1/plugins.json: get: operationId: getPluginsForGuestSpace summary: Get plugins (guest space) tags: - PLUGINS security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: offset in: query schema: type: string description: |- The number of plug-ins to skip from the list of installed plug-ins. If ignored, this value is 0. - name: limit in: query schema: type: string description: |- The maximum number of plug-ins to retrieve. Must be between 1 and 100. The default number is 100. - name: ids in: query schema: items: type: string type: array description: |- The plug-in ids. The maximum limit of ids that can be specified is 100. If `null` or an empty array is specified, this parameter will be ignored, and a list of plug-ins will be returned. responses: '200': description: success case of plugins/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/PluginsGetPluginDto' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of plug-ins imported into Kintone. /k/guest/{guestSpaceId}/v1/plugins/required.json: get: operationId: getPluginsRequiredForGuestSpace summary: Get plugins required (guest space) tags: - PLUGINS security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: offset in: query schema: type: string description: |- The number of plug-ins to skip from the list of required plug-ins. If ignored, this value is 0. - name: limit in: query schema: type: string description: |- The maximum number of plug-ins to retrieve. Must be between 1 and 100. The default number is 100. responses: '200': description: success case of plugins/required/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/PluginsRequiredGetPluginDto' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps. /k/guest/{guestSpaceId}/v1/preview/app.json: post: operationId: postPreviewAppForGuestSpace summary: Post preview app (guest space) tags: - PREVIEWS security: - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: name: type: string description: |- The App name. The maximum length is 64 characters. thread: format: int64 type: integer description: |- The Thread ID of the thread in the Space where the App will be created. *It is recommended to ignore this parameter so that Apps are created in the default thread. There is currently no helpful reason to create Apps in threads other than the default thread, as there are no visual representations in Kintone of Apps being related to threads. There are only visual representations of Apps being related to Spaces. space: format: int64 type: integer description: The Space ID of where the App will be created. required: - name type: object responses: '200': description: success case of preview/app/post content: application/json: schema: properties: app: type: string revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Creates a preview App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/acl.json: get: operationId: getPreviewAppAclForGuestSpace summary: Get preview app acl (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID responses: '200': description: success case of preview/app/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/PreviewAppAclGetRight' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the App permissions of an App. put: operationId: putPreviewAppAclForGuestSpace summary: Put preview app acl (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/PreviewAppAclPutRight' type: array description: |- An array listing data of App permissions, in order of priority. The "Everyone" group will be treated with the lowest priority, wherever it is placed in the list. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - rights type: object responses: '200': description: success case of preview/app/acl/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the App permissions of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/actions.json: get: operationId: getPreviewAppActionsForGuestSpace summary: Get preview app actions (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/actions/get content: application/json: schema: properties: actions: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppActionsGetAction' revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Action settings of the App. put: operationId: putPreviewAppActionsForGuestSpace summary: Put preview app actions (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. actions: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppActionsPutAction' description: |- An object listing `Action` settings. The object's key is the `Action`'s unique identifier, which is equal to the `Action`'s name in its default language settings. The values of the key are the various `Action` settings associated with that `Action`. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or `-1` is specified. required: - app - actions type: object responses: '200': description: success case of preview/app/actions/put content: application/json: schema: properties: actions: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppActionsPutActionResult' revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Action settings of the App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/adminNotes.json: get: operationId: getPreviewAppAdminNotesForGuestSpace summary: Get preview app admin notes (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: string required: true description: The App ID. responses: '200': description: success case of preview/app/adminNotes/get content: application/json: schema: properties: content: type: string includeInTemplateAndDuplicates: type: boolean revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets notes for app administrator and their settings. put: operationId: putPreviewAppAdminNotesForGuestSpace summary: Put preview app admin notes (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. content: maxLength: 10000 type: string description: |- The content of the notes. The content must be between 0 to 10000 characters. If the parameter is omitted, the content will not change. revision: format: int64 type: integer description: |- The revision number of the App settings. If the parameter does not match the actual revision number, it will be considered an error, and the content will not be updated. The revision will not be checked if this parameter is ignored or `-1` is specified. includeInTemplateAndDuplicates: type: string description: |- The permission settings to include this note in app templates or duplicates - `true`: include - `false`: do not include If the parameter is omitted, the content will not change. required: - app type: object responses: '200': description: success case of preview/app/adminNotes/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Update the notes for App administrators and their settings. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/customize.json: get: operationId: getPreviewAppCustomizeForGuestSpace summary: Get preview app customize (guest space) tags: - PREVIEWS security: - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The app ID. responses: '200': description: success case of preview/app/customize/get content: application/json: schema: properties: desktop: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array type: object scope: enum: - ALL - ADMIN - NONE type: string mobile: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the JavaScript and CSS Customization settings of an App. put: operationId: putPreviewAppCustomizeForGuestSpace summary: Put preview app customize (guest space) tags: - PREVIEWS security: - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. desktop: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of CSS files for desktop. js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of JavaScript files. type: object description: An object containing data of JavaScript and CSS files for the desktop. scope: enum: - ALL - ADMIN - NONE type: string description: |- The scope of customization - `ALL`: Affect all users - `ADMIN`: Affect only App administrators - `NONE`: Disable mobile: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of CSS files for mobile. js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of JavaScript files. type: object description: An object containing data of JavaScript and CSS files for the mobile. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app type: object responses: '200': description: success case of preview/app/customize/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the JavaScript and CSS Customization settings of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/deploy.json: get: operationId: getPreviewAppDeployForGuestSpace summary: Get preview app deploy (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: apps in: query schema: items: format: long type: string type: array required: true description: |- The list of Apps to check the deploy statuses of. The Maximum limit is 300. If Apps in Guest Spaces are specified, all Apps specified in the request must belong to that Guest Space. responses: '200': description: success case of preview/app/deploy/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/PreviewAppDeployGetAppForm' type: array type: object required: - apps 4XX: $ref: '#/components/responses/Error' description: Gets the deployment status of the App settings for multiple Apps. post: operationId: deployAppForGuestSpace summary: Deploy app (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: revert: type: boolean description: Specify `true` to cancel all changes made to the pre-live settings. The pre-live settings will be reverted back to the current settings of the live app. apps: items: $ref: '#/components/schemas/PreviewAppDeployPostAppForm' type: array description: |- The list of Apps to deploy the pre-live settings to the live Apps. The Maximum limit is 300. If Apps are being deployed to Guest Spaces, Apps can only be deployed to the same Guest Space. required: - apps type: object responses: '200': description: success case of preview/app/deploy/post content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the settings of a pre-live App to the live App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/form/fields.json: delete: operationId: deletePreviewAppFormFieldsForGuestSpace summary: Delete preview app form fields (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. fields: items: type: string type: array description: |- The list of field codes of the fields to delete. Up to 100 field codes can be specified. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - fields type: object responses: '200': description: success case of preview/app/form/fields/delete content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Deletes fields from a form of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). get: operationId: getPreviewAppFormFieldsForGuestSpace summary: Get preview app form fields (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/form/fields/get content: application/json: schema: properties: properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsGetCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetUserSelectFieldForm' type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of fields and field settings of an App. post: operationId: postPreviewAppFormFieldsForGuestSpace summary: Post preview app form fields (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsPostCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostUserSelectFieldForm' type: object description: |- An object with data of the field settings of the field specified in `{fieldcode}`. To update a field code, state the current field code in `{fieldcode}`, and state the new field code in `properties.{fieldcode}.code`. For the characters that can be used for field codes, refer to the following document: [Valid characters](https://us.kintone.help/k/en/id/040504#autocalc_fieldcode_20) description: An object with data of the field settings. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - properties type: object responses: '200': description: success case of preview/app/form/fields/post content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Adds fields to a form of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). put: operationId: putPreviewAppFormFieldsForGuestSpace summary: Put preview app form fields (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsPutCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutUserSelectFieldForm' type: object description: |- An object with data of the field settings of the field specified in `{fieldcode}`. To update a field code, state the current field code in `{fieldcode}`, and state the new field code in `properties.{fieldcode}.code`. description: An object with data of the field settings. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - properties type: object responses: '200': description: success case of preview/app/form/fields/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the field settings of fields in a form of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/form/layout.json: get: operationId: getPreviewAppFormLayoutForGuestSpace summary: Get preview app form layout (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/app/form/layout/get content: application/json: schema: properties: layout: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutGetRow' - $ref: '#/components/schemas/PreviewAppFormLayoutGetGroupRow' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSubtableRow' type: object type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the field layout info of a form in an App. put: operationId: putPreviewAppFormLayoutForGuestSpace summary: Put preview app form layout (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. layout: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutPutRow' - $ref: '#/components/schemas/PreviewAppFormLayoutPutGroupRow' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSubtableRow' type: object type: array description: A list of field layouts for each row. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - layout type: object responses: '200': description: success case of preview/app/form/layout/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the field layout info of a form in an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/notifications/general.json: get: operationId: getPreviewAppNotificationsGeneralForGuestSpace summary: Get preview app notifications general (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/app/notifications/general/get content: application/json: schema: properties: notifyToCommenter: type: boolean notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsGeneralGetNotification' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the General Notification settings of the App. put: operationId: putPreviewAppNotificationsGeneralForGuestSpace summary: Put preview app notifications general (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. notifyToCommenter: type: boolean description: |- Option to notify all commenters of a record when a comment is posted on that record. This reflects the "Send updated comment notifications to all commenters" checkbox. - `true`: Notify all commenters of the record when a comment is posted - `false`: Do not notify all commenters of the record when a comment is posted If ignored, this setting will not be changed. notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsGeneralPutNotification' type: array description: |- An array of objects consisting of "Recipients and Conditions" options. If an empty array is sent, all the recipients will be removed. If this parameter is ignored, no changes will be made to the "Recipients and Conditions" options. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app type: object responses: '200': description: success case of preview/app/notifications/general/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the General Notification settings of the App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/notifications/perRecord.json: get: operationId: getPreviewAppNotificationsPerRecordForGuestSpace summary: Get preview app notifications per record (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The response parameter `notifications[].filterCond` will include the localized option names in the query string. - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/notifications/perRecord/get content: application/json: schema: properties: notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsPerRecordGetNotification' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Per Record Notification settings of the App. put: operationId: putPreviewAppNotificationsPerRecordForGuestSpace summary: Put preview app notifications per record (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsPerRecordPutNotification' type: array description: |- An array of objects containing data of the Per Record Notification settings. If the array is empty, all of the Per Record Notification settings will be deleted. If ignored, this setting will not be changed. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app - notifications type: object responses: '200': description: success case of preview/app/notifications/perRecord/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Per Record Notification settings of the App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/notifications/reminder.json: get: operationId: getPreviewAppNotificationsReminderForGuestSpace summary: Get preview app notifications reminder (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/notifications/reminder/get content: application/json: schema: properties: timezone: format: timezone type: string notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsReminderGetNotification' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Reminder Notification settings of the App. put: operationId: putPreviewAppNotificationsReminderForGuestSpace summary: Put preview app notifications reminder (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. timezone: format: timezone type: string description: |- The timezone that determines the Reminder notification's timing. This reflects the "Reminder Time Zone" dropdown option. If the App's Reminder Notification settings have never been configured, the API executing user's timezone will be used. notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsReminderPutNotification' type: array description: |- An array of objects consisting of "Notification Trigger" options. These options define when the notifications will be sent out, under what conditions, and the recipients. If an empty array is sent, all the recipients will be removed. If this parameter is ignored, no changes will be made to the "Notification Trigger" options. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app type: object responses: '200': description: success case of preview/app/notifications/reminder/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Reminder Notification settings of the App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/plugins.json: get: operationId: getPreviewAppPluginsForGuestSpace summary: Get preview app plugins (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - JA - EN - ZH - ES type: string description: |- The localized language to retrieve the data in: - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `es`: retrieves the localized Spanish names If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/plugins/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/PreviewAppPluginsGetPluginForm' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of Plug-ins added to an App. post: operationId: postPreviewAppPluginsForGuestSpace summary: Post preview app plugins (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. ids: items: type: string type: array description: The Plug-in IDs that will be added to the App. revision: format: int64 type: integer description: |- Specify the expected current revision number for the App. The request will fail if the stated revision number is not the latest revision. The revision will not be checked if this parameter is ignored or `-1` is specified. required: - app - ids type: object responses: '200': description: success case of preview/app/plugins/post content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Adds Plug-ins to an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/reports.json: get: operationId: getPreviewAppReportsForGuestSpace summary: Get preview app reports (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/reports/get content: application/json: schema: properties: reports: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetReport' - $ref: '#/components/schemas/PreviewAppReportsGetReportWithChartMode' type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Graph settings of the App. put: operationId: putPreviewAppReportsForGuestSpace summary: Put preview app reports (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. reports: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppReportsPutReport' - $ref: '#/components/schemas/PreviewAppReportsPutReportWithChartMode' type: object description: |- An object listing Graph information of 1 graph. If _graphname_ is equal to the name of an existing graph, the graph will be updated with the values in the object. If _graphname_ is not equal to a name of an existing graph, a new graph will be created with the values in the object. Any existing graphs that are not set for this parameter will be deleted. description: |- An object listing Graph information. The key of the object is the graph's unique identifier, which is equal to the name of the graph in its default language settings. The values of the key are the various graph settings associated with that graph. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app - reports type: object responses: '200': description: success case of preview/app/reports/put content: application/json: schema: properties: reports: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppReportsPutReportResult' revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Graph settings of the App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/settings.json: get: operationId: getPreviewAppSettingsForGuestSpace summary: Get preview app settings (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The app ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/settings/get content: application/json: schema: properties: enableComments: type: boolean titleField: $ref: '#/components/schemas/PreviewAppSettingsGetTitleField' icon: anyOf: - $ref: '#/components/schemas/PreviewAppSettingsGetIconPresetForm' - $ref: '#/components/schemas/PreviewAppSettingsGetIconFileForm' type: object description: maxLength: 10000 type: string enableThumbnails: type: boolean enableDuplicateRecord: type: boolean revision: type: string enableInlineRecordEditing: type: boolean enableBulkDeletion: type: boolean name: maxLength: 64 minLength: 1 type: string theme: enum: - WHITE - CLIPBOARD - BINDER - PENCIL - CLIPS - RED - GREEN - BLUE - YELLOW - BLACK type: string numberPrecision: $ref: '#/components/schemas/PreviewAppSettingsGetNumberPrecision' firstMonthOfFiscalYear: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the description, name, icon, revision and color theme of an App. put: operationId: putPreviewAppSettingsForGuestSpace summary: Put preview app settings (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. enableComments: type: string description: The **Enable comments** setting. titleField: allOf: - $ref: '#/components/schemas/PreviewAppSettingsPutTitleField' description: The record title. icon: anyOf: - $ref: '#/components/schemas/PreviewAppSettingsPutIconPresetForm' - $ref: '#/components/schemas/PreviewAppSettingsPutIconFileForm' type: object description: An object containing information of the App icon. description: maxLength: 10000 type: string description: The App description. The maximum character limit is 10,000. HTML tags can be used. enableThumbnails: type: string description: The **Show thumbnails** setting. enableDuplicateRecord: type: string description: The **Enable the feature to "duplicate record"** setting. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. enableInlineRecordEditing: type: string description: The **Enable inline record editing** setting. enableBulkDeletion: type: string description: The **Enable bulk deletion of records** setting. name: maxLength: 64 minLength: 1 type: string description: The App name. The maximum character limit is 64. theme: enum: - WHITE - CLIPBOARD - BINDER - PENCIL - CLIPS - RED - GREEN - BLUE - YELLOW - BLACK type: string description: |- The Color theme. The following can be specified: - `WHITE`: Default - `RED` - `BLUE` - `GREEN` - `YELLOW` - `BLACK` numberPrecision: allOf: - $ref: '#/components/schemas/PreviewAppSettingsPutNumberPrecision' description: |- The **Precision of numbers and calculations** setting. For more information, refer to the following article on the Kintone Help site: [Precision of numbers and calculations](https://us.kintone.help/k/en/id/040508#autocalc_rounding_30) firstMonthOfFiscalYear: type: string description: The **First month of Fiscal Year** setting. Specify an integer from 1 to 12, representing the month. required: - app type: object responses: '200': description: success case of preview/app/settings/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the description, name, icon, revision and color theme of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/status.json: get: operationId: getPreviewAppStatusForGuestSpace summary: Get preview app status (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/status/get content: application/json: schema: properties: enable: type: boolean actions: items: $ref: '#/components/schemas/PreviewAppStatusGetActionForm' type: array states: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppStatusGetStateForm' revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the process management settings of an App. put: operationId: putPreviewAppStatusForGuestSpace summary: Put preview app status (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. enable: type: boolean description: |- The on/off settings of the process management settings. - `true`: Process management settings is enabled. - `false`: Process management settings is disabled. actions: items: $ref: '#/components/schemas/PreviewAppStatusPutActionForm' type: array description: An array containing data of the Actions. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. states: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppStatusPutStateForm' description: |- An object containing data of the process management statuses. When adding or updating a status, specify the existing statuses in `states` as well. If not specified, the existing statuses will be deleted. required: - app type: object responses: '200': description: success case of preview/app/status/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the process management settings of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/app/views.json: get: operationId: getPreviewAppViewsForGuestSpace summary: Get preview app views (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. responses: '200': description: success case of preview/app/views/get content: application/json: schema: properties: views: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppViewsGetBuiltinListViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetBuiltinCalendarViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetListViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetCalendarViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetCustomViewOutputForm' type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the View settings of an App. put: operationId: putPreviewAppViewsForGuestSpace summary: Put preview app views (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. views: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppViewsPutListViewForm' - $ref: '#/components/schemas/PreviewAppViewsPutCalendarViewForm' - $ref: '#/components/schemas/PreviewAppViewsPutCustomViewForm' type: object description: |- The setting of each Views. - Add a View: Specify the name of the View to be add as `views.{viewname}`. - Update a View: Specify the name of the View before update as `views.{viewname}` - Delete a View: Do not specify the View name to be deleted. When Process Management is enabled, specify **Assigned to me**. description: |- An object of data of Views. When adding or updating views, specify the existing views. If not specified, those views will be deleted. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - views type: object responses: '200': description: success case of preview/app/views/put content: application/json: schema: properties: views: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppViewsPutResult' revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the View settings of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/field/acl.json: get: operationId: getPreviewFieldAclForGuestSpace summary: Get preview field acl (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/field/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/PreviewFieldAclGetRight' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Field permission settings of an App. put: operationId: putPreviewFieldAclForGuestSpace summary: Put preview field acl (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/PreviewFieldAclPutRight' type: array description: An array listing data of field permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - rights type: object responses: '200': description: success case of preview/field/acl/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Field permission settings of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/preview/form.json: get: operationId: getPreviewFormForGuestSpace summary: Get preview form (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/form/get content: application/json: schema: properties: properties: items: anyOf: - $ref: '#/components/schemas/PreviewFormGetLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetLabelProperties' - $ref: '#/components/schemas/PreviewFormGetBultinProperties' - $ref: '#/components/schemas/PreviewFormGetCalcSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDateSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDatetimeSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDecimalSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetEditorSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetFileSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetLinkSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetMultipleLineTextSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetMultipleSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetSingleLineTextSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetSingleSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetTimeSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetUserSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetOrganizationSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetGroupSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetLookupSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetReferenceTableLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetSubTableLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetSpacerProperties' type: object type: array type: object 4XX: $ref: '#/components/responses/Error' description: Retrieves the form details of an app. /k/guest/{guestSpaceId}/v1/preview/record/acl.json: get: operationId: getPreviewRecordAclForGuestSpace summary: Get preview record acl (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/record/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/PreviewRecordAclGetRight' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Record permission settings of an App. put: operationId: putPreviewRecordAclForGuestSpace summary: Put preview record acl (guest space) tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/PreviewRecordAclPutRightForm' type: array description: An array listing data of record permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - rights type: object responses: '200': description: success case of preview/record/acl/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Record permission settings of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/record.json: get: operationId: getRecordForGuestSpace summary: Get record (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: id in: query schema: type: integer format: int64 required: true description: The Record ID. responses: '200': description: success case of record/get content: application/json: schema: properties: record: type: object additionalProperties: $ref: '#/components/schemas/RecordObject' type: object required: - record 4XX: $ref: '#/components/responses/Error' description: Retrieves details of 1 record from an App by specifying the App ID and Record ID. post: operationId: postRecordForGuestSpace summary: Post record (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' description: |- Field codes and values are specified in this object. The values that can be specified vary depending on the type of field. If ignored, the record will be added with default field values. If field codes that don't exist are specified, these will be ignored. For more information on field types, refer to the following article: [Field Types](https://kintone.dev/en/docs/kintone/overview/field-types/) required: - app - record type: object responses: '200': description: success case of record/post content: application/json: schema: properties: id: type: string revision: type: string type: object required: - id - revision 4XX: $ref: '#/components/responses/Error' description: Adds 1 record to an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). put: operationId: putRecordForGuestSpace summary: Put record (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. updateKey: allOf: - $ref: '#/components/schemas/RecordPutUpdateKey' description: The unique key of the record to be updated. Required, if _id_ will not be specified. To specify this field, the field must have the "Prohibit duplicate values" option turned on. record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' description: |- Field codes and values are specified in this object. If ignored, the record will not be updated. For more information on field types, refer to the following article: [Field Types](https://kintone.dev/en/docs/kintone/overview/field-types/) id: format: int64 type: integer description: The Record ID of the record to be updated. Required, if _updateKey_ will not be specified. revision: format: int64 type: integer description: The expected revision number. If the value does not match, an error will occur and the record will not be updated. If the value is not specified or is -1, the revision number will not be checked. required: - app type: object responses: '200': description: success case of record/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates details of 1 record in an App by specifying its record number, or a different unique key. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/record/acl.json: get: operationId: getRecordAclForGuestSpace summary: Get record acl (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of record/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/RecordAclGetRight' type: array revision: type: string type: object required: - rights 4XX: $ref: '#/components/responses/Error' description: Gets the Record permission settings of an App. put: operationId: putRecordAclForGuestSpace summary: Put record acl (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/RecordAclPutRightForm' type: array description: An array listing data of record permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - rights type: object responses: '200': description: success case of record/acl/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Record permission settings of an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/record/assignees.json: put: operationId: putRecordAssigneesForGuestSpace summary: Put record assignees (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. assignees: items: type: string type: array description: The user code(s) (log in names) of the Assignee(s). If empty, no users will be assigned. The maximum number of Assignees is 100. id: format: int64 type: integer description: The Record ID. revision: format: int64 type: integer description: The revision number of the record before updating the Assignees. If the specified revision is not the latest revision, the request will result in an error. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - assignees - id type: object responses: '200': description: success case of record/assignees/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Assignees of a Record status, that was set with the Process Management feature. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/record/comment.json: delete: operationId: deleteRecordCommentForGuestSpace summary: Delete record comment (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. record: format: int64 type: integer description: The Record ID. comment: format: int64 type: integer description: The Comment ID. required: - app - record - comment type: object responses: '200': description: success case of record/comment/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Delete a comment in a record in an app. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). post: operationId: postRecordCommentForGuestSpace summary: Post record comment (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. record: format: int64 type: integer description: The Record ID. comment: properties: mentions: items: $ref: '#/components/schemas/RecordCommentPostMentionForm' type: array description: An array including information to mention other users. text: maxLength: 65535 minLength: 1 type: string description: |- The comment text. The maximum length is 65,535 characters. required: - text type: object description: An object including comment details. required: - app - record - comment type: object responses: '200': description: success case of record/comment/post content: application/json: schema: properties: id: type: string type: object required: - id 4XX: $ref: '#/components/responses/Error' description: Add a comment to a record in an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/record/comments.json: get: operationId: getRecordCommentsForGuestSpace summary: Get record comments (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: offset in: query schema: type: integer format: int64 description: |- This skips the retrieval of the first number of comments. "offset": 30 skips the first 30 comments, and retrieves from the 31st comment. There is no maximum for this value. - name: record in: query schema: type: integer format: int64 required: true description: The Record ID. - name: limit in: query schema: type: integer format: int64 description: |- The number of records to retrieve. "limit": 5 will retrieve the first 5 comments. The default and maximum is 10 comments. - name: order in: query schema: enum: - ASC - DESC type: string description: |- The sort order of the Comment ID. Specifying "asc" will sort the comments in ascending order, and "desc" will sort the comments in descending order. If ignored, "desc" will be set. responses: '200': description: success case of record/comments/get content: application/json: schema: properties: newer: type: boolean comments: items: $ref: '#/components/schemas/RecordCommentsGetCommentOutputForm' type: array older: type: boolean type: object required: - comments - newer - older 4XX: $ref: '#/components/responses/Error' description: Retrieves multiple comments from a record in an app. /k/guest/{guestSpaceId}/v1/record/status.json: put: operationId: putRecordStatusForGuestSpace summary: Put record status (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. action: type: string description: |- The Action name of the action to run. If the localization feature has been used to apply multiple translations of the Action name, specify the name of the Action in the language settings of the user that will run the API. API Tokens follow the language settings set in the User & System Administration settings. For more information, refer to the following article: [Configuring System Language](https://us.kintone.help/general/en/id/020114) id: format: int64 type: integer description: The record ID. assignee: type: string description: |- The next Assignee. Specify the Assignee's log in name. Required if one of the following conditions are met: - if the "_Assignee List_" of the current status is set to "_User chooses one assignee from the list to take action_", and a selectable assignee exists. - if the "_Assignee List_" of the initial status has been set to an `assignee`, and the status is being reverted to that initial status. revision: format: int64 type: integer description: |- The revision number of the record before updating the status. If the specified revision is not the latest revision, the request will result in an error. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - action - id type: object responses: '200': description: success case of record/status/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Status of a record of an App, that was set with the Process Management feature. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/records.json: delete: operationId: deleteRecordsForGuestSpace summary: Delete records (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The app ID. ids: items: format: int64 type: integer type: array description: |- Array of record IDs that will be deleted. Up to 100 records can be specified. revisions: items: format: int64 type: integer type: array description: |- The Expected revision number. The first id number will correspond to the first revision number in the array, the second id to the second revision number, and so on. If the revision number does not match, an error will occur and no records will be deleted. If the revision number is left blank or is -1, the revision number will not be checked for the corresponding record ID. required: - app - ids type: object responses: '200': description: success case of records/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes multiple records in an app. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). get: operationId: getRecordsForGuestSpace summary: Get records (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: query in: query schema: format: query type: string description: |- The search condition, written in Kintone's own query syntax. This is **not** SQL and **not** OData. Ignoring this parameter returns all records that the credential can access. The authoritative reference is [Query Strings](https://kintone.dev/en/docs/kintone/overview/query-string/). Its rules are reproduced below so that a correct query can be built without leaving this document. ## Syntax rules - The field code always goes on the **left** of the operator, never on the right. - Wrap string values in double quotes: `Status in ("Closed")`. Numbers and times are unquoted: `price > 10`, `Time > 10:00`. - Combine conditions with `and` / `or`, and group them with parentheses. - Field codes are defined per App and are case-sensitive. Call `GET /k/v1/app/form/fields.json` first to obtain the exact field codes and their types. Do not guess field codes. ## Operators allowed per field type Using an operator that the field type does not support returns an error, so check the field type first. | Field type | Allowed operators | |---|---| | Single-line text, Link | `=` `!=` `in` `not in` `like` `not like` | | Multi-line text | `like` `not like` `is empty` `is not empty` — **`=` is not allowed** | | Rich text | `like` `not like` | | Number, Calculated | `=` `!=` `>` `<` `>=` `<=` `in` `not in` | | Drop-down, Radio button, Check box, Multi-choice | **`in` / `not in` only — `=` is not allowed** | | Date, Date and time, Time | `=` `!=` `>` `<` `>=` `<=` | | Created datetime, Updated datetime | `=` `!=` `>` `<` `>=` `<=` | | User selection, Department selection, Group selection | `in` `not in` | | Created by, Updated by | `in` `not in` | | Status | `=` `!=` `in` `not in` | | Record number, `$id` | `=` `!=` `>` `<` `>=` `<=` `in` `not in` | | Attachment | `like` `not like` `is empty` `is not empty` | | Lookup | Same as the field type it looks up | | Related Records, fields inside a Table | Same as the source field type, but `=` and `!=` are **not** allowed — use `in` / `not in` | | Field group, Category | Cannot be used in a query | To reference a field inside a Related Records field, use `.`. ## Functions | Function | Applies to | |---|---| | `LOGINUSER()` | User selection, Created by, Updated by | | `PRIMARY_ORGANIZATION()` | Department selection | | `NOW()` `TODAY()` `YESTERDAY()` `TOMORROW()` | Date, Date and time, Created datetime, Updated datetime | | `FROM_TODAY(n, "DAYS"\|"WEEKS"\|"MONTHS"\|"YEARS")` | same as above | | `THIS_WEEK(SUNDAY..SATURDAY)` `LAST_WEEK()` `NEXT_WEEK()` | same as above | | `THIS_MONTH(1..31\|LAST)` `LAST_MONTH()` `NEXT_MONTH()` | same as above | | `THIS_YEAR()` `LAST_YEAR()` `NEXT_YEAR()` | same as above | Arguments may be omitted to mean the whole week / month / year, e.g. `THIS_MONTH()`. Time fields accept no functions. ## Options Place these **after all conditions, in this exact order**: `order by`, `limit`, `offset`. | Option | Meaning | |---|---| | `order by asc\|desc` | Sort order. Separate multiple fields with commas. Defaults to record ID descending. | | `limit ` | Number of records to return. Default 100, **maximum 500 for this API**. | | `offset ` | Number of records to skip. **Maximum 10000.** To read past 10000 records, use the cursor API (`POST /k/v1/records/cursor.json`) instead. | ## Escaping Inside double quotes, escape `"` and `\` with a backslash. This is required for single-line text, multi-line text, rich text, check box, radio button, drop-down, multi-choice and status fields. Example: `Checkbox in ("sample\"1\"")` ## Examples ``` Text like "sample" and Text_area like "sample" order by Created_datetime desc Drop_down in ("value1", "value2") and (Multi_choice in ("value3") or Radio_button in ("value4")) Time > 10:00 and Time < 19:00 and Created_datetime = TODAY() order by $id asc limit 10 User_selection in (LOGINUSER()) and Department_selection not in (PRIMARY_ORGANIZATION()) Company_DB.company_name in ("kintone") and Company_DB.location like "San Francisco" Text_area is empty ``` - name: fields in: query schema: items: type: string type: array description: |- The field codes to be included in the response. Ignoring this parameter will return all accessible fields that exist in the App. When specifying this parameter in the request body, the number of field codes that can be specified is up to 1,000. When specifying this parameter in a query string, the maximum index is 99. Fields in a table cannot be specified. To retrieve a field in a table, specify the field code of the table field. All fields in the table will be retrieved. - name: totalCount in: query schema: format: boolean type: string description: |- If set to `true`, the total count of records that match the query conditions will be included in the response. Ignoring this parameter will return `null`. responses: '200': description: success case of records/get content: application/json: schema: properties: records: items: type: object additionalProperties: $ref: '#/components/schemas/RecordObject' type: array totalCount: type: string nullable: true type: object required: - records 4XX: $ref: '#/components/responses/Error' x-kintone-method-override: true description: Retrieves details of multiple records from an App by specifying the App ID and a query string. post: operationId: postRecordsForGuestSpace summary: Post records (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. records: items: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' type: array description: |- Holds an array of record objects, that contains field codes and their values. The values that can be specified vary depending on the type of field. Fields that are not included in the objects are added with their default value. Objects containing field codes that do not exist are ignored. For more information on field types, refer to the following article: [Field Types](https://kintone.dev/en/docs/kintone/overview/field-types/) required: - app - records type: object responses: '200': description: success case of records/post content: application/json: schema: properties: ids: items: type: string type: array revisions: items: type: string type: array type: object required: - ids - revisions 4XX: $ref: '#/components/responses/Error' description: Adds multiple records to an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). put: operationId: putRecordsForGuestSpace summary: Put records (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. records: items: $ref: '#/components/schemas/RecordsPutRecordForm' type: array description: Holds an array of objects that include `id`/`updateKey`, `revision` and `record` objects. upsert: type: boolean description: A mode where adding and updating records can be processed at the same time. required: - app - records type: object responses: '200': description: success case of records/put content: application/json: schema: properties: records: oneOf: - type: array items: $ref: '#/components/schemas/RecordsPutRecordBean' - type: array items: $ref: '#/components/schemas/RecordsPutUpsertRecordBean' type: object required: - records 4XX: $ref: '#/components/responses/Error' description: Updates details of multiple records in an App, by specifying their record numbers, or their unique keys. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/records/acl/evaluate.json: get: operationId: getRecordsAclEvaluateForGuestSpace summary: Get records acl evaluate (guest space) tags: - RECORDS security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: ids in: query schema: items: format: long type: string type: array required: true description: |- An array of record IDs that will be evaluated. The maximum limit is 100 IDs. responses: '200': description: success case of records/acl/evaluate/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/RecordsAclEvaluateGetRight' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Evaluates the API users permission's for records and fields within an App. /k/guest/{guestSpaceId}/v1/records/cursor.json: delete: operationId: deleteRecordsCursorForGuestSpace summary: Delete records cursor (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: type: string description: The cursor ID. required: - id type: object responses: '200': description: success case of records/cursor/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes a cursor by specifying the cursor ID. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). get: operationId: getRecordsCursorForGuestSpace summary: Get records cursor (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: id in: query schema: type: string required: true description: The cursor ID. responses: '200': description: success case of records/cursor/get content: application/json: schema: properties: next: type: boolean records: items: type: object additionalProperties: $ref: '#/components/schemas/RecordObject' type: array type: object required: - next - records 4XX: $ref: '#/components/responses/Error' description: Retrieves multiple records from an App by specifying the cursor ID. post: operationId: postRecordsCursorForGuestSpace summary: Post records cursor (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. size: format: int64 type: integer description: |- The maximum number of records the Get Cursor API can retrieve from this cursor with one request. The maximum number is 500 records. If ignored, the default number of records to be retrieved is 100. To retrieve all records, repeatedly call the Get Cursor API. For more information, refer to the following article: [Get Cursor](https://kintone.dev/en/docs/kintone/rest-api/records/get-cursor/) query: format: query type: string description: |- The search condition for the records the cursor will walk over, written in Kintone's own query syntax. The operators and functions are the same as for the `query` parameter of `GET /k/v1/records.json` — see that parameter for the table of operators each field type allows. **`order by`, `limit` and `offset` cannot be used here.** The cursor manages paging itself: set the batch size with the `size` parameter, then call `GET /k/v1/records/cursor.json` repeatedly until it reports `next: false`. Ignoring this parameter creates a cursor over all records that the credential can access. fields: items: type: string type: array description: |- The field codes to be included in the response when using the Get Cursor API. For more information, refer to the following document: [Get Cursor](https://kintone.dev/en/docs/kintone/rest-api/records/get-cursor/) If ignored, all accessible fields in the app will be returned. required: - app type: object responses: '200': description: success case of records/cursor/post content: application/json: schema: properties: id: type: string totalCount: type: string nullable: true type: object required: - id - totalCount 4XX: $ref: '#/components/responses/Error' description: Adds a cursor so that large amount of records can be obtained from an App. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/records/status.json: put: operationId: putRecordsStatusForGuestSpace summary: Put records status (guest space) tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. records: items: $ref: '#/components/schemas/RecordsStatusPutRecordsStatusPutFormRecord' type: array description: |- An array including information of the record to be updated. Up to 100 records can be specified. Specifying more than 100 records will result in an error. required: - app - records type: object responses: '200': description: success case of records/status/put content: application/json: schema: properties: records: items: $ref: '#/components/schemas/RecordsStatusPutRecordsStatusPutOutputFormRecord' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Statuses of Multiple records of an App, that were set with the Process Management feature. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/space.json: delete: operationId: deleteSpaceForGuestSpace summary: Delete space (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: format: int64 type: integer description: The Space ID. required: - id type: object responses: '200': description: success case of space/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes a Space. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). get: operationId: getSpaceForGuestSpace summary: Get space (guest space) tags: - SPACES security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: id in: query schema: type: integer format: int64 required: true description: |- The Space ID. The Space ID can be found in the URL of the Space. A Space with the URL of **https://{domainname}.kintone.com/k/#/space/111** has a Space ID of 111. responses: '200': description: success case of space/get content: application/json: schema: properties: coverKey: type: string creator: properties: code: type: string name: type: string type: object isGuest: type: boolean modifier: properties: code: type: string name: type: string type: object memberCount: type: string attachedApps: items: $ref: '#/components/schemas/SpaceGetAttachedApp' type: array isPrivate: type: boolean body: type: string showAppList: type: boolean coverUrl: type: string coverType: enum: - BLOB - PRESET type: string fixedMember: type: boolean permissions: properties: createApp: enum: - EVERYONE - ADMIN type: string type: object name: type: string useMultiThread: type: boolean showMemberList: type: boolean showRelatedLinkList: type: boolean id: type: string showAnnouncement: type: boolean showThreadList: type: boolean defaultThread: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets information of a Space. put: operationId: putSpaceForGuestSpace summary: Put space (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fixedMember: type: boolean description: |- The options set for the **Block users from joining or leaving the space and following or unfollowing the threads** setting. `true`: Users cannot join/leave the Space or follow/unfollow threads. `false`: Users can join/leave the Space and follow/unfollow threads. permissions: properties: createApp: enum: - EVERYONE - ADMIN type: string description: |- The option set for the **Only Allow Space Administrators to Create Apps** setting `EVERYONE`: all users can create apps. `ADMIN`: only administrators can create apps. type: object description: An object containing information of the space's permission settings. name: maxLength: 128 minLength: 1 type: string description: The new name of the Space. useMultiThread: type: boolean description: |- The **Enable multiple threads** setting. `true`: The Space is a Multi-threaded Space. `false`: The setting will not be updated, as a Multi-Threaded Space can not be reverted to a Single-threaded Space. showMemberList: type: boolean description: |- The display status for the **People** widget. `true`: The **People** widget is displayed. `false`: The **People** widget is not displayed. showRelatedLinkList: type: boolean description: |- The display status for the **Related Apps & Spaces** widget. `true`: The **Related Apps & Spaces** widget is displayed. `false`: The **Related Apps & Spaces** widget is not displayed. id: format: int64 type: integer description: The Space ID. isPrivate: type: boolean description: |- The **Private** settings of the Space. `true`: The Space is private. `false`: The Space is not private. showAnnouncement: type: boolean description: |- The display status for the **Announcement** widget. `true`: The **Announcement** widget is displayed. `false`: The **Announcement** widget is not displayed. showThreadList: type: boolean description: |- The display status for the **Threads** widget. `true`: The **Threads** widget is displayed. `false`: The **Threads** widget is not displayed. showAppList: type: boolean description: |- The display status for the **Apps** widget. `true`: The **Apps** widget is displayed. `false`: The **Apps** widget is not displayed. required: - id type: object responses: '200': description: success case of space/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the settings of a Space. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/space/body.json: put: operationId: putSpaceBodyForGuestSpace summary: Put space body (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: format: int64 type: integer description: The Space ID. body: type: string description: |- The contents of the body as an HTML string. HTML tags that cannot be used will be automatically removed. HTML can be used to attach Apps, files and Emoji. The usage of the @ mark to mention a user will not notify that user. required: - id - body type: object responses: '200': description: success case of space/body/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the body of a Space. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/space/guests.json: put: operationId: putSpaceGuestsForGuestSpace summary: Put space guests (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: guests: items: format: email type: string type: array id: format: int64 type: integer required: - guests - id type: object responses: '200': description: success case of space/guests/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/space/members.json: get: operationId: getSpaceMembersForGuestSpace summary: Get space members (guest space) tags: - SPACES security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: id in: query schema: type: integer format: int64 required: true description: The Space ID. responses: '200': description: success case of space/members/get content: application/json: schema: properties: members: items: anyOf: - $ref: '#/components/schemas/SpaceMembersGetUserBean' - $ref: '#/components/schemas/SpaceMembersGetOrganizationBean' - $ref: '#/components/schemas/SpaceMembersGetGroupBean' type: object type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of Space Members of a Space. put: operationId: putSpaceMembersForGuestSpace summary: Put space members (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: members: items: $ref: '#/components/schemas/SpaceMembersPutMemberForm' type: array description: |- A list of members of the Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. id: format: int64 type: integer description: The Space ID. required: - id type: object responses: '200': description: success case of space/members/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Members of a Space. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/space/thread.json: post: operationId: postSpaceThreadForGuestSpace summary: Post space thread (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: name: maxLength: 128 minLength: 1 type: string description: |- The new name of the Thread. Must be between 1 - 128 characters. space: format: int64 type: integer description: The Space ID. required: - name - space type: object responses: '200': description: success case of space/thread/post content: application/json: schema: properties: id: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Adds a Thread in a Space. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). put: operationId: putSpaceThreadForGuestSpace summary: Put space thread (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: name: maxLength: 128 minLength: 1 type: string description: |- The new name of the Thread. Must be between 1 - 128 characters. The name will not be updated if this parameter is ignored. The Thread name of single threaded Spaces cannot be updated. id: format: int64 type: integer description: |- The Thread ID. The Thread ID can be found in the URL of the Thread. A Space with the URL of `https://{subdomain}.kintone.com/k/#/space/111/thread/222` has a Space ID of 111 and a Thread ID of 222. body: type: string description: |- The contents of the Thread body. Write the contents as an HTML string, within 65535 characters. If the [Frontend Framework Revamp](https://kintone.dev/en/id/bbfaa03dedc276890f5db503/#frontend-revamp) is enabled on the Space and Thread pages, the maximum limit is 100,000 characters. The Thread body will not be updated if this parameter is ignored. HTML tags that cannot be used will be automatically removed. HTML can be used to attach Apps, files and Emoji. The usage of the @ mark to mention a user will not notify that user. required: - id type: object responses: '200': description: success case of space/thread/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates a Thread of a Space. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/space/thread/comment.json: post: operationId: postSpaceThreadCommentForGuestSpace summary: Post space thread comment (guest space) tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: comment: properties: mentions: items: $ref: '#/components/schemas/SpaceThreadCommentPostMentionForm' type: array description: An array including mentions, that notify other Kintone users. files: items: $ref: '#/components/schemas/SpaceThreadCommentPostFileForm' type: array description: |- An array including data of attachment files. The maximum number of the files is 5. Required, if comment.text is not set. text: type: string description: |- The comment contents. A line break can be specified by LF. The maximum characters of the comment is 65535. If the [Frontend Framework Revamp](https://kintone.dev/en/id/bbfaa03dedc276890f5db503/#frontend-revamp) is enabled on the Space and Thread pages, the maximum limit is 100,000 characters. Required, if comment.files is not set. type: object description: An object including comment details. thread: format: int64 type: integer description: The Thread ID. space: format: int64 type: integer description: The Space ID. required: - comment - thread - space type: object responses: '200': description: success case of space/thread/comment/post content: application/json: schema: properties: id: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Adds a comment to a Thread of a Space. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/guest/{guestSpaceId}/v1/spaces/statistics.json: get: operationId: getSpacesStatisticsForGuestSpace summary: Get spaces statistics (guest space) tags: - SPACES security: - passwordAuth: [] parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). - name: offset in: query schema: type: string - name: limit in: query schema: type: string responses: '200': description: success case of spaces/statistics/get content: application/json: schema: properties: spaces: items: $ref: '#/components/schemas/SpacesStatisticsGetSpaceForm' type: array type: object 4XX: $ref: '#/components/responses/Error' /k/guest/{guestSpaceId}/v1/template/space.json: post: operationId: postTemplateSpaceForGuestSpace summary: Post template space (guest space) tags: - TEMPLATES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fixedMember: type: boolean description: |- The "**Block users from joining or leaving the space and following or unfollowing the threads.**" settings of the Space. - `true`: Users will not be able to join/leave the Space or follow/unfollow threads. - `false`: Users will be able to join/leave the Space and follow/unfollow threads. If ignored, this value is `false`. isGuest: type: boolean description: |- The Guest Space settings of the Space. - `true`: The Space will be a Guest Space - `false`: The Space will be a normal Space. If ignored, this value is `false`. members: items: $ref: '#/components/schemas/TemplateSpacePostMemberForm' type: array description: |- A list of members of the Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. name: maxLength: 128 minLength: 1 type: string description: The new name of the Space. id: format: int64 type: integer description: |- The Space Template ID. For instructions on creating Space Templates, refer to the following article: [Creating a Template from a Space](https://us.kintone.help/k/en/id/04075) The Space Template ID is listed on the Space Templates list page, found under https://{domainname}.kintone.com/k/admin/system/spacetemplate/ isPrivate: type: boolean description: |- The "**Private**" settings of the Space. - `true`: The Space will be Private. - `false`: The Space will not be Private. If the **isGuest** parameter is set to `true`, this value is also `true`. If ignored, this value is `false`. required: - name - id type: object responses: '200': description: success case of template/space/post content: application/json: schema: properties: id: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Creates a Space from a Space template. parameters: - name: guestSpaceId in: path required: true schema: type: integer format: int64 description: Guest space ID (the number that appears in the space URL /k/#/space/ when the space is open in a browser). /k/v1/app.json: get: operationId: getApp summary: Get app tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: id in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of app/get content: application/json: schema: properties: threadId: type: string nullable: true spaceId: type: string nullable: true createdAt: format: date-time type: string creator: properties: code: type: string name: type: string type: object code: type: string modifiedAt: format: date-time type: string appId: type: string modifier: properties: code: type: string name: type: string type: object name: type: string description: type: string type: object required: - appId - code - createdAt - creator - description - modifiedAt - modifier - name - spaceId - threadId 4XX: $ref: '#/components/responses/Error' description: Gets general information of an App, including the name, description, related Space, creator and updater information. /k/v1/app/acl.json: get: operationId: getAppAcl summary: Get app acl tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID responses: '200': description: success case of app/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/AppAclGetRight' type: array revision: type: string type: object required: - rights 4XX: $ref: '#/components/responses/Error' description: Gets the App permissions of an App. put: operationId: putAppAcl summary: Put app acl tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/AppAclPutRight' type: array description: |- An array listing data of App permissions, in order of priority. The "Everyone" group will be treated with the lowest priority, wherever it is placed in the list. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - rights type: object responses: '200': description: success case of app/acl/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the App permissions of an App. /k/v1/app/actions.json: get: operationId: getAppActions summary: Get app actions tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/actions/get content: application/json: schema: properties: actions: type: object additionalProperties: $ref: '#/components/schemas/AppActionsGetAction' revision: type: string type: object required: - actions 4XX: $ref: '#/components/responses/Error' description: Gets the Action settings of the App. /k/v1/app/adminNotes.json: get: operationId: getAppAdminNotes summary: Get app admin notes tags: - APPS security: - apiToken: [] - passwordAuth: [] parameters: - name: app in: query schema: type: string required: true description: The App ID. responses: '200': description: success case of app/adminNotes/get content: application/json: schema: properties: content: type: string includeInTemplateAndDuplicates: type: boolean revision: type: string type: object required: - content 4XX: $ref: '#/components/responses/Error' description: Gets notes for app administrator and their settings. /k/v1/app/customize.json: get: operationId: getAppCustomize summary: Get app customize tags: - APPS security: - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The app ID. responses: '200': description: success case of app/customize/get content: application/json: schema: properties: desktop: properties: css: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array type: object scope: enum: - ALL - ADMIN - NONE type: string mobile: properties: css: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/AppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/AppCustomizeGetFileContentForm' type: object type: array type: object revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Gets the JavaScript and CSS Customization settings of an App. /k/v1/app/form/fields.json: get: operationId: getAppFormFields summary: Get app form fields tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/form/fields/get content: application/json: schema: properties: properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/AppFormFieldsGetCalcFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetCategoryFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDateFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDatetimeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDecimalFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetEditorFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetFileFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetGroupFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetGroupSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetLinkFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetLookupFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetModifiedAtFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetModifierFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleCheckFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleLineTextFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetOrganizationSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetRecordIdFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetReferenceTableFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleCheckFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleLineTextFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetStatusAssigneeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetStatusFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetTableForm' - $ref: '#/components/schemas/AppFormFieldsGetTimeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetUserSelectFieldForm' type: object revision: type: string type: object required: - properties - revision 4XX: $ref: '#/components/responses/Error' description: Gets the list of fields and field settings of an App. /k/v1/app/form/layout.json: get: operationId: getAppFormLayout summary: Get app form layout tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of app/form/layout/get content: application/json: schema: properties: layout: items: anyOf: - $ref: '#/components/schemas/AppFormLayoutGetRow' - $ref: '#/components/schemas/AppFormLayoutGetGroupRow' - $ref: '#/components/schemas/AppFormLayoutGetSubtableRow' type: object type: array revision: type: string type: object required: - layout 4XX: $ref: '#/components/responses/Error' description: Gets the field layout info of a form in an App. /k/v1/app/move.json: post: operationId: postAppMove summary: Post app move tags: - APPS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. space: format: int64 type: integer description: |- The Space ID of where the App will be moved to. To remove an App from its current space, `null` can be specified. required: - app type: object responses: '200': description: success case of app/move/post content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Changes the Space where an App belongs to. /k/v1/app/notifications/general.json: get: operationId: getAppNotificationsGeneral summary: Get app notifications general tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of app/notifications/general/get content: application/json: schema: properties: notifyToCommenter: type: boolean notifications: items: $ref: '#/components/schemas/AppNotificationsGeneralGetNotification' type: array revision: type: string type: object required: - notifications 4XX: $ref: '#/components/responses/Error' description: Gets the General Notification settings of the App. /k/v1/app/notifications/perRecord.json: get: operationId: getAppNotificationsPerRecord summary: Get app notifications per record tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The response parameter `notifications[].filterCond` will include the localized option names in the query string. - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/notifications/perRecord/get content: application/json: schema: properties: notifications: items: $ref: '#/components/schemas/AppNotificationsPerRecordGetNotification' type: array revision: type: string type: object required: - notifications 4XX: $ref: '#/components/responses/Error' description: Gets the Per Record Notification settings of the App. /k/v1/app/notifications/reminder.json: get: operationId: getAppNotificationsReminder summary: Get app notifications reminder tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/notifications/reminder/get content: application/json: schema: properties: timezone: format: timezone type: string notifications: items: $ref: '#/components/schemas/AppNotificationsReminderGetNotification' type: array revision: type: string type: object required: - notifications 4XX: $ref: '#/components/responses/Error' description: Gets the Reminder Notification settings of the App. /k/v1/app/plugins.json: get: operationId: getAppPlugins summary: Get app plugins tags: - APPS security: - apiToken: [] - passwordAuth: [] parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - JA - EN - ZH - ES type: string description: |- The localized language to retrieve the data in: - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `es`: retrieves the localized Spanish names If ignored, the default names will be retrieved. responses: '200': description: success case of app/plugins/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/AppPluginsGetPluginForm' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of Plug-ins added to an App. /k/v1/app/reports.json: get: operationId: getAppReports summary: Get app reports tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/reports/get content: application/json: schema: properties: reports: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/AppReportsGetReport' - $ref: '#/components/schemas/AppReportsGetReportWithChartMode' type: object revision: type: string type: object required: - reports 4XX: $ref: '#/components/responses/Error' description: Gets the Graph settings of the App. /k/v1/app/settings.json: get: operationId: getAppSettings summary: Get app settings tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The app ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/settings/get content: application/json: schema: properties: enableComments: type: boolean titleField: $ref: '#/components/schemas/AppSettingsGetTitleField' icon: anyOf: - $ref: '#/components/schemas/AppSettingsGetIconPresetForm' - $ref: '#/components/schemas/AppSettingsGetIconFileForm' type: object description: maxLength: 10000 type: string enableThumbnails: type: boolean enableDuplicateRecord: type: boolean revision: type: string enableInlineRecordEditing: type: boolean enableBulkDeletion: type: boolean name: maxLength: 64 minLength: 1 type: string theme: enum: - WHITE - CLIPBOARD - BINDER - PENCIL - CLIPS - RED - GREEN - BLUE - YELLOW - BLACK type: string numberPrecision: $ref: '#/components/schemas/AppSettingsGetNumberPrecision' firstMonthOfFiscalYear: type: string type: object required: - description - enableBulkDeletion - enableComments - enableDuplicateRecord - enableInlineRecordEditing - enableThumbnails - firstMonthOfFiscalYear - icon - name - numberPrecision - revision - theme - titleField 4XX: $ref: '#/components/responses/Error' description: Gets the description, name, icon, revision and color theme of an App. /k/v1/app/status.json: get: operationId: getAppStatus summary: Get app status tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of app/status/get content: application/json: schema: properties: enable: type: boolean actions: items: $ref: '#/components/schemas/AppStatusGetActionForm' type: array states: type: object additionalProperties: $ref: '#/components/schemas/AppStatusGetStateForm' revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the process management settings of an App. /k/v1/app/views.json: get: operationId: getAppViews summary: Get app views tags: - APPS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. responses: '200': description: success case of app/views/get content: application/json: schema: properties: views: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/AppViewsGetBuiltinListViewOutputForm' - $ref: '#/components/schemas/AppViewsGetBuiltinCalendarViewOutputForm' - $ref: '#/components/schemas/AppViewsGetListViewOutputForm' - $ref: '#/components/schemas/AppViewsGetCalendarViewOutputForm' - $ref: '#/components/schemas/AppViewsGetCustomViewOutputForm' type: object revision: type: string type: object required: - views 4XX: $ref: '#/components/responses/Error' description: Gets the View settings of an App. /k/v1/apps.json: get: operationId: getApps summary: Get apps tags: - APPS security: - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: codes in: query schema: items: type: string type: array description: |- The App Code. Up to 100 App Codes can be specified. Each App Code must be between 1 to 64 characters. An exact match search will be used, and will be case sensitive. If `null` or an empty array is specified, this parameter will be ignored. - name: offset in: query schema: type: integer format: int64 description: |- The number of retrievals that will be skipped. Must be between 0 and 2,147,483,647. If nothing is specified, it will default to 0. - name: name in: query schema: maxLength: 64 type: string description: |- The App Name or a part of it. Each App Name must be specified within 64 characters. A partial search will be used, and the search will be case insensitive. The localized name of the App in the user's locale will also be included in the search. If `null` or an empty array is specified, this parameter will be ignored. - name: limit in: query schema: type: integer format: int64 description: |- The number of Apps to retrieve. Must be between 1 and 100. If nothing is specified, it will default to 100. - name: ids in: query schema: items: format: long type: string type: array description: |- The App IDs. Integers from 1 to 9,223,372,036,854,775,807 can be specified. Up to 100 IDs can be specified. If `null` or an empty array is specified, this parameter will be ignored. - name: spaceIds in: query schema: items: format: long type: string type: array description: |- The Space ID of where the App resides in. Integers from 1 to 9,223,372,036,854,775,807 can be specified. Up to 100 IDs can be specified. If `null` or an empty array is specified, this parameter will be ignored. responses: '200': description: success case of apps/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/AppsGetAppWithSpaceIdForm' type: array type: object required: - apps 4XX: $ref: '#/components/responses/Error' description: Gets general information of multiple Apps, including the name, description, related Space, creator and updater information. /k/v1/apps/statistics.json: get: operationId: getAppsStatistics summary: Get apps statistics tags: - APPS security: - passwordAuth: [] parameters: - name: offset in: query schema: type: string - name: limit in: query schema: type: string responses: '200': description: success case of apps/statistics/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/AppsStatisticsGetAppForm' type: array type: object 4XX: $ref: '#/components/responses/Error' /k/v1/bulkRequest.json: post: operationId: postBulkRequest summary: Post bulk request tags: - BULKREQUESTS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: requests: items: $ref: '#/components/schemas/BulkRequestPostRequestForm' type: array description: An array of requests. The maximum number of requests is 20. required: - requests type: object responses: '200': description: success case of bulkRequest/post content: application/json: schema: properties: results: items: anyOf: - $ref: '#/components/schemas/BulkRequestPostRecordPostOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordStatusPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordAssigneesPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsDeleteOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsPostOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsPutOutputForm' - $ref: '#/components/schemas/BulkRequestPostRecordsStatusPutOutputForm' type: object type: array type: object required: - results 4XX: $ref: '#/components/responses/Error' description: Runs multiple API requests sequentially to multiple Apps. /k/v1/field/acl.json: get: operationId: getFieldAcl summary: Get field acl tags: - FIELDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of field/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/FieldAclGetRight' type: array revision: type: string type: object required: - rights 4XX: $ref: '#/components/responses/Error' description: Gets the Field permission settings of an App. put: operationId: putFieldAcl summary: Put field acl tags: - FIELDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/FieldAclPutRight' type: array description: An array listing data of field permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - rights type: object responses: '200': description: success case of field/acl/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Field permission settings of an App. /k/v1/file.json: get: operationId: downloadFile summary: Download file tags: - FILES security: - apiToken: [] - passwordAuth: [] - oauth2: - k:file:read parameters: - name: fileKey in: query schema: type: string required: true description: The value that is set on the Attachment field in the response data returned when using the Get Record API. responses: '200': description: success case of file/get content: '*/*': schema: type: string format: binary 4XX: $ref: '#/components/responses/Error' description: Downloads files from an attachment field in an app. post: operationId: uploadFile summary: Upload file tags: - FILES security: - apiToken: [] - passwordAuth: [] - oauth2: - k:file:write requestBody: required: true content: multipart/form-data: schema: type: object required: - file properties: file: type: string format: binary responses: '200': description: success case of file/post content: application/json: schema: properties: fileKey: type: string type: object required: - fileKey 4XX: $ref: '#/components/responses/Error' description: Uploads a file to Kintone. /k/v1/form.json: get: operationId: getForm summary: Get form tags: - FORMS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of form/get content: application/json: schema: properties: properties: items: anyOf: - $ref: '#/components/schemas/FormGetLayoutProperties' - $ref: '#/components/schemas/FormGetLabelProperties' - $ref: '#/components/schemas/FormGetBultinProperties' - $ref: '#/components/schemas/FormGetCalcSimpleProperties' - $ref: '#/components/schemas/FormGetDateSimpleProperties' - $ref: '#/components/schemas/FormGetDatetimeSimpleProperties' - $ref: '#/components/schemas/FormGetDecimalSimpleProperties' - $ref: '#/components/schemas/FormGetEditorSimpleProperties' - $ref: '#/components/schemas/FormGetFileSimpleProperties' - $ref: '#/components/schemas/FormGetLinkSimpleProperties' - $ref: '#/components/schemas/FormGetMultipleLineTextSimpleProperties' - $ref: '#/components/schemas/FormGetMultipleSelectSimpleProperties' - $ref: '#/components/schemas/FormGetSingleLineTextSimpleProperties' - $ref: '#/components/schemas/FormGetSingleSelectSimpleProperties' - $ref: '#/components/schemas/FormGetTimeSimpleProperties' - $ref: '#/components/schemas/FormGetUserSelectSimpleProperties' - $ref: '#/components/schemas/FormGetOrganizationSelectSimpleProperties' - $ref: '#/components/schemas/FormGetGroupSelectSimpleProperties' - $ref: '#/components/schemas/FormGetLookupSimpleProperties' - $ref: '#/components/schemas/FormGetReferenceTableLayoutProperties' - $ref: '#/components/schemas/FormGetSubTableLayoutProperties' - $ref: '#/components/schemas/FormGetSpacerProperties' type: object type: array type: object 4XX: $ref: '#/components/responses/Error' description: Retrieves the form details of an app. /k/v1/guests.json: delete: operationId: deleteGuests summary: Delete guests tags: - GUESTS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: guests: items: format: email type: string type: array description: |- A list of email addresses of Guest users. Up to 100 Guests can be deleted. required: - guests type: object responses: '200': description: success case of guests/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes a Guest user from Kintone. post: operationId: postGuests summary: Post guests tags: - GUESTS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: guests: items: $ref: '#/components/schemas/GuestsPostGuestUserForm' type: array description: A list of Guest user data. required: - guests type: object responses: '200': description: success case of guests/post content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Adds Guest users to Kintone. /k/v1/plugin.json: delete: operationId: uninstallPlugin summary: Uninstall plugin tags: - PLUGINS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: type: string description: The ID of the plug-in. required: - id type: object responses: '200': description: success case of plugin/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Uninstalls a plug-in from the Kintone environment. post: operationId: installPlugin summary: Install plugin tags: - PLUGINS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fileKey: type: string description: |- The fileKey representing an uploaded file. Use the following API to upload the file and retrieve the fileKey: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) required: - fileKey type: object responses: '200': description: success case of plugin/post content: application/json: schema: properties: id: type: string version: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Imports a plug-in into Kintone. put: operationId: putPlugin summary: Put plugin tags: - PLUGINS security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fileKey: type: string description: |- The fileKey representing an uploaded file. Use the following API to upload the file and retrieve the fileKey: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) id: type: string description: The ID of the plug-in to be updated. required: - fileKey - id type: object responses: '200': description: success case of plugin/put content: application/json: schema: properties: id: type: string version: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates an imported plug-in in Kintone. /k/v1/plugin/apps.json: get: operationId: getPluginApps summary: Get plugin apps tags: - PLUGINS security: - passwordAuth: [] parameters: - name: offset in: query schema: type: string description: |- The number of plug-ins to skip from the list of plug-ins. If ignored, this value is 0. - name: limit in: query schema: type: string description: |- The maximum number of plug-ins to retrieve. Must be between 1 and 500. The default number is 100. - name: id in: query schema: type: string required: true description: The ID of the plug-in. responses: '200': description: success case of plugin/apps/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/PluginAppsGetAppDto' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets Apps that have the specified plug-In added. /k/v1/plugins.json: get: operationId: getPlugins summary: Get plugins tags: - PLUGINS security: - passwordAuth: [] parameters: - name: offset in: query schema: type: string description: |- The number of plug-ins to skip from the list of installed plug-ins. If ignored, this value is 0. - name: limit in: query schema: type: string description: |- The maximum number of plug-ins to retrieve. Must be between 1 and 100. The default number is 100. - name: ids in: query schema: items: type: string type: array description: |- The plug-in ids. The maximum limit of ids that can be specified is 100. If `null` or an empty array is specified, this parameter will be ignored, and a list of plug-ins will be returned. responses: '200': description: success case of plugins/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/PluginsGetPluginDto' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of plug-ins imported into Kintone. /k/v1/plugins/required.json: get: operationId: getPluginsRequired summary: Get plugins required tags: - PLUGINS security: - passwordAuth: [] parameters: - name: offset in: query schema: type: string description: |- The number of plug-ins to skip from the list of required plug-ins. If ignored, this value is 0. - name: limit in: query schema: type: string description: |- The maximum number of plug-ins to retrieve. Must be between 1 and 100. The default number is 100. responses: '200': description: success case of plugins/required/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/PluginsRequiredGetPluginDto' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of plug-ins that have been deleted from Kintone, but have already been added to Apps. /k/v1/preview/app.json: post: operationId: postPreviewApp summary: Post preview app tags: - PREVIEWS security: - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: name: type: string description: |- The App name. The maximum length is 64 characters. thread: format: int64 type: integer description: |- The Thread ID of the thread in the Space where the App will be created. *It is recommended to ignore this parameter so that Apps are created in the default thread. There is currently no helpful reason to create Apps in threads other than the default thread, as there are no visual representations in Kintone of Apps being related to threads. There are only visual representations of Apps being related to Spaces. space: format: int64 type: integer description: The Space ID of where the App will be created. required: - name type: object responses: '200': description: success case of preview/app/post content: application/json: schema: properties: app: type: string revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Creates a preview App. /k/v1/preview/app/acl.json: get: operationId: getPreviewAppAcl summary: Get preview app acl tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID responses: '200': description: success case of preview/app/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/PreviewAppAclGetRight' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the App permissions of an App. put: operationId: putPreviewAppAcl summary: Put preview app acl tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/PreviewAppAclPutRight' type: array description: |- An array listing data of App permissions, in order of priority. The "Everyone" group will be treated with the lowest priority, wherever it is placed in the list. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - rights type: object responses: '200': description: success case of preview/app/acl/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the App permissions of an App. /k/v1/preview/app/actions.json: get: operationId: getPreviewAppActions summary: Get preview app actions tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/actions/get content: application/json: schema: properties: actions: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppActionsGetAction' revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Action settings of the App. put: operationId: putPreviewAppActions summary: Put preview app actions tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. actions: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppActionsPutAction' description: |- An object listing `Action` settings. The object's key is the `Action`'s unique identifier, which is equal to the `Action`'s name in its default language settings. The values of the key are the various `Action` settings associated with that `Action`. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or `-1` is specified. required: - app - actions type: object responses: '200': description: success case of preview/app/actions/put content: application/json: schema: properties: actions: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppActionsPutActionResult' revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Action settings of the App. /k/v1/preview/app/adminNotes.json: get: operationId: getPreviewAppAdminNotes summary: Get preview app admin notes tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] parameters: - name: app in: query schema: type: string required: true description: The App ID. responses: '200': description: success case of preview/app/adminNotes/get content: application/json: schema: properties: content: type: string includeInTemplateAndDuplicates: type: boolean revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets notes for app administrator and their settings. put: operationId: putPreviewAppAdminNotes summary: Put preview app admin notes tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. content: maxLength: 10000 type: string description: |- The content of the notes. The content must be between 0 to 10000 characters. If the parameter is omitted, the content will not change. revision: format: int64 type: integer description: |- The revision number of the App settings. If the parameter does not match the actual revision number, it will be considered an error, and the content will not be updated. The revision will not be checked if this parameter is ignored or `-1` is specified. includeInTemplateAndDuplicates: type: string description: |- The permission settings to include this note in app templates or duplicates - `true`: include - `false`: do not include If the parameter is omitted, the content will not change. required: - app type: object responses: '200': description: success case of preview/app/adminNotes/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Update the notes for App administrators and their settings. /k/v1/preview/app/customize.json: get: operationId: getPreviewAppCustomize summary: Get preview app customize tags: - PREVIEWS security: - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The app ID. responses: '200': description: success case of preview/app/customize/get content: application/json: schema: properties: desktop: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array type: object scope: enum: - ALL - ADMIN - NONE type: string mobile: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizeGetUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizeGetFileContentForm' type: object type: array type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the JavaScript and CSS Customization settings of an App. put: operationId: putPreviewAppCustomize summary: Put preview app customize tags: - PREVIEWS security: - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. desktop: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of CSS files for desktop. js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of JavaScript files. type: object description: An object containing data of JavaScript and CSS files for the desktop. scope: enum: - ALL - ADMIN - NONE type: string description: |- The scope of customization - `ALL`: Affect all users - `ADMIN`: Affect only App administrators - `NONE`: Disable mobile: properties: css: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of CSS files for mobile. js: items: anyOf: - $ref: '#/components/schemas/PreviewAppCustomizePutUrlContentForm' - $ref: '#/components/schemas/PreviewAppCustomizePutFileContentForm' type: object type: array description: An array listing data of JavaScript files. type: object description: An object containing data of JavaScript and CSS files for the mobile. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app type: object responses: '200': description: success case of preview/app/customize/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the JavaScript and CSS Customization settings of an App. /k/v1/preview/app/deploy.json: get: operationId: getPreviewAppDeploy summary: Get preview app deploy tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: apps in: query schema: items: format: long type: string type: array required: true description: |- The list of Apps to check the deploy statuses of. The Maximum limit is 300. If Apps in Guest Spaces are specified, all Apps specified in the request must belong to that Guest Space. responses: '200': description: success case of preview/app/deploy/get content: application/json: schema: properties: apps: items: $ref: '#/components/schemas/PreviewAppDeployGetAppForm' type: array type: object required: - apps 4XX: $ref: '#/components/responses/Error' description: Gets the deployment status of the App settings for multiple Apps. post: operationId: deployApp summary: Deploy app tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: revert: type: boolean description: Specify `true` to cancel all changes made to the pre-live settings. The pre-live settings will be reverted back to the current settings of the live app. apps: items: $ref: '#/components/schemas/PreviewAppDeployPostAppForm' type: array description: |- The list of Apps to deploy the pre-live settings to the live Apps. The Maximum limit is 300. If Apps are being deployed to Guest Spaces, Apps can only be deployed to the same Guest Space. required: - apps type: object responses: '200': description: success case of preview/app/deploy/post content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the settings of a pre-live App to the live App. /k/v1/preview/app/form/fields.json: delete: operationId: deletePreviewAppFormFields summary: Delete preview app form fields tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. fields: items: type: string type: array description: |- The list of field codes of the fields to delete. Up to 100 field codes can be specified. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - fields type: object responses: '200': description: success case of preview/app/form/fields/delete content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Deletes fields from a form of an App. get: operationId: getPreviewAppFormFields summary: Get preview app form fields tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/form/fields/get content: application/json: schema: properties: properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsGetCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetUserSelectFieldForm' type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of fields and field settings of an App. post: operationId: postPreviewAppFormFields summary: Post preview app form fields tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsPostCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostUserSelectFieldForm' type: object description: |- An object with data of the field settings of the field specified in `{fieldcode}`. To update a field code, state the current field code in `{fieldcode}`, and state the new field code in `properties.{fieldcode}.code`. For the characters that can be used for field codes, refer to the following document: [Valid characters](https://us.kintone.help/k/en/id/040504#autocalc_fieldcode_20) description: An object with data of the field settings. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - properties type: object responses: '200': description: success case of preview/app/form/fields/post content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Adds fields to a form of an App. put: operationId: putPreviewAppFormFields summary: Put preview app form fields tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. properties: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsPutCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutUserSelectFieldForm' type: object description: |- An object with data of the field settings of the field specified in `{fieldcode}`. To update a field code, state the current field code in `{fieldcode}`, and state the new field code in `properties.{fieldcode}.code`. description: An object with data of the field settings. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - properties type: object responses: '200': description: success case of preview/app/form/fields/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the field settings of fields in a form of an App. /k/v1/preview/app/form/layout.json: get: operationId: getPreviewAppFormLayout summary: Get preview app form layout tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/app/form/layout/get content: application/json: schema: properties: layout: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutGetRow' - $ref: '#/components/schemas/PreviewAppFormLayoutGetGroupRow' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSubtableRow' type: object type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the field layout info of a form in an App. put: operationId: putPreviewAppFormLayout summary: Put preview app form layout tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. layout: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutPutRow' - $ref: '#/components/schemas/PreviewAppFormLayoutPutGroupRow' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSubtableRow' type: object type: array description: A list of field layouts for each row. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - layout type: object responses: '200': description: success case of preview/app/form/layout/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the field layout info of a form in an App. /k/v1/preview/app/notifications/general.json: get: operationId: getPreviewAppNotificationsGeneral summary: Get preview app notifications general tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/app/notifications/general/get content: application/json: schema: properties: notifyToCommenter: type: boolean notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsGeneralGetNotification' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the General Notification settings of the App. put: operationId: putPreviewAppNotificationsGeneral summary: Put preview app notifications general tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. notifyToCommenter: type: boolean description: |- Option to notify all commenters of a record when a comment is posted on that record. This reflects the "Send updated comment notifications to all commenters" checkbox. - `true`: Notify all commenters of the record when a comment is posted - `false`: Do not notify all commenters of the record when a comment is posted If ignored, this setting will not be changed. notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsGeneralPutNotification' type: array description: |- An array of objects consisting of "Recipients and Conditions" options. If an empty array is sent, all the recipients will be removed. If this parameter is ignored, no changes will be made to the "Recipients and Conditions" options. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app type: object responses: '200': description: success case of preview/app/notifications/general/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the General Notification settings of the App. /k/v1/preview/app/notifications/perRecord.json: get: operationId: getPreviewAppNotificationsPerRecord summary: Get preview app notifications per record tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The response parameter `notifications[].filterCond` will include the localized option names in the query string. - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/notifications/perRecord/get content: application/json: schema: properties: notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsPerRecordGetNotification' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Per Record Notification settings of the App. put: operationId: putPreviewAppNotificationsPerRecord summary: Put preview app notifications per record tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsPerRecordPutNotification' type: array description: |- An array of objects containing data of the Per Record Notification settings. If the array is empty, all of the Per Record Notification settings will be deleted. If ignored, this setting will not be changed. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app - notifications type: object responses: '200': description: success case of preview/app/notifications/perRecord/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Per Record Notification settings of the App. /k/v1/preview/app/notifications/reminder.json: get: operationId: getPreviewAppNotificationsReminder summary: Get preview app notifications reminder tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- Set this parameter if there are fields that contain multiple options, and the Localization Settings have been set for those option names. For more information, refer to the following article: [Setting Localized Names](https://us.kintone.help/k/en/id/040557) The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/notifications/reminder/get content: application/json: schema: properties: timezone: format: timezone type: string notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsReminderGetNotification' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Reminder Notification settings of the App. put: operationId: putPreviewAppNotificationsReminder summary: Put preview app notifications reminder tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. timezone: format: timezone type: string description: |- The timezone that determines the Reminder notification's timing. This reflects the "Reminder Time Zone" dropdown option. If the App's Reminder Notification settings have never been configured, the API executing user's timezone will be used. notifications: items: $ref: '#/components/schemas/PreviewAppNotificationsReminderPutNotification' type: array description: |- An array of objects consisting of "Notification Trigger" options. These options define when the notifications will be sent out, under what conditions, and the recipients. If an empty array is sent, all the recipients will be removed. If this parameter is ignored, no changes will be made to the "Notification Trigger" options. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app type: object responses: '200': description: success case of preview/app/notifications/reminder/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Reminder Notification settings of the App. /k/v1/preview/app/plugins.json: get: operationId: getPreviewAppPlugins summary: Get preview app plugins tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - JA - EN - ZH - ES type: string description: |- The localized language to retrieve the data in: - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `es`: retrieves the localized Spanish names If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/plugins/get content: application/json: schema: properties: plugins: items: $ref: '#/components/schemas/PreviewAppPluginsGetPluginForm' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of Plug-ins added to an App. post: operationId: postPreviewAppPlugins summary: Post preview app plugins tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. ids: items: type: string type: array description: The Plug-in IDs that will be added to the App. revision: format: int64 type: integer description: |- Specify the expected current revision number for the App. The request will fail if the stated revision number is not the latest revision. The revision will not be checked if this parameter is ignored or `-1` is specified. required: - app - ids type: object responses: '200': description: success case of preview/app/plugins/post content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Adds Plug-ins to an App. /k/v1/preview/app/reports.json: get: operationId: getPreviewAppReports summary: Get preview app reports tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/reports/get content: application/json: schema: properties: reports: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetReport' - $ref: '#/components/schemas/PreviewAppReportsGetReportWithChartMode' type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Graph settings of the App. put: operationId: putPreviewAppReports summary: Put preview app reports tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. reports: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppReportsPutReport' - $ref: '#/components/schemas/PreviewAppReportsPutReportWithChartMode' type: object description: |- An object listing Graph information of 1 graph. If _graphname_ is equal to the name of an existing graph, the graph will be updated with the values in the object. If _graphname_ is not equal to a name of an existing graph, a new graph will be created with the values in the object. Any existing graphs that are not set for this parameter will be deleted. description: |- An object listing Graph information. The key of the object is the graph's unique identifier, which is equal to the name of the graph in its default language settings. The values of the key are the various graph settings associated with that graph. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored or -1 is specified. required: - app - reports type: object responses: '200': description: success case of preview/app/reports/put content: application/json: schema: properties: reports: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppReportsPutReportResult' revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Graph settings of the App. /k/v1/preview/app/settings.json: get: operationId: getPreviewAppSettings summary: Get preview app settings tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The app ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/settings/get content: application/json: schema: properties: enableComments: type: boolean titleField: $ref: '#/components/schemas/PreviewAppSettingsGetTitleField' icon: anyOf: - $ref: '#/components/schemas/PreviewAppSettingsGetIconPresetForm' - $ref: '#/components/schemas/PreviewAppSettingsGetIconFileForm' type: object description: maxLength: 10000 type: string enableThumbnails: type: boolean enableDuplicateRecord: type: boolean revision: type: string enableInlineRecordEditing: type: boolean enableBulkDeletion: type: boolean name: maxLength: 64 minLength: 1 type: string theme: enum: - WHITE - CLIPBOARD - BINDER - PENCIL - CLIPS - RED - GREEN - BLUE - YELLOW - BLACK type: string numberPrecision: $ref: '#/components/schemas/PreviewAppSettingsGetNumberPrecision' firstMonthOfFiscalYear: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the description, name, icon, revision and color theme of an App. put: operationId: putPreviewAppSettings summary: Put preview app settings tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. enableComments: type: string description: The **Enable comments** setting. titleField: allOf: - $ref: '#/components/schemas/PreviewAppSettingsPutTitleField' description: The record title. icon: anyOf: - $ref: '#/components/schemas/PreviewAppSettingsPutIconPresetForm' - $ref: '#/components/schemas/PreviewAppSettingsPutIconFileForm' type: object description: An object containing information of the App icon. description: maxLength: 10000 type: string description: The App description. The maximum character limit is 10,000. HTML tags can be used. enableThumbnails: type: string description: The **Show thumbnails** setting. enableDuplicateRecord: type: string description: The **Enable the feature to "duplicate record"** setting. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. enableInlineRecordEditing: type: string description: The **Enable inline record editing** setting. enableBulkDeletion: type: string description: The **Enable bulk deletion of records** setting. name: maxLength: 64 minLength: 1 type: string description: The App name. The maximum character limit is 64. theme: enum: - WHITE - CLIPBOARD - BINDER - PENCIL - CLIPS - RED - GREEN - BLUE - YELLOW - BLACK type: string description: |- The Color theme. The following can be specified: - `WHITE`: Default - `RED` - `BLUE` - `GREEN` - `YELLOW` - `BLACK` numberPrecision: allOf: - $ref: '#/components/schemas/PreviewAppSettingsPutNumberPrecision' description: |- The **Precision of numbers and calculations** setting. For more information, refer to the following article on the Kintone Help site: [Precision of numbers and calculations](https://us.kintone.help/k/en/id/040508#autocalc_rounding_30) firstMonthOfFiscalYear: type: string description: The **First month of Fiscal Year** setting. Specify an integer from 1 to 12, representing the month. required: - app type: object responses: '200': description: success case of preview/app/settings/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the description, name, icon, revision and color theme of an App. /k/v1/preview/app/status.json: get: operationId: getPreviewAppStatus summary: Get preview app status tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/app/status/get content: application/json: schema: properties: enable: type: boolean actions: items: $ref: '#/components/schemas/PreviewAppStatusGetActionForm' type: array states: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppStatusGetStateForm' revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the process management settings of an App. put: operationId: putPreviewAppStatus summary: Put preview app status tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. enable: type: boolean description: |- The on/off settings of the process management settings. - `true`: Process management settings is enabled. - `false`: Process management settings is disabled. actions: items: $ref: '#/components/schemas/PreviewAppStatusPutActionForm' type: array description: An array containing data of the Actions. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. states: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppStatusPutStateForm' description: |- An object containing data of the process management statuses. When adding or updating a status, specify the existing statuses in `states` as well. If not specified, the existing statuses will be deleted. required: - app type: object responses: '200': description: success case of preview/app/status/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the process management settings of an App. /k/v1/preview/app/views.json: get: operationId: getPreviewAppViews summary: Get preview app views tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. responses: '200': description: success case of preview/app/views/get content: application/json: schema: properties: views: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppViewsGetBuiltinListViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetBuiltinCalendarViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetListViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetCalendarViewOutputForm' - $ref: '#/components/schemas/PreviewAppViewsGetCustomViewOutputForm' type: object revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the View settings of an App. put: operationId: putPreviewAppViews summary: Put preview app views tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. views: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppViewsPutListViewForm' - $ref: '#/components/schemas/PreviewAppViewsPutCalendarViewForm' - $ref: '#/components/schemas/PreviewAppViewsPutCustomViewForm' type: object description: |- The setting of each Views. - Add a View: Specify the name of the View to be add as `views.{viewname}`. - Update a View: Specify the name of the View before update as `views.{viewname}` - Delete a View: Do not specify the View name to be deleted. When Process Management is enabled, specify **Assigned to me**. description: |- An object of data of Views. When adding or updating views, specify the existing views. If not specified, those views will be deleted. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - app - views type: object responses: '200': description: success case of preview/app/views/put content: application/json: schema: properties: views: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppViewsPutResult' revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the View settings of an App. /k/v1/preview/field/acl.json: get: operationId: getPreviewFieldAcl summary: Get preview field acl tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/field/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/PreviewFieldAclGetRight' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Field permission settings of an App. put: operationId: putPreviewFieldAcl summary: Put preview field acl tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/PreviewFieldAclPutRight' type: array description: An array listing data of field permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or `-1` is specified. required: - rights type: object responses: '200': description: success case of preview/field/acl/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Field permission settings of an App. /k/v1/preview/form.json: get: operationId: getPreviewForm summary: Get preview form tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. responses: '200': description: success case of preview/form/get content: application/json: schema: properties: properties: items: anyOf: - $ref: '#/components/schemas/PreviewFormGetLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetLabelProperties' - $ref: '#/components/schemas/PreviewFormGetBultinProperties' - $ref: '#/components/schemas/PreviewFormGetCalcSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDateSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDatetimeSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDecimalSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetEditorSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetFileSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetLinkSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetMultipleLineTextSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetMultipleSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetSingleLineTextSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetSingleSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetTimeSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetUserSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetOrganizationSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetGroupSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetLookupSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetReferenceTableLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetSubTableLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetSpacerProperties' type: object type: array type: object 4XX: $ref: '#/components/responses/Error' description: Retrieves the form details of an app. /k/v1/preview/record/acl.json: get: operationId: getPreviewRecordAcl summary: Get preview record acl tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of preview/record/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/PreviewRecordAclGetRight' type: array revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets the Record permission settings of an App. put: operationId: putPreviewRecordAcl summary: Put preview record acl tags: - PREVIEWS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_settings:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/PreviewRecordAclPutRightForm' type: array description: An array listing data of record permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - rights type: object responses: '200': description: success case of preview/record/acl/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates the Record permission settings of an App. /k/v1/record.json: get: operationId: getRecord summary: Get record tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: id in: query schema: type: integer format: int64 required: true description: The Record ID. responses: '200': description: success case of record/get content: application/json: schema: properties: record: type: object additionalProperties: $ref: '#/components/schemas/RecordObject' type: object required: - record 4XX: $ref: '#/components/responses/Error' description: Retrieves details of 1 record from an App by specifying the App ID and Record ID. post: operationId: postRecord summary: Post record tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' description: |- Field codes and values are specified in this object. The values that can be specified vary depending on the type of field. If ignored, the record will be added with default field values. If field codes that don't exist are specified, these will be ignored. For more information on field types, refer to the following article: [Field Types](https://kintone.dev/en/docs/kintone/overview/field-types/) required: - app - record type: object responses: '200': description: success case of record/post content: application/json: schema: properties: id: type: string revision: type: string type: object required: - id - revision 4XX: $ref: '#/components/responses/Error' description: Adds 1 record to an App. put: operationId: putRecord summary: Put record tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. updateKey: allOf: - $ref: '#/components/schemas/RecordPutUpdateKey' description: The unique key of the record to be updated. Required, if _id_ will not be specified. To specify this field, the field must have the "Prohibit duplicate values" option turned on. record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' description: |- Field codes and values are specified in this object. If ignored, the record will not be updated. For more information on field types, refer to the following article: [Field Types](https://kintone.dev/en/docs/kintone/overview/field-types/) id: format: int64 type: integer description: The Record ID of the record to be updated. Required, if _updateKey_ will not be specified. revision: format: int64 type: integer description: The expected revision number. If the value does not match, an error will occur and the record will not be updated. If the value is not specified or is -1, the revision number will not be checked. required: - app type: object responses: '200': description: success case of record/put content: application/json: schema: properties: revision: type: string type: object required: - revision 4XX: $ref: '#/components/responses/Error' description: Updates details of 1 record in an App by specifying its record number, or a different unique key. /k/v1/record/acl.json: get: operationId: getRecordAcl summary: Get record acl tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: lang in: query schema: enum: - default - user - ja - en - zh type: string description: |- The localized language to retrieve the data in: - `default`: retrieves the default names - `en`: retrieves the localized English names - `zh`: retrieves the localized Chinese names - `ja`: retrieves the localized Japanese names - `user`: retrieves the localized names, in the same language as the language setting* set on the user used for the authentication. If ignored, the default names will be retrieved. responses: '200': description: success case of record/acl/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/RecordAclGetRight' type: array revision: type: string type: object required: - rights 4XX: $ref: '#/components/responses/Error' description: Gets the Record permission settings of an App. put: operationId: putRecordAcl summary: Put record acl tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. rights: items: $ref: '#/components/schemas/RecordAclPutRightForm' type: array description: An array listing data of record permissions. List in order of priority. id: format: int64 type: integer revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - rights type: object responses: '200': description: success case of record/acl/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Record permission settings of an App. /k/v1/record/assignees.json: put: operationId: putRecordAssignees summary: Put record assignees tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. assignees: items: type: string type: array description: The user code(s) (log in names) of the Assignee(s). If empty, no users will be assigned. The maximum number of Assignees is 100. id: format: int64 type: integer description: The Record ID. revision: format: int64 type: integer description: The revision number of the record before updating the Assignees. If the specified revision is not the latest revision, the request will result in an error. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - assignees - id type: object responses: '200': description: success case of record/assignees/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Assignees of a Record status, that was set with the Process Management feature. /k/v1/record/async/token.json: post: operationId: postRecordAsyncToken summary: Post record async token tags: - RECORDS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: type: string required: - app type: object responses: '200': description: success case of record/async/token/post content: application/json: schema: properties: expiresIn: format: int64 type: integer token: type: string type: object 4XX: $ref: '#/components/responses/Error' /k/v1/record/comment.json: delete: operationId: deleteRecordComment summary: Delete record comment tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. record: format: int64 type: integer description: The Record ID. comment: format: int64 type: integer description: The Comment ID. required: - app - record - comment type: object responses: '200': description: success case of record/comment/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Delete a comment in a record in an app. post: operationId: postRecordComment summary: Post record comment tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. record: format: int64 type: integer description: The Record ID. comment: properties: mentions: items: $ref: '#/components/schemas/RecordCommentPostMentionForm' type: array description: An array including information to mention other users. text: maxLength: 65535 minLength: 1 type: string description: |- The comment text. The maximum length is 65,535 characters. required: - text type: object description: An object including comment details. required: - app - record - comment type: object responses: '200': description: success case of record/comment/post content: application/json: schema: properties: id: type: string type: object required: - id 4XX: $ref: '#/components/responses/Error' description: Add a comment to a record in an App. /k/v1/record/comments.json: get: operationId: getRecordComments summary: Get record comments tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: offset in: query schema: type: integer format: int64 description: |- This skips the retrieval of the first number of comments. "offset": 30 skips the first 30 comments, and retrieves from the 31st comment. There is no maximum for this value. - name: record in: query schema: type: integer format: int64 required: true description: The Record ID. - name: limit in: query schema: type: integer format: int64 description: |- The number of records to retrieve. "limit": 5 will retrieve the first 5 comments. The default and maximum is 10 comments. - name: order in: query schema: enum: - ASC - DESC type: string description: |- The sort order of the Comment ID. Specifying "asc" will sort the comments in ascending order, and "desc" will sort the comments in descending order. If ignored, "desc" will be set. responses: '200': description: success case of record/comments/get content: application/json: schema: properties: newer: type: boolean comments: items: $ref: '#/components/schemas/RecordCommentsGetCommentOutputForm' type: array older: type: boolean type: object required: - comments - newer - older 4XX: $ref: '#/components/responses/Error' description: Retrieves multiple comments from a record in an app. /k/v1/record/status.json: put: operationId: putRecordStatus summary: Put record status tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. action: type: string description: |- The Action name of the action to run. If the localization feature has been used to apply multiple translations of the Action name, specify the name of the Action in the language settings of the user that will run the API. API Tokens follow the language settings set in the User & System Administration settings. For more information, refer to the following article: [Configuring System Language](https://us.kintone.help/general/en/id/020114) id: format: int64 type: integer description: The record ID. assignee: type: string description: |- The next Assignee. Specify the Assignee's log in name. Required if one of the following conditions are met: - if the "_Assignee List_" of the current status is set to "_User chooses one assignee from the list to take action_", and a selectable assignee exists. - if the "_Assignee List_" of the initial status has been set to an `assignee`, and the status is being reverted to that initial status. revision: format: int64 type: integer description: |- The revision number of the record before updating the status. If the specified revision is not the latest revision, the request will result in an error. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app - action - id type: object responses: '200': description: success case of record/status/put content: application/json: schema: properties: revision: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Status of a record of an App, that was set with the Process Management feature. /k/v1/records.json: delete: operationId: deleteRecords summary: Delete records tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The app ID. ids: items: format: int64 type: integer type: array description: |- Array of record IDs that will be deleted. Up to 100 records can be specified. revisions: items: format: int64 type: integer type: array description: |- The Expected revision number. The first id number will correspond to the first revision number in the array, the second id to the second revision number, and so on. If the revision number does not match, an error will occur and no records will be deleted. If the revision number is left blank or is -1, the revision number will not be checked for the corresponding record ID. required: - app - ids type: object responses: '200': description: success case of records/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes multiple records in an app. get: operationId: getRecords summary: Get records tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:read parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: query in: query schema: format: query type: string description: |- The search condition, written in Kintone's own query syntax. This is **not** SQL and **not** OData. Ignoring this parameter returns all records that the credential can access. The authoritative reference is [Query Strings](https://kintone.dev/en/docs/kintone/overview/query-string/). Its rules are reproduced below so that a correct query can be built without leaving this document. ## Syntax rules - The field code always goes on the **left** of the operator, never on the right. - Wrap string values in double quotes: `Status in ("Closed")`. Numbers and times are unquoted: `price > 10`, `Time > 10:00`. - Combine conditions with `and` / `or`, and group them with parentheses. - Field codes are defined per App and are case-sensitive. Call `GET /k/v1/app/form/fields.json` first to obtain the exact field codes and their types. Do not guess field codes. ## Operators allowed per field type Using an operator that the field type does not support returns an error, so check the field type first. | Field type | Allowed operators | |---|---| | Single-line text, Link | `=` `!=` `in` `not in` `like` `not like` | | Multi-line text | `like` `not like` `is empty` `is not empty` — **`=` is not allowed** | | Rich text | `like` `not like` | | Number, Calculated | `=` `!=` `>` `<` `>=` `<=` `in` `not in` | | Drop-down, Radio button, Check box, Multi-choice | **`in` / `not in` only — `=` is not allowed** | | Date, Date and time, Time | `=` `!=` `>` `<` `>=` `<=` | | Created datetime, Updated datetime | `=` `!=` `>` `<` `>=` `<=` | | User selection, Department selection, Group selection | `in` `not in` | | Created by, Updated by | `in` `not in` | | Status | `=` `!=` `in` `not in` | | Record number, `$id` | `=` `!=` `>` `<` `>=` `<=` `in` `not in` | | Attachment | `like` `not like` `is empty` `is not empty` | | Lookup | Same as the field type it looks up | | Related Records, fields inside a Table | Same as the source field type, but `=` and `!=` are **not** allowed — use `in` / `not in` | | Field group, Category | Cannot be used in a query | To reference a field inside a Related Records field, use `.`. ## Functions | Function | Applies to | |---|---| | `LOGINUSER()` | User selection, Created by, Updated by | | `PRIMARY_ORGANIZATION()` | Department selection | | `NOW()` `TODAY()` `YESTERDAY()` `TOMORROW()` | Date, Date and time, Created datetime, Updated datetime | | `FROM_TODAY(n, "DAYS"\|"WEEKS"\|"MONTHS"\|"YEARS")` | same as above | | `THIS_WEEK(SUNDAY..SATURDAY)` `LAST_WEEK()` `NEXT_WEEK()` | same as above | | `THIS_MONTH(1..31\|LAST)` `LAST_MONTH()` `NEXT_MONTH()` | same as above | | `THIS_YEAR()` `LAST_YEAR()` `NEXT_YEAR()` | same as above | Arguments may be omitted to mean the whole week / month / year, e.g. `THIS_MONTH()`. Time fields accept no functions. ## Options Place these **after all conditions, in this exact order**: `order by`, `limit`, `offset`. | Option | Meaning | |---|---| | `order by asc\|desc` | Sort order. Separate multiple fields with commas. Defaults to record ID descending. | | `limit ` | Number of records to return. Default 100, **maximum 500 for this API**. | | `offset ` | Number of records to skip. **Maximum 10000.** To read past 10000 records, use the cursor API (`POST /k/v1/records/cursor.json`) instead. | ## Escaping Inside double quotes, escape `"` and `\` with a backslash. This is required for single-line text, multi-line text, rich text, check box, radio button, drop-down, multi-choice and status fields. Example: `Checkbox in ("sample\"1\"")` ## Examples ``` Text like "sample" and Text_area like "sample" order by Created_datetime desc Drop_down in ("value1", "value2") and (Multi_choice in ("value3") or Radio_button in ("value4")) Time > 10:00 and Time < 19:00 and Created_datetime = TODAY() order by $id asc limit 10 User_selection in (LOGINUSER()) and Department_selection not in (PRIMARY_ORGANIZATION()) Company_DB.company_name in ("kintone") and Company_DB.location like "San Francisco" Text_area is empty ``` - name: fields in: query schema: items: type: string type: array description: |- The field codes to be included in the response. Ignoring this parameter will return all accessible fields that exist in the App. When specifying this parameter in the request body, the number of field codes that can be specified is up to 1,000. When specifying this parameter in a query string, the maximum index is 99. Fields in a table cannot be specified. To retrieve a field in a table, specify the field code of the table field. All fields in the table will be retrieved. - name: totalCount in: query schema: format: boolean type: string description: |- If set to `true`, the total count of records that match the query conditions will be included in the response. Ignoring this parameter will return `null`. responses: '200': description: success case of records/get content: application/json: schema: properties: records: items: type: object additionalProperties: $ref: '#/components/schemas/RecordObject' type: array totalCount: type: string nullable: true type: object required: - records 4XX: $ref: '#/components/responses/Error' x-kintone-method-override: true description: Retrieves details of multiple records from an App by specifying the App ID and a query string. post: operationId: postRecords summary: Post records tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. records: items: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' type: array description: |- Holds an array of record objects, that contains field codes and their values. The values that can be specified vary depending on the type of field. Fields that are not included in the objects are added with their default value. Objects containing field codes that do not exist are ignored. For more information on field types, refer to the following article: [Field Types](https://kintone.dev/en/docs/kintone/overview/field-types/) required: - app - records type: object responses: '200': description: success case of records/post content: application/json: schema: properties: ids: items: type: string type: array revisions: items: type: string type: array type: object required: - ids - revisions 4XX: $ref: '#/components/responses/Error' description: Adds multiple records to an App. put: operationId: putRecords summary: Put records tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. records: items: $ref: '#/components/schemas/RecordsPutRecordForm' type: array description: Holds an array of objects that include `id`/`updateKey`, `revision` and `record` objects. upsert: type: boolean description: A mode where adding and updating records can be processed at the same time. required: - app - records type: object responses: '200': description: success case of records/put content: application/json: schema: properties: records: oneOf: - type: array items: $ref: '#/components/schemas/RecordsPutRecordBean' - type: array items: $ref: '#/components/schemas/RecordsPutUpsertRecordBean' type: object required: - records 4XX: $ref: '#/components/responses/Error' description: Updates details of multiple records in an App, by specifying their record numbers, or their unique keys. /k/v1/records/acl/evaluate.json: get: operationId: getRecordsAclEvaluate summary: Get records acl evaluate tags: - RECORDS security: - passwordAuth: [] parameters: - name: app in: query schema: type: integer format: int64 required: true description: The App ID. - name: ids in: query schema: items: format: long type: string type: array required: true description: |- An array of record IDs that will be evaluated. The maximum limit is 100 IDs. responses: '200': description: success case of records/acl/evaluate/get content: application/json: schema: properties: rights: items: $ref: '#/components/schemas/RecordsAclEvaluateGetRight' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Evaluates the API users permission's for records and fields within an App. /k/v1/records/cursor.json: delete: operationId: deleteRecordsCursor summary: Delete records cursor tags: - RECORDS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: type: string description: The cursor ID. required: - id type: object responses: '200': description: success case of records/cursor/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes a cursor by specifying the cursor ID. get: operationId: getRecordsCursor summary: Get records cursor tags: - RECORDS security: - apiToken: [] - passwordAuth: [] parameters: - name: id in: query schema: type: string required: true description: The cursor ID. responses: '200': description: success case of records/cursor/get content: application/json: schema: properties: next: type: boolean records: items: type: object additionalProperties: $ref: '#/components/schemas/RecordObject' type: array type: object required: - next - records 4XX: $ref: '#/components/responses/Error' description: Retrieves multiple records from an App by specifying the cursor ID. post: operationId: postRecordsCursor summary: Post records cursor tags: - RECORDS security: - apiToken: [] - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. size: format: int64 type: integer description: |- The maximum number of records the Get Cursor API can retrieve from this cursor with one request. The maximum number is 500 records. If ignored, the default number of records to be retrieved is 100. To retrieve all records, repeatedly call the Get Cursor API. For more information, refer to the following article: [Get Cursor](https://kintone.dev/en/docs/kintone/rest-api/records/get-cursor/) query: format: query type: string description: |- The search condition for the records the cursor will walk over, written in Kintone's own query syntax. The operators and functions are the same as for the `query` parameter of `GET /k/v1/records.json` — see that parameter for the table of operators each field type allows. **`order by`, `limit` and `offset` cannot be used here.** The cursor manages paging itself: set the batch size with the `size` parameter, then call `GET /k/v1/records/cursor.json` repeatedly until it reports `next: false`. Ignoring this parameter creates a cursor over all records that the credential can access. fields: items: type: string type: array description: |- The field codes to be included in the response when using the Get Cursor API. For more information, refer to the following document: [Get Cursor](https://kintone.dev/en/docs/kintone/rest-api/records/get-cursor/) If ignored, all accessible fields in the app will be returned. required: - app type: object responses: '200': description: success case of records/cursor/post content: application/json: schema: properties: id: type: string totalCount: type: string nullable: true type: object required: - id - totalCount 4XX: $ref: '#/components/responses/Error' description: Adds a cursor so that large amount of records can be obtained from an App. /k/v1/records/status.json: put: operationId: putRecordsStatus summary: Put records status tags: - RECORDS security: - apiToken: [] - passwordAuth: [] - oauth2: - k:app_record:write requestBody: required: true content: application/json: schema: properties: app: format: int64 type: integer description: The App ID. records: items: $ref: '#/components/schemas/RecordsStatusPutRecordsStatusPutFormRecord' type: array description: |- An array including information of the record to be updated. Up to 100 records can be specified. Specifying more than 100 records will result in an error. required: - app - records type: object responses: '200': description: success case of records/status/put content: application/json: schema: properties: records: items: $ref: '#/components/schemas/RecordsStatusPutRecordsStatusPutOutputFormRecord' type: array type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Statuses of Multiple records of an App, that were set with the Process Management feature. /k/v1/space.json: delete: operationId: deleteSpace summary: Delete space tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: format: int64 type: integer description: The Space ID. required: - id type: object responses: '200': description: success case of space/delete content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Deletes a Space. get: operationId: getSpace summary: Get space tags: - SPACES security: - passwordAuth: [] parameters: - name: id in: query schema: type: integer format: int64 required: true description: |- The Space ID. The Space ID can be found in the URL of the Space. A Space with the URL of **https://{domainname}.kintone.com/k/#/space/111** has a Space ID of 111. responses: '200': description: success case of space/get content: application/json: schema: properties: coverKey: type: string creator: properties: code: type: string name: type: string type: object isGuest: type: boolean modifier: properties: code: type: string name: type: string type: object memberCount: type: string attachedApps: items: $ref: '#/components/schemas/SpaceGetAttachedApp' type: array isPrivate: type: boolean body: type: string showAppList: type: boolean coverUrl: type: string coverType: enum: - BLOB - PRESET type: string fixedMember: type: boolean permissions: properties: createApp: enum: - EVERYONE - ADMIN type: string type: object name: type: string useMultiThread: type: boolean showMemberList: type: boolean showRelatedLinkList: type: boolean id: type: string showAnnouncement: type: boolean showThreadList: type: boolean defaultThread: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Gets information of a Space. put: operationId: putSpace summary: Put space tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fixedMember: type: boolean description: |- The options set for the **Block users from joining or leaving the space and following or unfollowing the threads** setting. `true`: Users cannot join/leave the Space or follow/unfollow threads. `false`: Users can join/leave the Space and follow/unfollow threads. permissions: properties: createApp: enum: - EVERYONE - ADMIN type: string description: |- The option set for the **Only Allow Space Administrators to Create Apps** setting `EVERYONE`: all users can create apps. `ADMIN`: only administrators can create apps. type: object description: An object containing information of the space's permission settings. name: maxLength: 128 minLength: 1 type: string description: The new name of the Space. useMultiThread: type: boolean description: |- The **Enable multiple threads** setting. `true`: The Space is a Multi-threaded Space. `false`: The setting will not be updated, as a Multi-Threaded Space can not be reverted to a Single-threaded Space. showMemberList: type: boolean description: |- The display status for the **People** widget. `true`: The **People** widget is displayed. `false`: The **People** widget is not displayed. showRelatedLinkList: type: boolean description: |- The display status for the **Related Apps & Spaces** widget. `true`: The **Related Apps & Spaces** widget is displayed. `false`: The **Related Apps & Spaces** widget is not displayed. id: format: int64 type: integer description: The Space ID. isPrivate: type: boolean description: |- The **Private** settings of the Space. `true`: The Space is private. `false`: The Space is not private. showAnnouncement: type: boolean description: |- The display status for the **Announcement** widget. `true`: The **Announcement** widget is displayed. `false`: The **Announcement** widget is not displayed. showThreadList: type: boolean description: |- The display status for the **Threads** widget. `true`: The **Threads** widget is displayed. `false`: The **Threads** widget is not displayed. showAppList: type: boolean description: |- The display status for the **Apps** widget. `true`: The **Apps** widget is displayed. `false`: The **Apps** widget is not displayed. required: - id type: object responses: '200': description: success case of space/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the settings of a Space. /k/v1/space/body.json: put: operationId: putSpaceBody summary: Put space body tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: id: format: int64 type: integer description: The Space ID. body: type: string description: |- The contents of the body as an HTML string. HTML tags that cannot be used will be automatically removed. HTML can be used to attach Apps, files and Emoji. The usage of the @ mark to mention a user will not notify that user. required: - id - body type: object responses: '200': description: success case of space/body/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the body of a Space. /k/v1/space/members.json: get: operationId: getSpaceMembers summary: Get space members tags: - SPACES security: - passwordAuth: [] parameters: - name: id in: query schema: type: integer format: int64 required: true description: The Space ID. responses: '200': description: success case of space/members/get content: application/json: schema: properties: members: items: anyOf: - $ref: '#/components/schemas/SpaceMembersGetUserBean' - $ref: '#/components/schemas/SpaceMembersGetOrganizationBean' - $ref: '#/components/schemas/SpaceMembersGetGroupBean' type: object type: array type: object 4XX: $ref: '#/components/responses/Error' description: Gets the list of Space Members of a Space. put: operationId: putSpaceMembers summary: Put space members tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: members: items: $ref: '#/components/schemas/SpaceMembersPutMemberForm' type: array description: |- A list of members of the Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. id: format: int64 type: integer description: The Space ID. required: - id type: object responses: '200': description: success case of space/members/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates the Members of a Space. /k/v1/space/thread.json: post: operationId: postSpaceThread summary: Post space thread tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: name: maxLength: 128 minLength: 1 type: string description: |- The new name of the Thread. Must be between 1 - 128 characters. space: format: int64 type: integer description: The Space ID. required: - name - space type: object responses: '200': description: success case of space/thread/post content: application/json: schema: properties: id: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Adds a Thread in a Space. put: operationId: putSpaceThread summary: Put space thread tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: name: maxLength: 128 minLength: 1 type: string description: |- The new name of the Thread. Must be between 1 - 128 characters. The name will not be updated if this parameter is ignored. The Thread name of single threaded Spaces cannot be updated. id: format: int64 type: integer description: |- The Thread ID. The Thread ID can be found in the URL of the Thread. A Space with the URL of `https://{subdomain}.kintone.com/k/#/space/111/thread/222` has a Space ID of 111 and a Thread ID of 222. body: type: string description: |- The contents of the Thread body. Write the contents as an HTML string, within 65535 characters. If the [Frontend Framework Revamp](https://kintone.dev/en/id/bbfaa03dedc276890f5db503/#frontend-revamp) is enabled on the Space and Thread pages, the maximum limit is 100,000 characters. The Thread body will not be updated if this parameter is ignored. HTML tags that cannot be used will be automatically removed. HTML can be used to attach Apps, files and Emoji. The usage of the @ mark to mention a user will not notify that user. required: - id type: object responses: '200': description: success case of space/thread/put content: application/json: schema: type: object 4XX: $ref: '#/components/responses/Error' description: Updates a Thread of a Space. /k/v1/space/thread/comment.json: post: operationId: postSpaceThreadComment summary: Post space thread comment tags: - SPACES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: comment: properties: mentions: items: $ref: '#/components/schemas/SpaceThreadCommentPostMentionForm' type: array description: An array including mentions, that notify other Kintone users. files: items: $ref: '#/components/schemas/SpaceThreadCommentPostFileForm' type: array description: |- An array including data of attachment files. The maximum number of the files is 5. Required, if comment.text is not set. text: type: string description: |- The comment contents. A line break can be specified by LF. The maximum characters of the comment is 65535. If the [Frontend Framework Revamp](https://kintone.dev/en/id/bbfaa03dedc276890f5db503/#frontend-revamp) is enabled on the Space and Thread pages, the maximum limit is 100,000 characters. Required, if comment.files is not set. type: object description: An object including comment details. thread: format: int64 type: integer description: The Thread ID. space: format: int64 type: integer description: The Space ID. required: - comment - thread - space type: object responses: '200': description: success case of space/thread/comment/post content: application/json: schema: properties: id: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Adds a comment to a Thread of a Space. /k/v1/spaces/statistics.json: get: operationId: getSpacesStatistics summary: Get spaces statistics tags: - SPACES security: - passwordAuth: [] parameters: - name: offset in: query schema: type: string - name: limit in: query schema: type: string responses: '200': description: success case of spaces/statistics/get content: application/json: schema: properties: spaces: items: $ref: '#/components/schemas/SpacesStatisticsGetSpaceForm' type: array type: object 4XX: $ref: '#/components/responses/Error' /k/v1/template/space.json: post: operationId: postTemplateSpace summary: Post template space tags: - TEMPLATES security: - passwordAuth: [] requestBody: required: true content: application/json: schema: properties: fixedMember: type: boolean description: |- The "**Block users from joining or leaving the space and following or unfollowing the threads.**" settings of the Space. - `true`: Users will not be able to join/leave the Space or follow/unfollow threads. - `false`: Users will be able to join/leave the Space and follow/unfollow threads. If ignored, this value is `false`. isGuest: type: boolean description: |- The Guest Space settings of the Space. - `true`: The Space will be a Guest Space - `false`: The Space will be a normal Space. If ignored, this value is `false`. members: items: $ref: '#/components/schemas/TemplateSpacePostMemberForm' type: array description: |- A list of members of the Space. At least one Space Administrator must be specified. Inactive and deleted users cannot be specified. name: maxLength: 128 minLength: 1 type: string description: The new name of the Space. id: format: int64 type: integer description: |- The Space Template ID. For instructions on creating Space Templates, refer to the following article: [Creating a Template from a Space](https://us.kintone.help/k/en/id/04075) The Space Template ID is listed on the Space Templates list page, found under https://{domainname}.kintone.com/k/admin/system/spacetemplate/ isPrivate: type: boolean description: |- The "**Private**" settings of the Space. - `true`: The Space will be Private. - `false`: The Space will not be Private. If the **isGuest** parameter is set to `true`, this value is also `true`. If ignored, this value is `false`. required: - name - id type: object responses: '200': description: success case of template/space/post content: application/json: schema: properties: id: type: string type: object 4XX: $ref: '#/components/responses/Error' description: Creates a Space from a Space template. components: securitySchemes: apiToken: type: apiKey in: header name: X-Cybozu-API-Token description: API token authentication (recommended). Specify a token generated in the app settings in the X-Cybozu-API-Token header. To target multiple apps, list tokens separated by commas. Because tokens are scoped per app, some APIs such as user/organization/group management (User API) and space administration require password authentication. passwordAuth: type: apiKey in: header name: X-Cybozu-Authorization description: Password authentication. Specify the Base64-encoded value of `login-name:password` in the X-Cybozu-Authorization header. Use it for APIs that cannot be executed with an API token (User API, space administration, etc.). Intended for server-side use; do not enter credentials into a shared or public Try console. oauth2: type: oauth2 description: OAuth2 authentication (authorization code flow). Used when a user delegates permissions to a third-party app. Requires prior OAuth client registration (client ID/secret); the required scopes are specified per operation in `security`. Use exactly one method; it is not combined with token/password authentication. flows: authorizationCode: authorizationUrl: https://{subdomain}.cybozu.com/oauth2/authorization tokenUrl: https://{subdomain}.cybozu.com/oauth2/token scopes: k:app_record:read: Read records. k:app_record:write: Add, update, and delete records. k:app_settings:read: Read app settings. k:app_settings:write: Change app settings. k:file:read: Download files. k:file:write: Upload files. responses: Error: description: Error response. When a request fails, an HTTP status code other than 2xx is returned together with an error object containing id / code / message. content: application/json: schema: $ref: '#/components/schemas/KintoneError' example: id: 1505999166-897850006 code: CB_IJ01 message: Invalid JSON string. schemas: AppAclGetRight: properties: recordImportable: type: boolean appEditable: type: boolean recordExportable: type: boolean recordAddable: type: boolean recordViewable: type: boolean recordEditable: type: boolean includeSubs: type: boolean recordDeletable: type: boolean entity: properties: code: type: string type: enum: - USER - ORGANIZATION - GROUP - CREATOR type: string type: object type: object AppAclPutRight: properties: recordImportable: type: boolean description: |- The file import permission of the entity. The record add permissions must also be enabled to set this value as `true`. - `true`: Files will be importable - `false`: Files will not be importable If ignored, this value is false. appEditable: type: boolean description: |- The App management permission of the entity. - The App's settings will be accessible. - The App's settings will not be accessible. If ignored, this value is false. recordExportable: type: boolean description: |- The file export permission of the entity. - `true`: Files will be exportable - `false`: Files will not be exportable If ignored, this value is false. recordAddable: type: boolean description: |- The record add permission of the entity - `true`: Records can be added. - `false`: Records cannot be added. If ignored, this value is false. recordViewable: type: boolean description: |- The record view permission of the entity. - `true`: Records will be viewable. - `false`: Records will not be viewable. If ignored, this value is false. recordEditable: type: boolean description: |- The record edit permission of the entity. The record view permissions must also be enabled to set this value as `true`. - `true`: Records will be editable. - `false`: Records will not be editable. If ignored, this value is false. recordDeletable: type: boolean description: |- The record delete permission of the entity. The record view permissions must also be enabled to set this value as `true`. - `true`: Records will be deletable. - `false`: Records will not be deletable. If ignored, this value is false. includeSubs: type: boolean description: |- The permission inheritance settings of the department the permission is granted to. This parameter is available if "ORGANIZATION" is specified for the **rights[].entity.type** parameter. - `true`: Permissions will be inherited. - `false`: Permissions will not be inherited. If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the permission is granted to. To specify guest space users, add the string "guest/" before the guest's log in name. If the "Everyone" group is not specified, the "Everyone" group will have no permissions to view/edit/delete. If "CREATOR" is specified for the **rights[].entity.type** parameter, ignore this parameter. Otherwise, this parameter is required. type: enum: - USER - ORGANIZATION - GROUP - CREATOR type: string description: |- The type of the entity the permission will be granted to. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department - **CREATOR**: The creator of the App required: - type type: object description: An object containing data of the entity the permission is granted to. required: - entity type: object AppActionsGetAction: properties: mappings: items: anyOf: - $ref: '#/components/schemas/AppActionsGetUrlMapping' - $ref: '#/components/schemas/AppActionsGetFieldMapping' type: object type: array entities: items: $ref: '#/components/schemas/AppActionsGetEntity' type: array name: type: string index: format: int64 type: integer id: format: int64 type: integer filterCond: type: string destApp: properties: app: format: int64 type: integer code: type: string type: object type: object AppActionsGetEntity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION type: string type: object AppActionsGetFieldMapping: properties: destField: type: string srcType: enum: - FIELD type: string srcField: type: string type: object AppActionsGetUrlMapping: properties: destField: type: string srcType: enum: - RECORD_URL type: string type: object AppCustomizeGetFileContentForm: properties: file: properties: size: type: string name: type: string fileKey: type: string contentType: type: string required: - fileKey type: object type: enum: - URL - FILE type: string required: - file - type type: object AppCustomizeGetUrlContentForm: properties: type: enum: - URL - FILE type: string url: type: string required: - type - url type: object AppFormFieldsGetCalcFieldForm: properties: noLabel: format: boolean type: boolean unit: maxLength: 128 type: string expression: type: string code: maxLength: 128 minLength: 1 type: string format: enum: - NUMBER - NUMBER_DIGIT - DATETIME - DATE - TIME - HOUR_MINUTE - DAY_HOUR_MINUTE type: string unitPosition: enum: - BEFORE - AFTER type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string displayScale: format: int64 type: integer hideExpression: format: boolean type: boolean required: format: boolean type: boolean required: - type type: object AppFormFieldsGetCategoryFieldForm: properties: code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string enabled: format: boolean type: boolean required: - type type: object AppFormFieldsGetDateFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string unique: format: boolean type: boolean defaultNowValue: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetDatetimeFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string unique: format: boolean type: boolean defaultNowValue: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetDecimalFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string maxValue: format: int64 type: integer defaultValue: maxLength: 1000 type: string unitPosition: enum: - BEFORE - AFTER type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean minValue: format: int64 type: integer unit: maxLength: 128 type: string unique: format: boolean type: boolean displayScale: format: int64 type: integer digit: format: boolean type: boolean required: - type type: object AppFormFieldsGetEditorFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetEntityForm: properties: code: type: string type: enum: - USER - ORGANIZATION - GROUP - FUNCTION type: string required: - code - type type: object AppFormFieldsGetFieldMappingForm: properties: relatedField: type: string field: type: string type: object AppFormFieldsGetFileFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string thumbnailSize: format: int64 type: integer label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetGroupFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string openGroup: format: boolean type: boolean required: - type type: object AppFormFieldsGetGroupSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string entities: items: $ref: '#/components/schemas/AppFormFieldsGetEntityForm' type: array defaultValue: items: $ref: '#/components/schemas/AppFormFieldsGetEntityForm' type: array label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetLinkFieldForm: properties: noLabel: format: boolean type: boolean protocol: enum: - WEB - CALL - MAIL type: string code: maxLength: 128 minLength: 1 type: string defaultValue: type: string minLength: format: int64 type: integer unique: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string maxLength: format: int64 type: integer required: format: boolean type: boolean required: - type type: object AppFormFieldsGetLookupFieldForm: properties: noLabel: format: boolean type: boolean lookup: properties: lookupPickerFields: items: type: string type: array relatedKeyField: type: string relatedApp: properties: app: format: int64 type: integer code: type: string type: object fieldMappings: items: $ref: '#/components/schemas/AppFormFieldsGetFieldMappingForm' type: array sort: type: string filterCond: type: string type: object code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetModifiedAtFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object AppFormFieldsGetModifierFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object AppFormFieldsGetMultipleCheckFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: items: type: string type: array options: type: object additionalProperties: $ref: '#/components/schemas/AppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string align: enum: - HORIZONTAL - VERTICAL type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetMultipleLineTextFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetMultipleSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: items: type: string type: array options: type: object additionalProperties: $ref: '#/components/schemas/AppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetOptionForm: properties: index: format: int64 type: integer label: maxLength: 128 minLength: 1 type: string required: - index type: object AppFormFieldsGetOrganizationSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string entities: items: $ref: '#/components/schemas/AppFormFieldsGetEntityForm' type: array defaultValue: items: $ref: '#/components/schemas/AppFormFieldsGetEntityForm' type: array label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetRecordIdFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object AppFormFieldsGetReferenceTableFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string referenceTable: properties: condition: properties: relatedField: type: string field: type: string type: object size: format: int64 type: integer relatedApp: properties: app: format: int64 type: integer code: type: string type: object sort: type: string filterCond: type: string displayFields: items: type: string type: array type: object required: - type type: object AppFormFieldsGetSingleCheckFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: maxLength: 128 minLength: 1 type: string options: type: object additionalProperties: $ref: '#/components/schemas/AppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string align: enum: - HORIZONTAL - VERTICAL type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetSingleLineTextFieldForm: properties: noLabel: format: boolean type: boolean expression: type: string code: maxLength: 128 minLength: 1 type: string defaultValue: type: string minLength: format: int64 type: integer unique: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string maxLength: format: int64 type: integer hideExpression: format: boolean type: boolean required: format: boolean type: boolean required: - type type: object AppFormFieldsGetSingleSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: maxLength: 128 type: string options: type: object additionalProperties: $ref: '#/components/schemas/AppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetStatusAssigneeFieldForm: properties: code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string enabled: format: boolean type: boolean required: - type type: object AppFormFieldsGetStatusFieldForm: properties: code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string enabled: format: boolean type: boolean required: - type type: object AppFormFieldsGetTableForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string fields: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/AppFormFieldsGetCalcFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetCategoryFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDateFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDatetimeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetDecimalFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetEditorFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetFileFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetGroupFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetGroupSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetLinkFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetLookupFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetModifiedAtFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetModifierFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleCheckFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleLineTextFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetMultipleSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetOrganizationSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetRecordIdFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetReferenceTableFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleCheckFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleLineTextFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetSingleSelectFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetStatusAssigneeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetStatusFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetTableForm' - $ref: '#/components/schemas/AppFormFieldsGetTimeFieldForm' - $ref: '#/components/schemas/AppFormFieldsGetUserSelectFieldForm' type: object type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object AppFormFieldsGetTimeFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string defaultNowValue: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormFieldsGetUserSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string entities: items: $ref: '#/components/schemas/AppFormFieldsGetEntityForm' type: array defaultValue: items: $ref: '#/components/schemas/AppFormFieldsGetEntityForm' type: array label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object AppFormLayoutGetCalcField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetCreatedAtField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetCreatorField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetDateField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetDatetimeField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetDecimalField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetEditorField: properties: code: maxLength: 128 type: string size: properties: innerHeight: format: int64 type: integer width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetFileField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetGroupRow: properties: layout: items: $ref: '#/components/schemas/AppFormLayoutGetRow' type: array code: maxLength: 128 type: string type: enum: - ROW - SUBTABLE - GROUP type: string required: - code - type type: object AppFormLayoutGetHrField: properties: elementId: maxLength: 64 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - type type: object AppFormLayoutGetLabelField: properties: elementId: maxLength: 64 type: string size: properties: width: format: int64 type: integer type: object label: type: string type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - type type: object AppFormLayoutGetLinkField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetLookupField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetModifiedAtField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetModifierField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetMultipleCheckField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetMultipleLineTextField: properties: code: maxLength: 128 type: string size: properties: innerHeight: format: int64 type: integer width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetMultipleSelectField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetRecordIdField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetReferenceTableField: properties: code: maxLength: 128 type: string type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetRow: properties: fields: items: anyOf: - $ref: '#/components/schemas/AppFormLayoutGetLabelField' - $ref: '#/components/schemas/AppFormLayoutGetSingleLineTextField' - $ref: '#/components/schemas/AppFormLayoutGetMultipleLineTextField' - $ref: '#/components/schemas/AppFormLayoutGetEditorField' - $ref: '#/components/schemas/AppFormLayoutGetDecimalField' - $ref: '#/components/schemas/AppFormLayoutGetCalcField' - $ref: '#/components/schemas/AppFormLayoutGetMultipleCheckField' - $ref: '#/components/schemas/AppFormLayoutGetSingleCheckField' - $ref: '#/components/schemas/AppFormLayoutGetSingleSelectField' - $ref: '#/components/schemas/AppFormLayoutGetMultipleSelectField' - $ref: '#/components/schemas/AppFormLayoutGetFileField' - $ref: '#/components/schemas/AppFormLayoutGetDateField' - $ref: '#/components/schemas/AppFormLayoutGetDatetimeField' - $ref: '#/components/schemas/AppFormLayoutGetTimeField' - $ref: '#/components/schemas/AppFormLayoutGetUserSelectField' - $ref: '#/components/schemas/AppFormLayoutGetLinkField' - $ref: '#/components/schemas/AppFormLayoutGetLookupField' - $ref: '#/components/schemas/AppFormLayoutGetReferenceTableField' - $ref: '#/components/schemas/AppFormLayoutGetSpacerField' - $ref: '#/components/schemas/AppFormLayoutGetHrField' - $ref: '#/components/schemas/AppFormLayoutGetRecordIdField' - $ref: '#/components/schemas/AppFormLayoutGetCreatorField' - $ref: '#/components/schemas/AppFormLayoutGetCreatedAtField' - $ref: '#/components/schemas/AppFormLayoutGetModifierField' - $ref: '#/components/schemas/AppFormLayoutGetModifiedAtField' type: object type: array type: enum: - ROW - SUBTABLE - GROUP type: string required: - fields - type type: object AppFormLayoutGetSingleCheckField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetSingleLineTextField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetSingleSelectField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetSpacerField: properties: elementId: maxLength: 64 type: string size: properties: width: format: int64 type: integer height: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - type type: object AppFormLayoutGetSubtableRow: properties: code: maxLength: 128 type: string fields: items: anyOf: - $ref: '#/components/schemas/AppFormLayoutGetLabelField' - $ref: '#/components/schemas/AppFormLayoutGetSingleLineTextField' - $ref: '#/components/schemas/AppFormLayoutGetMultipleLineTextField' - $ref: '#/components/schemas/AppFormLayoutGetEditorField' - $ref: '#/components/schemas/AppFormLayoutGetDecimalField' - $ref: '#/components/schemas/AppFormLayoutGetCalcField' - $ref: '#/components/schemas/AppFormLayoutGetMultipleCheckField' - $ref: '#/components/schemas/AppFormLayoutGetSingleCheckField' - $ref: '#/components/schemas/AppFormLayoutGetSingleSelectField' - $ref: '#/components/schemas/AppFormLayoutGetMultipleSelectField' - $ref: '#/components/schemas/AppFormLayoutGetFileField' - $ref: '#/components/schemas/AppFormLayoutGetDateField' - $ref: '#/components/schemas/AppFormLayoutGetDatetimeField' - $ref: '#/components/schemas/AppFormLayoutGetTimeField' - $ref: '#/components/schemas/AppFormLayoutGetUserSelectField' - $ref: '#/components/schemas/AppFormLayoutGetLinkField' - $ref: '#/components/schemas/AppFormLayoutGetLookupField' - $ref: '#/components/schemas/AppFormLayoutGetReferenceTableField' - $ref: '#/components/schemas/AppFormLayoutGetSpacerField' - $ref: '#/components/schemas/AppFormLayoutGetHrField' - $ref: '#/components/schemas/AppFormLayoutGetRecordIdField' - $ref: '#/components/schemas/AppFormLayoutGetCreatorField' - $ref: '#/components/schemas/AppFormLayoutGetCreatedAtField' - $ref: '#/components/schemas/AppFormLayoutGetModifierField' - $ref: '#/components/schemas/AppFormLayoutGetModifiedAtField' type: object type: array type: enum: - ROW - SUBTABLE - GROUP type: string required: - code - fields - type type: object AppFormLayoutGetTimeField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppFormLayoutGetUserSelectField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object AppNotificationsGeneralGetNotification: properties: recordEdited: type: boolean recordAdded: type: boolean statusChanged: type: boolean includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object fileImported: type: boolean commentAdded: type: boolean type: object AppNotificationsPerRecordGetNotification: properties: filterCond: format: query type: string title: type: string targets: items: $ref: '#/components/schemas/AppNotificationsPerRecordGetTarget' type: array type: object AppNotificationsPerRecordGetTarget: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object AppNotificationsReminderGetNotification: properties: timing: anyOf: - $ref: '#/components/schemas/AppNotificationsReminderGetTimingRelative' - $ref: '#/components/schemas/AppNotificationsReminderGetTimingAbsolute' type: object filterCond: format: query type: string title: type: string targets: items: $ref: '#/components/schemas/AppNotificationsReminderGetTarget' type: array type: object AppNotificationsReminderGetTarget: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object AppNotificationsReminderGetTimingAbsolute: properties: code: type: string time: type: string daysLater: format: int64 type: integer type: object AppNotificationsReminderGetTimingRelative: properties: hoursLater: format: int64 type: integer code: type: string daysLater: format: int64 type: integer type: object AppPluginsGetPluginForm: properties: name: type: string id: type: string enabled: type: boolean type: object AppReportsGetFieldAggregation: properties: code: type: string type: enum: - SUM - AVERAGE - MAX - MIN type: string type: object AppReportsGetGroup: properties: code: type: string type: object AppReportsGetGroupDate: properties: code: type: string per: enum: - YEAR - QUARTER - MONTH - WEEK - DAY type: string type: object AppReportsGetGroupDateTime: properties: code: type: string per: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR - MINUTE type: string type: object AppReportsGetGroupTime: properties: code: type: string per: enum: - HOUR - MINUTE type: string type: object AppReportsGetPeriodDay: properties: time: type: string every: enum: - DAY type: string type: object AppReportsGetPeriodHour: properties: every: enum: - HOUR type: string minute: format: int64 type: integer type: object AppReportsGetPeriodMonth: properties: dayOfMonth: type: string time: type: string every: enum: - MONTH type: string type: object AppReportsGetPeriodQuarter: properties: dayOfMonth: type: string pattern: enum: - JAN_APR_JUL_OCT - FEB_MAY_AUG_NOV - MAR_JUN_SEP_DEC type: string time: type: string every: enum: - QUARTER type: string type: object AppReportsGetPeriodWeek: properties: dayOfWeek: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string time: type: string every: enum: - WEEK type: string type: object AppReportsGetPeriodYear: properties: month: format: int64 type: integer dayOfMonth: format: int64 type: integer time: type: string every: enum: - YEAR type: string type: object AppReportsGetRecordAggregation: properties: type: enum: - COUNT type: string type: object AppReportsGetReport: properties: periodicReport: properties: period: anyOf: - $ref: '#/components/schemas/AppReportsGetPeriodYear' - $ref: '#/components/schemas/AppReportsGetPeriodQuarter' - $ref: '#/components/schemas/AppReportsGetPeriodMonth' - $ref: '#/components/schemas/AppReportsGetPeriodWeek' - $ref: '#/components/schemas/AppReportsGetPeriodDay' - $ref: '#/components/schemas/AppReportsGetPeriodHour' type: object active: type: boolean type: object chartType: enum: - PIE - LINE - SPLINE - TABLE - PIVOT_TABLE - BAR - COLUMN - AREA - SPLINE_AREA type: string name: type: string index: format: int64 type: integer groups: items: anyOf: - $ref: '#/components/schemas/AppReportsGetGroup' - $ref: '#/components/schemas/AppReportsGetGroupDateTime' - $ref: '#/components/schemas/AppReportsGetGroupDate' - $ref: '#/components/schemas/AppReportsGetGroupTime' type: object type: array id: format: int64 type: integer filterCond: format: query type: string aggregations: items: anyOf: - $ref: '#/components/schemas/AppReportsGetRecordAggregation' - $ref: '#/components/schemas/AppReportsGetFieldAggregation' type: object type: array sorts: items: $ref: '#/components/schemas/AppReportsGetSort' type: array type: object AppReportsGetReportWithChartMode: properties: periodicReport: properties: period: anyOf: - $ref: '#/components/schemas/AppReportsGetPeriodYear' - $ref: '#/components/schemas/AppReportsGetPeriodQuarter' - $ref: '#/components/schemas/AppReportsGetPeriodMonth' - $ref: '#/components/schemas/AppReportsGetPeriodWeek' - $ref: '#/components/schemas/AppReportsGetPeriodDay' - $ref: '#/components/schemas/AppReportsGetPeriodHour' type: object active: type: boolean type: object chartType: enum: - PIE - LINE - SPLINE - TABLE - PIVOT_TABLE - BAR - COLUMN - AREA - SPLINE_AREA type: string name: type: string index: format: int64 type: integer groups: items: anyOf: - $ref: '#/components/schemas/AppReportsGetGroup' - $ref: '#/components/schemas/AppReportsGetGroupDateTime' - $ref: '#/components/schemas/AppReportsGetGroupDate' - $ref: '#/components/schemas/AppReportsGetGroupTime' type: object type: array id: format: int64 type: integer chartMode: enum: - NORMAL - STACKED - PERCENTAGE type: string filterCond: format: query type: string aggregations: items: anyOf: - $ref: '#/components/schemas/AppReportsGetRecordAggregation' - $ref: '#/components/schemas/AppReportsGetFieldAggregation' type: object type: array sorts: items: $ref: '#/components/schemas/AppReportsGetSort' type: array type: object AppReportsGetSort: properties: by: enum: - TOTAL - GROUP1 - GROUP2 - GROUP3 type: string order: enum: - ASC - DESC type: string type: object AppSettingsGetIconFileForm: properties: file: properties: size: type: string name: type: string fileKey: type: string contentType: type: string required: - fileKey type: object type: enum: - FILE - PRESET type: string required: - file - type type: object AppSettingsGetIconPresetForm: properties: type: enum: - FILE - PRESET type: string key: enum: - APP1 - APP2 - APP3 - APP4 - APP5 - APP6 - APP7 - APP8 - APP9 - APP10 - APP11 - APP12 - APP13 - APP14 - APP15 - APP16 - APP17 - APP18 - APP19 - APP20 - APP21 - APP22 - APP23 - APP24 - APP25 - APP26 - APP27 - APP28 - APP29 - APP30 - APP31 - APP32 - APP33 - APP34 - APP35 - APP36 - APP37 - APP38 - APP39 - APP40 - APP41 - APP42 - APP43 - APP44 - APP45 - APP46 - APP47 - APP48 - APP49 - APP50 - APP51 - APP52 - APP53 - APP54 - APP55 - APP56 - APP57 - APP58 - APP59 - APP60 - APP61 - APP62 - APP63 - APP64 - APP65 - APP66 - APP67 - APP68 - APP69 - APP70 - APP71 - APP72 - APP73 - APP74 - APP75 - APP76 - APP77 - APP78 - APP79 - APP80 - APP81 - APP82 - APP83 - APP84 - APP85 - APP86 - APP87 - APP88 - APP89 - APP90 type: string required: - type - key type: object AppSettingsGetNumberPrecision: properties: roundingMode: enum: - HALF_EVEN - UP - DOWN type: string decimalPlaces: type: string digits: type: string type: object AppSettingsGetTitleField: properties: code: type: string selectionMode: enum: - AUTO - MANUAL type: string required: - selectionMode type: object AppsGetAppWithSpaceIdForm: properties: threadId: type: string nullable: true spaceId: type: string nullable: true createdAt: format: date-time type: string creator: properties: code: type: string name: type: string type: object code: type: string modifiedAt: format: date-time type: string appId: type: string modifier: properties: code: type: string name: type: string type: object name: type: string description: type: string type: object AppsStatisticsGetAppForm: properties: fieldCount: format: int64 type: integer creator: properties: code: type: string name: type: string type: object customized: type: boolean modifiedAt: format: date-time type: string recordCount: format: int64 type: integer modifier: properties: code: type: string name: type: string type: object apiTokenCount: format: int64 type: integer space: properties: name: type: string id: format: int64 type: integer type: object recordUpdatedAt: format: date-time type: string createdAt: format: date-time type: string webhookCount: format: int64 type: integer dailyRequestCount: format: int64 type: integer appGroup: type: string storageUsage: format: int64 type: integer name: type: string id: format: int64 type: integer status: enum: - NOT_ACTIVATED - ACTIVATED - CHANGED type: string type: object AppStatusGetActionForm: properties: name: type: string executableUser: properties: entities: items: $ref: '#/components/schemas/AppStatusGetExecutableUserEntityForm' type: array type: object from: type: string to: type: string filterCond: type: string type: type: string type: object AppStatusGetAssigneeEntityForm: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY - CREATOR - CUSTOM_FIELD type: string type: object type: object AppStatusGetExecutableUserEntityForm: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object AppStatusGetStateForm: properties: name: type: string index: format: int64 type: integer assignee: properties: entities: items: $ref: '#/components/schemas/AppStatusGetAssigneeEntityForm' type: array type: enum: - ONE - ALL - ANY type: string type: object type: object AppViewsGetBuiltinCalendarViewOutputForm: properties: date: type: string name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string title: type: string type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string builtinType: enum: - ASSIGNEE type: string type: object AppViewsGetBuiltinListViewOutputForm: properties: name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string fields: items: type: string type: array type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string builtinType: enum: - ASSIGNEE type: string type: object AppViewsGetCalendarViewOutputForm: properties: date: type: string name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string title: type: string type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string type: object AppViewsGetCustomViewOutputForm: properties: pager: type: boolean name: type: string index: format: int64 type: integer html: type: string id: format: int64 type: integer sort: type: string type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string device: enum: - DESKTOP - ANY type: string type: object AppViewsGetListViewOutputForm: properties: name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string fields: items: type: string type: array type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string type: object BulkRequestPostRecordAssigneesPutForm: properties: app: format: int64 type: integer assignees: items: type: string type: array id: format: int64 type: integer revision: format: int64 type: integer required: - app - assignees - id type: object BulkRequestPostRecordAssigneesPutOutputForm: properties: revision: type: string type: object BulkRequestPostRecordBean: properties: id: format: int64 type: integer revision: type: string type: object BulkRequestPostRecordForm: properties: updateKey: $ref: '#/components/schemas/BulkRequestPostUpdateKey' record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' id: format: int64 type: integer revision: format: int64 type: integer type: object BulkRequestPostRecordPostForm: properties: app: format: int64 type: integer record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' required: - app - record type: object BulkRequestPostRecordPostOutputForm: properties: id: format: int64 type: integer revision: type: string type: object BulkRequestPostRecordPutForm: properties: app: format: int64 type: integer updateKey: $ref: '#/components/schemas/BulkRequestPostUpdateKey' record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' id: format: int64 type: integer revision: format: int64 type: integer required: - app type: object BulkRequestPostRecordPutOutputForm: properties: revision: type: string type: object BulkRequestPostRecordsDeleteForm: properties: app: format: int64 type: integer ids: items: format: int64 type: integer type: array revisions: items: format: int64 type: integer type: array required: - app - ids type: object BulkRequestPostRecordsDeleteOutputForm: {} BulkRequestPostRecordsPostForm: properties: app: format: int64 type: integer records: items: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' type: array required: - app - records type: object BulkRequestPostRecordsPostOutputForm: properties: ids: items: format: int64 type: integer type: array revisions: items: format: int64 type: integer type: array type: object BulkRequestPostRecordsPutForm: properties: app: format: int64 type: integer records: items: $ref: '#/components/schemas/BulkRequestPostRecordForm' type: array upsert: type: boolean required: - app - records type: object BulkRequestPostRecordsPutOutputForm: properties: records: oneOf: - type: array items: $ref: '#/components/schemas/BulkRequestPostRecordBean' - type: array items: $ref: '#/components/schemas/BulkRequestPostUpsertRecordBean' type: object BulkRequestPostRecordsStatusPutForm: properties: app: format: int64 type: integer records: items: $ref: '#/components/schemas/BulkRequestPostRecordsStatusPutFormRecord' type: array required: - app - records type: object BulkRequestPostRecordsStatusPutFormRecord: properties: action: type: string id: format: int64 type: integer assignee: type: string revision: format: int64 type: integer required: - action - id type: object BulkRequestPostRecordsStatusPutOutputForm: properties: records: items: $ref: '#/components/schemas/BulkRequestPostRecordsStatusPutOutputFormRecord' type: array type: object BulkRequestPostRecordsStatusPutOutputFormRecord: properties: id: format: int64 type: integer revision: type: string type: object BulkRequestPostRecordStatusPutForm: properties: app: format: int64 type: integer action: type: string id: format: int64 type: integer assignee: type: string revision: format: int64 type: integer required: - app - action - id type: object BulkRequestPostRecordStatusPutOutputForm: properties: revision: type: string type: object BulkRequestPostRequestForm: properties: method: type: string description: The API method for the request. payload: anyOf: - $ref: '#/components/schemas/BulkRequestPostRecordPostForm' - $ref: '#/components/schemas/BulkRequestPostRecordPutForm' - $ref: '#/components/schemas/BulkRequestPostRecordStatusPutForm' - $ref: '#/components/schemas/BulkRequestPostRecordAssigneesPutForm' - $ref: '#/components/schemas/BulkRequestPostRecordsDeleteForm' - $ref: '#/components/schemas/BulkRequestPostRecordsPostForm' - $ref: '#/components/schemas/BulkRequestPostRecordsPutForm' - $ref: '#/components/schemas/BulkRequestPostRecordsStatusPutForm' type: object description: |- The parameters to be passed onto the API of the request. Contents and formats will change depending on the API. api: type: string description: The path of the API for the request. required: - method - payload - api type: object BulkRequestPostUpdateKey: properties: field: type: string value: maxLength: 64 type: string required: - field - value type: object BulkRequestPostUpsertRecordBean: properties: id: format: int64 type: integer operation: enum: - INSERT - UPDATE type: string revision: type: string type: object CalcSimpleValue: properties: type: type: string enum: - CALC value: type: string type: object required: - type description: Calculated example: type: CALC value: '777888999' CategorySimpleValue: properties: type: type: string enum: - CATEGORY value: items: type: string type: array type: object required: - type description: Categories example: type: CATEGORY value: - category1 - category2 CheckBoxSimpleValue: type: object properties: type: type: string enum: - CHECK_BOX value: type: array items: type: string required: - value - type description: Check box example: type: CHECK_BOX value: - Choice 1 - Choice 2 CreatedTimeSimpleValue: type: object properties: type: type: string enum: - CREATED_TIME value: type: string format: date-time required: - value - type description: Created datetime example: type: CREATED_TIME value: '2015-01-22T15:07:00Z' CreatorSimpleValue: type: object properties: type: type: string enum: - CREATOR value: $ref: '#/components/schemas/UserEntitySimpleValue' required: - value - type description: Created by example: type: CREATOR value: code: john-d name: John Doe DateSimpleValue: properties: type: type: string enum: - DATE value: type: string format: date nullable: true type: object required: - type description: Date example: type: DATE value: '2015-04-15' DatetimeSimpleValue: properties: type: type: string enum: - DATETIME value: type: string format: date-time nullable: true type: object required: - type description: Date and time example: type: DATETIME value: '2015-03-17T10:20:00Z' DecimalSimpleValue: properties: type: type: string enum: - NUMBER value: type: string type: object required: - type description: Number example: type: NUMBER value: '777' EditorSimpleValue: properties: type: type: string enum: - RICH_TEXT value: type: string type: object required: - type description: Rich text FieldAclGetEntityRight: properties: accessibility: enum: - WRITE - READ - NONE type: string includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object FieldAclGetRight: properties: code: type: string entities: items: $ref: '#/components/schemas/FieldAclGetEntityRight' type: array type: object FieldAclPutFieldRightEntity: properties: accessibility: enum: - WRITE - READ - NONE type: string description: |- The permission to grant to the entity. - `READ`: Permissions to view only. - `WRITE`: Permissions to view and edit. - `NONE`: No permissions to view and edit includeSubs: type: boolean description: |- The permission inheritance settings of the department the permissions are granted to. - `true`: Permissions are inherited. - `false`: Permissions are not inherited. If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the permission is granted to. If the `Everyone` group is not specified, the `Everyone` group will have no permissions to view/edit/delete. To specify guest space users, add the string `guest/` before the guest's log in name. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string description: |- The type of the entity the permission is granted to. - `USER`: User - `GROUP`: Group - `ORGANIZATION`: Department - `FIELD_ENTITY`: User field required: - type type: object description: An object containing data of the entity the permission is granted to. required: - accessibility - entity type: object FieldAclPutRight: properties: code: type: string description: The field code of the field to set permissions around. entities: items: $ref: '#/components/schemas/FieldAclPutFieldRightEntity' type: array description: |- An array listing the entities the permissions are granted to. List in order of priority. The `Everyone` group will be treated with the lowest priority, wherever it is placed in the list. required: - code - entities type: object FileSimpleValue: properties: type: type: string enum: - FILE value: items: $ref: '#/components/schemas/SingleFileSimpleValue' type: array required: - value - type type: object description: Attachment example: type: FILE value: - contentType: text/plain fileKey: 20150417022053715283FF97DC413CBC4B7A41C name: kintoneUpdates.txt size: '25302' - contentType: text/plain fileKey: 20150417022159ECFC1223C4B34C939E1B9BD25 name: APIUpdatestxt size: '20311' FormGetBultinProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object FormGetCalcSimpleProperties: properties: noLabel: type: boolean unit: type: string expression: type: string code: type: string format: enum: - NUMBER - NUMBER_DIGIT - DATETIME - DATE - TIME - HOUR_MINUTE - DAY_HOUR_MINUTE type: string unitPosition: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string displayScale: format: int64 type: integer hideExpression: type: boolean required: type: boolean type: object FormGetDateSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string defaultExpression: type: string unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetDatetimeSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string defaultExpression: type: string unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetDecimalSimpleProperties: properties: noLabel: type: boolean code: type: string maxValue: format: int64 type: integer defaultValue: type: string unitPosition: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean minValue: format: int64 type: integer unit: type: string unique: type: boolean displayScale: format: int64 type: integer digit: type: boolean type: object FormGetEditorSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetFileSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetGroupSelectSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetLabelProperties: properties: label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object FormGetLayoutProperties: properties: type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object FormGetLinkSimpleProperties: properties: noLabel: type: boolean protocol: enum: - WEB - CALL - MAIL type: string code: type: string defaultValue: type: string minLength: format: int64 type: integer unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string maxLength: format: int64 type: integer required: type: boolean type: object FormGetLookupSimpleProperties: properties: noLabel: type: boolean code: type: string relatedApp: format: int64 type: integer label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetMultipleLineTextSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetMultipleSelectSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: items: type: string type: array options: items: type: string type: array label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetOrganizationSelectSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetReferenceTableLayoutProperties: properties: noLabel: type: boolean code: type: string relatedApp: format: int64 type: integer label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object FormGetSingleLineTextSimpleProperties: properties: noLabel: type: boolean expression: type: string code: type: string defaultValue: type: string minLength: format: int64 type: integer unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string maxLength: format: int64 type: integer hideExpression: type: boolean required: type: boolean type: object FormGetSingleSelectSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string options: items: type: string type: array label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetSpacerProperties: properties: elementId: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object FormGetSubTableLayoutProperties: properties: noLabel: type: boolean code: type: string label: type: string fields: items: anyOf: - $ref: '#/components/schemas/FormGetLayoutProperties' - $ref: '#/components/schemas/FormGetLabelProperties' - $ref: '#/components/schemas/FormGetBultinProperties' - $ref: '#/components/schemas/FormGetCalcSimpleProperties' - $ref: '#/components/schemas/FormGetDateSimpleProperties' - $ref: '#/components/schemas/FormGetDatetimeSimpleProperties' - $ref: '#/components/schemas/FormGetDecimalSimpleProperties' - $ref: '#/components/schemas/FormGetEditorSimpleProperties' - $ref: '#/components/schemas/FormGetFileSimpleProperties' - $ref: '#/components/schemas/FormGetLinkSimpleProperties' - $ref: '#/components/schemas/FormGetMultipleLineTextSimpleProperties' - $ref: '#/components/schemas/FormGetMultipleSelectSimpleProperties' - $ref: '#/components/schemas/FormGetSingleLineTextSimpleProperties' - $ref: '#/components/schemas/FormGetSingleSelectSimpleProperties' - $ref: '#/components/schemas/FormGetTimeSimpleProperties' - $ref: '#/components/schemas/FormGetUserSelectSimpleProperties' - $ref: '#/components/schemas/FormGetOrganizationSelectSimpleProperties' - $ref: '#/components/schemas/FormGetGroupSelectSimpleProperties' - $ref: '#/components/schemas/FormGetLookupSimpleProperties' - $ref: '#/components/schemas/FormGetReferenceTableLayoutProperties' - $ref: '#/components/schemas/FormGetSubTableLayoutProperties' - $ref: '#/components/schemas/FormGetSpacerProperties' type: object type: array type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object FormGetTimeSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string defaultExpression: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object FormGetUserSelectSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object GroupEntitySimpleValue: properties: code: type: string name: type: string required: - code type: object GroupSelectSimpleValue: properties: type: type: string enum: - GROUP_SELECT value: items: $ref: '#/components/schemas/GroupEntitySimpleValue' type: array required: - value - type type: object description: Group Selection example: type: GROUP_SELECT value: - code: project_manager name: Project Manager - code: team_leader name: Team Leader GuestsPostGuestUserForm: properties: division: maxLength: 100 type: string description: |- The Department name to display on the Guest User's profile. The maximum limit is 100 characters. callto: maxLength: 256 type: string description: |- The Skype Name of the Guest user. The maximum limit is 256 characters. image: type: string description: |- The profile image of the Guest user. Specify a fileKey of an uploaded file. fileKeys can be found from the response of the Upload File API. For more information, refer to the following article: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) If ignored, a default image will be set. password: maxLength: 64 minLength: 3 type: string description: The log in password of the Guest user. code: format: email type: string description: The email address (log in name) of the Guest user. phone: maxLength: 100 type: string description: |- The Phone number to display on the Guest User's profile. The maximum limit is 100 characters. timezone: format: timezone type: string description: The timezone of the Guest user. name: maxLength: 128 minLength: 1 type: string description: |- The display name of the user. Must be between 1 - 128 characters. surNameReading: maxLength: 64 type: string description: The Phonetic Surname settings of the Guest User. The maximum limit is 64 characters. company: maxLength: 100 type: string description: |- The Company name to display on the Guest User's profile. The maximum limit is 100 characters. locale: format: locale type: string givenNameReading: maxLength: 64 type: string description: The Phonetic Given Name settings of the Guest User. The maximum limit is 64 characters. required: - password - code - timezone - name type: object KintoneError: type: object description: Common error response of the Kintone REST API (shared body across all APIs). properties: id: type: string description: Error ID. Provide this when contacting support. code: type: string description: A code that represents the type of error (e.g. CB_IJ01, GAIA_IL26). message: type: string description: Error message. The output language depends on the display-language setting of the user who executed the API. required: - id - code - message LinkSimpleValue: properties: type: type: string enum: - LINK value: type: string type: object required: - type description: Link example: type: LINK value: https://www.kintone.com/ ModifiedAtSimpleValue: properties: type: type: string enum: - UPDATED_TIME value: format: date-time type: string type: object required: - type description: Updated datetime example: type: UPDATED_TIME value: '2015-01-22T15:07:00Z' ModifierSimpleValue: properties: type: type: string enum: - MODIFIER value: properties: code: type: string name: type: string required: - code type: object required: - value - type type: object description: Updated by example: type: MODIFIER value: code: john-d name: John Doe MultipleLineTextSimpleValue: properties: type: type: string enum: - MULTI_LINE_TEXT value: type: string type: object required: - type description: Text area example: type: MULTI_LINE_TEXT value: Hello\nKintone MultipleSelectSimpleValue: properties: type: type: string enum: - MULTI_SELECT value: items: type: string type: array required: - value - type type: object description: Multi-choice example: type: MULTI_SELECT value: - Choice 1 - Choice 2 OrganizationEntitySimpleValue: properties: code: type: string name: type: string required: - code type: object OrganizationSelectSimpleValue: properties: type: type: string enum: - ORGANIZATION_SELECT value: items: $ref: '#/components/schemas/OrganizationEntitySimpleValue' type: array required: - value - type type: object description: Department Selection example: type: ORGANIZATION_SELECT value: - code: human_resources name: Human Resources - code: sales name: Sales PluginAppsGetAppDto: properties: name: type: string id: type: string type: object PluginsGetPluginDto: properties: isMarketPlugin: type: boolean name: type: string description: type: string id: type: string version: type: string type: object PluginsRequiredGetPluginDto: properties: isMarketPlugin: type: boolean name: type: string id: type: string type: object PreviewAppAclGetRight: properties: recordImportable: type: boolean appEditable: type: boolean recordExportable: type: boolean recordAddable: type: boolean recordViewable: type: boolean recordEditable: type: boolean includeSubs: type: boolean recordDeletable: type: boolean entity: properties: code: type: string type: enum: - USER - ORGANIZATION - GROUP - CREATOR type: string type: object type: object PreviewAppAclPutRight: properties: recordImportable: type: boolean description: |- The file import permission of the entity. The record add permissions must also be enabled to set this value as `true`. - `true`: Files will be importable - `false`: Files will not be importable If ignored, this value is false. appEditable: type: boolean description: |- The App management permission of the entity. - The App's settings will be accessible. - The App's settings will not be accessible. If ignored, this value is false. recordExportable: type: boolean description: |- The file export permission of the entity. - `true`: Files will be exportable - `false`: Files will not be exportable If ignored, this value is false. recordAddable: type: boolean description: |- The record add permission of the entity - `true`: Records can be added. - `false`: Records cannot be added. If ignored, this value is false. recordViewable: type: boolean description: |- The record view permission of the entity. - `true`: Records will be viewable. - `false`: Records will not be viewable. If ignored, this value is false. recordEditable: type: boolean description: |- The record edit permission of the entity. The record view permissions must also be enabled to set this value as `true`. - `true`: Records will be editable. - `false`: Records will not be editable. If ignored, this value is false. recordDeletable: type: boolean description: |- The record delete permission of the entity. The record view permissions must also be enabled to set this value as `true`. - `true`: Records will be deletable. - `false`: Records will not be deletable. If ignored, this value is false. includeSubs: type: boolean description: |- The permission inheritance settings of the department the permission is granted to. This parameter is available if "ORGANIZATION" is specified for the **rights[].entity.type** parameter. - `true`: Permissions will be inherited. - `false`: Permissions will not be inherited. If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the permission is granted to. To specify guest space users, add the string "guest/" before the guest's log in name. If the "Everyone" group is not specified, the "Everyone" group will have no permissions to view/edit/delete. If "CREATOR" is specified for the **rights[].entity.type** parameter, ignore this parameter. Otherwise, this parameter is required. type: enum: - USER - ORGANIZATION - GROUP - CREATOR type: string description: |- The type of the entity the permission will be granted to. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department - **CREATOR**: The creator of the App required: - type type: object description: An object containing data of the entity the permission is granted to. required: - entity type: object PreviewAppActionsGetAction: properties: mappings: items: anyOf: - $ref: '#/components/schemas/PreviewAppActionsGetUrlMapping' - $ref: '#/components/schemas/PreviewAppActionsGetFieldMapping' type: object type: array entities: items: $ref: '#/components/schemas/PreviewAppActionsGetEntity' type: array name: type: string index: format: int64 type: integer id: format: int64 type: integer filterCond: type: string destApp: properties: app: format: int64 type: integer code: type: string type: object type: object PreviewAppActionsGetEntity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION type: string type: object PreviewAppActionsGetFieldMapping: properties: destField: type: string srcType: enum: - FIELD type: string srcField: type: string type: object PreviewAppActionsGetUrlMapping: properties: destField: type: string srcType: enum: - RECORD_URL type: string type: object PreviewAppActionsPutAction: properties: mappings: items: anyOf: - $ref: '#/components/schemas/PreviewAppActionsPutFieldMapping' - $ref: '#/components/schemas/PreviewAppActionsPutUrlMapping' type: object type: array description: |- An array of objects containing the **Field Mappings** options. If the array is empty, the `Action` will not have **Field Mappings** options set. Required when specifying the `actions.{actionname}.destApp` parameter, or creating a new `Action`. entities: items: $ref: '#/components/schemas/PreviewAppActionsPutEntity' type: array description: |- An array of objects containing the entities the `Action` is granted to. This reflects the **Available To** options. If the array is empty, the `Action` will not be available to any users/departments/groups. Required when creating a new `Action`. name: maxLength: 32 minLength: 1 type: string description: |- The name of the `Action`. 1 to 32 characters can be specified. When creating a new `Action`, the request will fail if this parameter's value is not the same as `actions.{actionname}`. Required when updating an existing `Action`, or creating a new `Action`. index: format: int64 type: integer description: |- The order of the `Actions`. The `Action` is sorted in ascending order, starting from 0. The request will fail if there are duplicate values. Required when updating an existing `Action`, or creating a new `Action`. filterCond: type: string description: |- The query string that App Action can be used. If ignored, the condition will not be changed. If an empty string is specified when creating or updating the `Action`, the condition will be set as `All records`. For more information on query string, refer to the following article: [Query string](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) destApp: properties: app: format: int64 type: integer description: |- The App ID of the copy destination App. Required if the `actions.{actionname}.destApp.code` is not specified. code: type: string description: |- The App Code of the copy destination App. Required if the `actions.{actionname}.destApp.app` is not specified. If both `actions.{actionname}.destApp.app` and `actions.{actionname}.destApp.code` are specified, code takes precedence. type: object description: |- An object containing the Target option that specifies the destination App where data is to be copied. Required when creating a new `Action`. required: - index type: object description: |- An object listing `Action` information of 1 `Action`. If _actionname_ is equal to the name of an existing `Action`, the `Action` will be updated with the values in the object. If _actionname_ is not equal to a name of an existing `Action`, a new `Action` will be created with the values in the object. Any existing `Action` that is not set for this parameter will be deleted. PreviewAppActionsPutActionResult: properties: id: format: int64 type: integer type: object PreviewAppActionsPutEntity: properties: code: type: string description: |- The code of the entity the `Action` is granted to. For guest users, add `guest/` before the login name. Required when specifying the `actions.{actionname}.entities` parameter. type: enum: - USER - GROUP - ORGANIZATION type: string description: |- The type of the entity the `Action` is granted to. - `USER`: User - `GROUP`: Group - `ORGANIZATION`: Department For Apps in a guest space, specifying a Department will result in an error. Required when specifying the `actions.{actionname}.entities` parameter. required: - code - type type: object PreviewAppActionsPutFieldMapping: properties: destField: type: string description: |- The field code of the field specified in the **Field Mappings** options as the destination. Required when specifying the `actions.{actionname}.mappings` parameter. srcType: enum: - FIELD type: string description: |- The type of source data that is to be copied. - `FIELD`: Data stored in the source App's field - `RECORD_URL`: The Record's permalink Required when specifying the `actions.{actionname}.mappings` parameter. srcField: type: string description: |- The field code of the field specified in the **Field Mappings** options as the source. Required when the `actions.{actionname}.mappings[].srcType` is set to `FIELD`. required: - destField - srcType - srcField type: object PreviewAppActionsPutUrlMapping: properties: destField: type: string description: |- The field code of the field specified in the **Field Mappings** options as the destination. Required when specifying the `actions.{actionname}.mappings` parameter. srcType: enum: - RECORD_URL type: string description: |- The type of source data that is to be copied. - `FIELD`: Data stored in the source App's field - `RECORD_URL`: The Record's permalink Required when specifying the `actions.{actionname}.mappings` parameter. required: - destField - srcType type: object PreviewAppCustomizeGetFileContentForm: properties: file: properties: size: type: string name: type: string fileKey: type: string contentType: type: string required: - fileKey type: object type: enum: - URL - FILE type: string required: - file - type type: object PreviewAppCustomizeGetUrlContentForm: properties: type: enum: - URL - FILE type: string url: type: string required: - type - url type: object PreviewAppCustomizePutFileContentForm: properties: file: properties: size: type: string name: type: string fileKey: type: string description: |- The fileKey of the CSS file. To attach a file, specify the fileKey that is responded when using the following API: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) To keep the current CSS files that are attached to the App, specify the fileKeys that are responded when using the following API: [Get Customization](https://kintone.dev/en/docs/kintone/rest-api/apps/settings/get-customization/) contentType: type: string required: - fileKey type: object description: |- An Object containing data of CSS file uploads. Specify, if `FILE` is selected for `desktop.css[].type` . Along with `desktop.css[].url`, up to 30 may be specified. type: enum: - URL - FILE type: string description: |- The endpoint type of the CSS file: - `URL`: the CSS file is specified with a URL. - `FILE`: the CSS file is uploaded to the App. required: - file - type type: object PreviewAppCustomizePutUrlContentForm: properties: type: enum: - URL - FILE type: string description: |- The endpoint type of the CSS file: - `URL`: the CSS file is specified with a URL. - `FILE`: the CSS file is uploaded to the App. url: type: string description: |- The URL of the CSS file. Specify, if `URL` is selected for `desktop.css[].type` . Along with `desktop.css[].file`, up to 30 may be specified. required: - type - url type: object PreviewAppDeployGetAppForm: properties: app: format: int64 type: integer status: enum: - PROCESSING - SUCCESS - FAIL - CANCEL type: string type: object PreviewAppDeployPostAppForm: properties: app: format: int64 type: integer description: The App ID. revision: format: int64 type: integer description: |- Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - app type: object PreviewAppFormFieldsGetCalcFieldForm: properties: noLabel: format: boolean type: boolean unit: maxLength: 128 type: string expression: type: string code: maxLength: 128 minLength: 1 type: string format: enum: - NUMBER - NUMBER_DIGIT - DATETIME - DATE - TIME - HOUR_MINUTE - DAY_HOUR_MINUTE type: string unitPosition: enum: - BEFORE - AFTER type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string displayScale: format: int64 type: integer hideExpression: format: boolean type: boolean required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetCategoryFieldForm: properties: code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string enabled: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetDateFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string unique: format: boolean type: boolean defaultNowValue: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetDatetimeFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string unique: format: boolean type: boolean defaultNowValue: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetDecimalFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string maxValue: format: int64 type: integer defaultValue: maxLength: 1000 type: string unitPosition: enum: - BEFORE - AFTER type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean minValue: format: int64 type: integer unit: maxLength: 128 type: string unique: format: boolean type: boolean displayScale: format: int64 type: integer digit: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetEditorFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetEntityForm: properties: code: type: string type: enum: - USER - ORGANIZATION - GROUP - FUNCTION type: string required: - code - type type: object PreviewAppFormFieldsGetFieldMappingForm: properties: relatedField: type: string field: type: string type: object PreviewAppFormFieldsGetFileFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string thumbnailSize: format: int64 type: integer label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetGroupFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string openGroup: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetGroupSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsGetEntityForm' type: array defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsGetEntityForm' type: array label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetLinkFieldForm: properties: noLabel: format: boolean type: boolean protocol: enum: - WEB - CALL - MAIL type: string code: maxLength: 128 minLength: 1 type: string defaultValue: type: string minLength: format: int64 type: integer unique: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string maxLength: format: int64 type: integer required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetLookupFieldForm: properties: noLabel: format: boolean type: boolean lookup: properties: lookupPickerFields: items: type: string type: array relatedKeyField: type: string relatedApp: properties: app: format: int64 type: integer code: type: string type: object fieldMappings: items: $ref: '#/components/schemas/PreviewAppFormFieldsGetFieldMappingForm' type: array sort: type: string filterCond: type: string type: object code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetModifiedAtFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object PreviewAppFormFieldsGetModifierFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object PreviewAppFormFieldsGetMultipleCheckFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: items: type: string type: array options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string align: enum: - HORIZONTAL - VERTICAL type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetMultipleLineTextFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetMultipleSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: items: type: string type: array options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetOptionForm: properties: index: format: int64 type: integer label: maxLength: 128 minLength: 1 type: string required: - index type: object PreviewAppFormFieldsGetOrganizationSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsGetEntityForm' type: array defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsGetEntityForm' type: array label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetRecordIdFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object PreviewAppFormFieldsGetReferenceTableFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string referenceTable: properties: condition: properties: relatedField: type: string field: type: string type: object size: format: int64 type: integer relatedApp: properties: app: format: int64 type: integer code: type: string type: object sort: type: string filterCond: type: string displayFields: items: type: string type: array type: object required: - type type: object PreviewAppFormFieldsGetSingleCheckFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: maxLength: 128 minLength: 1 type: string options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string align: enum: - HORIZONTAL - VERTICAL type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetSingleLineTextFieldForm: properties: noLabel: format: boolean type: boolean expression: type: string code: maxLength: 128 minLength: 1 type: string defaultValue: type: string minLength: format: int64 type: integer unique: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string maxLength: format: int64 type: integer hideExpression: format: boolean type: boolean required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetSingleSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: maxLength: 128 type: string options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsGetOptionForm' label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetStatusAssigneeFieldForm: properties: code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string enabled: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetStatusFieldForm: properties: code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string enabled: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetTableForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string label: maxLength: 128 minLength: 1 type: string fields: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsGetCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsGetUserSelectFieldForm' type: object type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: - type type: object PreviewAppFormFieldsGetTimeFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string defaultValue: type: string defaultNowValue: format: boolean type: boolean label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsGetUserSelectFieldForm: properties: noLabel: format: boolean type: boolean code: maxLength: 128 minLength: 1 type: string entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsGetEntityForm' type: array defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsGetEntityForm' type: array label: maxLength: 128 minLength: 1 type: string type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string required: format: boolean type: boolean required: - type type: object PreviewAppFormFieldsPostCalcFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. unit: maxLength: 128 type: string description: The Currency settings of the field. expression: type: string description: |- The formula expression used in the field. Required in the Calculated field. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code format: enum: - NUMBER - NUMBER_DIGIT - DATETIME - DATE - TIME - HOUR_MINUTE - DAY_HOUR_MINUTE type: string description: |- The display format for fields with calculations: - `NUMBER`: Number (e.g.: 1000) - `NUMBER_DIGIT`: Number with thousands separator (e.g.: 1,000) - `DATETIME`: Date & time (e.g.: Aug 06, 2012 2:03 PM) - `DATE`: Date (e.g.: Aug 06, 2012) - `TIME`: Time (e.g.: 2:03 PM) - `HOUR_MINUTE`: Hours & minutes (e.g.: 29 hours 47 minutes) - `DAY_HOUR_MINUTE`: Days & hours & minutes (e.g.: 1 day 5 hours 47 minutes) If ignored, `NUMBER` will be set. unitPosition: enum: - BEFORE - AFTER type: string description: |- The display position of the Currency. - `BEFORE`: The currency will be displayed before the field value. - `AFTER`: The currency will be displayed after the field value. If ignored, `BEFORE` will be set. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. displayScale: format: int64 type: integer description: The number of decimal places to display for the field. hideExpression: type: boolean description: |- The **Hide formula** settings for the field. - `true`: The formula will be hidden. - `false`: The formula will be displayed. If ignored, `false` will be set. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostCategoryFieldForm: properties: code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. enabled: type: boolean required: - type type: object PreviewAppFormFieldsPostDateFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. If ignored, `false` will be set. defaultNowValue: type: boolean description: |- The **Default to the record creation date** option. - `true`: The record creation date will be used as the default value. - `false`: The record creation date will not be used as the default value. If ignored, `false` will be set. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostDatetimeFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. If ignored, `false` will be set. defaultNowValue: type: boolean description: |- The **Default to the record creation date** option. - `true`: The record creation date will be used as the default value. - `false`: The record creation date will not be used as the default value. If ignored, `false` will be set. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostDecimalFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code maxValue: format: int64 type: integer description: The maximum number of characters for the field. defaultValue: maxLength: 1000 type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. unitPosition: enum: - BEFORE - AFTER type: string description: |- The display position of the Currency. - `BEFORE`: The currency will be displayed before the field value. - `AFTER`: The currency will be displayed after the field value. If ignored, `BEFORE` will be set. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. minValue: format: int64 type: integer description: The minimum number of characters for the field. unit: maxLength: 128 type: string description: The Currency settings of the field. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. If ignored, `false` will be set. displayScale: format: int64 type: integer description: The number of decimal places to display for the field. digit: type: boolean description: |- The **Use thousands separators** option. - `true`: Thousands separators will be displayed for the number. - `false`: Thousands separators will not be displayed for the number. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostEditorFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostEntityForm: properties: code: type: string description: |- The code for the default value of User selection, Group selection, or Department selection field. Required if setting the `defaultValue` parameter. - For User selection field, one of the following values can be specified: - User code (log-in name) - Group code - Department code - Function name `LOGINUSER()` Departments cannot be specified for Apps in Guest spaces. - For Group selection field, a Group code can be specified. - For Department selection field, one of the following values can be specified: - Department code - Function name `PRIMARY_ORGANIZATION()` Deleted or inactive User/Group/Department cannot be specified. type: enum: - USER - ORGANIZATION - GROUP - FUNCTION type: string description: |- The type of the default value of the User selection, Group selection, or Department selection field. Required if setting the `defaultValue` parameter. - `USER`: User - `GROUP`: Group - `ORGANIZATION`: Department - `FUNCTION`: Function required: - code - type type: object PreviewAppFormFieldsPostFieldMappingForm: properties: relatedField: type: string description: |- The field code of the field set for the mapping source. Required if setting the `lookup.fieldMappings[]` parameter. field: type: string description: |- The field code of the field set for the mapping endpoint. Required if setting the `lookup.fieldMappings[]` parameter. type: object PreviewAppFormFieldsPostFileFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code thumbnailSize: format: int64 type: integer description: |- The size of the image thumbnail in pixels. Specify one of the following: - `50` - `150` - `250` - `500` label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostGroupFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. openGroup: type: boolean description: |- The **Show fields in this group** option. - `true`: The Group field will be displayed open by default. - `false`: The Group field will be displayed closed by default. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostGroupSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsPostEntityForm' type: array description: An array listing the preset users for the User selection, Group selection, and Department selection field. defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsPostEntityForm' type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostLinkFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. protocol: enum: - WEB - CALL - MAIL type: string description: |- The Link type settings for the field. Required in the Link field. - `WEB`: URL - `CALL`: Telephone number - `MAIL`: E-mail address code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. minLength: format: int64 type: integer description: The minimum number of digits for the field. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. If ignored, `false` will be set. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. maxLength: format: int64 type: integer description: The maximum number of digits for the field. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostLookupFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. lookup: properties: lookupPickerFields: items: type: string type: array description: A list of field codes of fields set for the **Fields Shown in Lookup Picker** setting. relatedKeyField: type: string description: |- The field code of the **Lookup** field. Required if setting the `lookup` parameter. relatedApp: properties: app: format: int64 type: integer description: |- The App ID of the related App of the **Lookup** field. Either this parameter or the `lookup.relatedApp.code` parameter is required if setting the `lookup` parameter. If both parameters are set, the `lookup.relatedApp.code` parameter takes priority. code: type: string description: The App Code of the related App of the **Lookup** field. Either this parameter or the `lookup.relatedApp.app` parameter is required if setting the `lookup` parameter. If both parameters are set, this parameter takes priority. type: object description: |- An object containing the settings of the related App of the **Lookup** field. Required if setting the `lookup` parameter. fieldMappings: items: $ref: '#/components/schemas/PreviewAppFormFieldsPostFieldMappingForm' type: array description: A list of data set for the **Field Mappings** setting. sort: type: string description: |- The default sort order for the **Filter** setting. Specify in query format. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) filterCond: type: string description: |- The default filter query for the **Filter** setting. Specify in query format. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) [Additional Restrictions for Each API](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#additional-restrictions-for-each-api) type: object description: |- An object containing the settings of the **Lookup** field. Required if adding a Lookup field. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostModifiedAtFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPostModifierFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPostMultipleCheckFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: items: type: string type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPostOptionForm' description: |- An object including data of the field's options. Required for fields that allow selections, such as Radio button. label: maxLength: 128 minLength: 1 type: string description: The field name. align: enum: - HORIZONTAL - VERTICAL type: string description: |- The layout of the options. - `HORIZONTAL`: The options will be listed horizontally. - `VERTICAL`: The options will be listed vertically. If ignored, `HORIZONTAL` will be set. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostMultipleLineTextFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostMultipleSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: items: type: string type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPostOptionForm' description: |- An object including data of the field's options. Required for fields that allow selections, such as Radio button. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostOptionForm: properties: index: format: int64 type: integer description: |- The display order (ascending) of the option, when listed with the other options. Required if setting the `properties.{fieldcode}.options` parameter. label: maxLength: 128 minLength: 1 type: string description: |- The display name of the option. Specify the same value as `{optionname}`. Required if setting the `properties.{fieldcode}.options` parameter. required: - index type: object description: |- An object with data of the settings of the options. Specify the current option names for this parameter. Options that are not specified will be deleted. Required if setting the `properties.{fieldcode}.options` parameter. If a new option is specified for this parameter, it will be treated as a new option. PreviewAppFormFieldsPostOrganizationSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsPostEntityForm' type: array description: An array listing the preset users for the User selection, Group selection, and Department selection field. defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsPostEntityForm' type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostRecordIdFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPostReferenceTableFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. referenceTable: properties: condition: properties: relatedField: type: string description: |- The field code of the field selected for **Field in datasource app**. Required if setting the `referenceTable` parameter. field: type: string description: |- The field code of the field selected for **Field in this app**. Required if setting the `referenceTable` parameter. type: object description: |- An object containing data of the **Fetch Criteria** setting. Required if setting the `referenceTable` parameter. size: format: int64 type: integer description: |- The **Max Records to Display at a Time** setting. Specify one of the following: - `1` - `3` - `5` - `10` - `20` - `30` - `40` - `50` If ignored, `5` will be set. relatedApp: properties: app: format: int64 type: integer description: |- The App ID of the **Datasource App**. If the `relatedApp` parameter is specified, either this parameter or `properties.{fieldcode}.referenceTable.relatedApp.code` will be required. If both parameters are set, `properties.{fieldcode}.referenceTable.relatedApp.code` will take priority. code: type: string description: |- The App Code of the **Datasource App**. If the `relatedApp` parameter is specified, either this parameter or `properties.{fieldcode}.referenceTable.relatedApp.app` will be required. If both parameters are set, `properties.{fieldcode}.referenceTable.relatedApp.code` will take priority. type: object description: |- An object containing data of the **Datasource App** setting. If this parameter is specified, all settings for this Related Records field except for the **Datasource App** setting will return to the default settings. Required if setting the `referenceTable` parameter. sort: type: string description: |- The **Display Order** setting, in a query format. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) filterCond: type: string description: |- The **Filter** setting, in a query format. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) [Additional Restrictions for Each API](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#additional-restrictions-for-each-api) displayFields: items: type: string type: array description: |- A list of field codes of fields specified in the **Datasource App Fields to Display** setting. Required if setting the `referenceTable` parameter. type: object description: |- An object containing the settings of the Related Records field. Required when adding a Related Records field. required: - type type: object PreviewAppFormFieldsPostSingleCheckFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: maxLength: 128 minLength: 1 type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPostOptionForm' description: |- An object including data of the field's options. Required for fields that allow selections, such as Radio button. label: maxLength: 128 minLength: 1 type: string description: The field name. align: enum: - HORIZONTAL - VERTICAL type: string description: |- The layout of the options. - `HORIZONTAL`: The options will be listed horizontally. - `VERTICAL`: The options will be listed vertically. If ignored, `HORIZONTAL` will be set. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostSingleLineTextFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. expression: type: string description: |- The formula expression used in the field. Required in the Calculated field. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. minLength: format: int64 type: integer description: The minimum number of digits for the field. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. If ignored, `false` will be set. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. maxLength: format: int64 type: integer description: The maximum number of digits for the field. hideExpression: type: boolean description: |- The **Hide formula** settings for the field. - `true`: The formula will be hidden. - `false`: The formula will be displayed. If ignored, `false` will be set. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostSingleSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: maxLength: 128 type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPostOptionForm' description: |- An object including data of the field's options. Required for fields that allow selections, such as Radio button. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostStatusAssigneeFieldForm: properties: code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. enabled: type: boolean required: - type type: object PreviewAppFormFieldsPostStatusFieldForm: properties: code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. enabled: type: boolean required: - type type: object PreviewAppFormFieldsPostTableForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code label: maxLength: 128 minLength: 1 type: string description: The field name. fields: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsPostCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPostUserSelectFieldForm' type: object description: |- An object containing data of fields in a table. The parameters of this object are the same as the `properties` parameter. Required when adding a table. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPostTimeFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. defaultNowValue: type: boolean description: |- The **Default to the record creation date** option. - `true`: The record creation date will be used as the default value. - `false`: The record creation date will not be used as the default value. If ignored, `false` will be set. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPostUserSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. If ignored, `false` will be set. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128 - Duplicate field codes cannot exist - _ is the only symbol that can be used - Numbers cannot be used to start a field code entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsPostEntityForm' type: array description: An array listing the preset users for the User selection, Group selection, and Department selection field. defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsPostEntityForm' type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it is also specified. For the User selection, Group selection, and Department selection fields, an array of objects that include `code` and `type` is required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. If ignored, `false` will be set. required: - type type: object PreviewAppFormFieldsPutCalcFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. unit: maxLength: 128 type: string description: The Currency settings of the field. expression: type: string description: The formula expression used in the field. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. format: enum: - NUMBER - NUMBER_DIGIT - DATETIME - DATE - TIME - HOUR_MINUTE - DAY_HOUR_MINUTE type: string description: |- The display format for fields with calculations: - `NUMBER`: Number (1000) - `NUMBER_DIGIT`: Number with thousands separator (1,000) - `DATETIME`: Date & time (Aug 06, 2012 2:03 PM) - `DATE`: Date (Aug 06, 2012) - `TIME`: Time (2:03 PM) - `HOUR_MINUTE`: Hours & minutes (29 hours 47 minutes) - `DAY_HOUR_MINUTE`: Days & hours & minutes (1 day 5 hours 47 minutes) unitPosition: enum: - BEFORE - AFTER type: string description: |- The display position of the Currency. - `BEFORE`: The currency will be displayed before the field value. - `AFTER`: The currency will be displayed after the field value. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. displayScale: format: int64 type: integer description: The number of decimal places to display for the field. hideExpression: type: boolean description: |- The **Hide formula** settings for the field. - `true`: The formula will be hidden. - `false`: The formula will be displayed. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutCategoryFieldForm: properties: code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. enabled: type: boolean required: - type type: object PreviewAppFormFieldsPutDateFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. defaultNowValue: type: boolean description: |- The **Default to the record creation date** option. - `true`: The record creation date will be used as the default value. - `false`: The record creation date will not be used as the default value. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutDatetimeFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. defaultNowValue: type: boolean description: |- The **Default to the record creation date** option. - `true`: The record creation date will be used as the default value. - `false`: The record creation date will not be used as the default value. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutDecimalFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. maxValue: format: int64 type: integer description: The maximum number of characters for the field. defaultValue: maxLength: 1000 type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. unitPosition: enum: - BEFORE - AFTER type: string description: |- The display position of the Currency. - `BEFORE`: The currency will be displayed before the field value. - `AFTER`: The currency will be displayed after the field value. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. minValue: format: int64 type: integer description: The minimum number of characters for the field. unit: maxLength: 128 type: string description: The Currency settings of the field. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. displayScale: format: int64 type: integer description: The number of decimal places to display for the field. digit: type: boolean description: |- The **Use thousands separators** option. - `true`: Thousands separators will be displayed for the number. - `false`: Thousands separators will not be displayed for the number. required: - type type: object PreviewAppFormFieldsPutEditorFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutEntityForm: properties: code: type: string description: |- The code of the default value for User/Group/Department selection fields. Required, if setting the `defaultValue` parameter. - For User selection fields, specify one of: - User login name - Group code - Department code - Function name (`LOGINUSER()` only) For Apps in Guest Spaces, only User, Group, and Function can be specified. - For Group selection fields, specify the Group code. - For Department selection fields, specify one of: - Department code - Function name (`PRIMARY_ORGANIZATION()` only) Deleted or disabled Users/Groups/Departments cannot be specified. type: enum: - USER - ORGANIZATION - GROUP - FUNCTION type: string description: |- The type of the default value for User/Group/Department selection fields. Required, if setting the `defaultValue` parameter. - `USER`: User - `GROUP`: Group - `ORGANIZATION`: Department - `FUNCTION`: Function required: - code - type type: object PreviewAppFormFieldsPutFieldMappingForm: properties: relatedField: type: string description: |- The field code of the field set for the mapping source. Required, if setting the `lookup` parameter. field: type: string description: The field code of the field set for the mapping endpoint. Required, if setting the `lookup` parameter. type: object PreviewAppFormFieldsPutFileFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. thumbnailSize: format: int64 type: integer description: |- The size of the image thumbnail in pixels. Specify one of the following: 50, 150, 250, 500 label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutGroupFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. openGroup: type: boolean description: |- The **Show fields in this group** option. - `true`: The Group field will be displayed open by default. - `false`: The Group field will be displayed closed by default. required: - type type: object PreviewAppFormFieldsPutGroupSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsPutEntityForm' type: array description: An array listing the preset users for the field. defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsPutEntityForm' type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutLinkFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. protocol: enum: - WEB - CALL - MAIL type: string description: |- The Link type settings for the field. - `WEB`: URL - `CALL`: Telephone number - `MAIL`: E-mail address code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. minLength: format: int64 type: integer description: The minimum number of digits for the field. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. maxLength: format: int64 type: integer description: The maximum number of digits for the field. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutLookupFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. lookup: properties: lookupPickerFields: items: type: string type: array description: A list of field codes of fields set for the **Fields Shown in Lookup Picker** setting. relatedKeyField: type: string relatedApp: properties: app: format: int64 type: integer code: type: string type: object fieldMappings: items: $ref: '#/components/schemas/PreviewAppFormFieldsPutFieldMappingForm' type: array description: A list of data set for the **Field Mappings** setting. sort: type: string description: |- The default sort order for the **Filter** setting. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) filterCond: type: string description: |- The default filter query for the **Filter** setting. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) [Additional Restrictions for Each API](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#additional-restrictions-for-each-api) type: object description: An object containing the settings of the Lookup field. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutModifiedAtFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPutModifierFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPutMultipleCheckFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: items: type: string type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPutOptionForm' description: An object including data of the field's options. label: maxLength: 128 minLength: 1 type: string description: The field name. align: enum: - HORIZONTAL - VERTICAL type: string description: |- The layout of the options. - `HORIZONTAL`: The options will be listed horizontally. - `VERTICAL`: The options will be listed vertically. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutMultipleLineTextFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutMultipleSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: items: type: string type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPutOptionForm' description: An object including data of the field's options. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutOptionForm: properties: index: format: int64 type: integer description: |- The display order (ascending) of the option, when listed with the other options. Required, if setting the `properties.{fieldcode}.options` parameter. label: maxLength: 128 minLength: 1 type: string description: |- The display name of the option. If a new option is specified for `properties.{fieldcode}.options.{optionname}`, specify the same value for this parameter. required: - index type: object description: |- An object with data of the settings of the options. Specify the current option names for this parameter. Options that are not specified will be deleted. If a new option is specified for this parameter, it will be treated as a new option. PreviewAppFormFieldsPutOrganizationSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsPutEntityForm' type: array description: An array listing the preset users for the field. defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsPutEntityForm' type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutRecordIdFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPutReferenceTableFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. referenceTable: properties: condition: properties: relatedField: type: string description: The field code of the field selected for **Field in datasource app**. field: type: string description: The field code of the field selected for **Field in this app**. type: object description: An object containing data of the **Fetch Criteria** setting. size: format: int64 type: integer description: |- The **Max Records to Display at a Time** setting. Specify one of the following: 1, 3, 5, 10, 20, 30, 40, 50 relatedApp: properties: app: format: int64 type: integer description: |- The App ID of the Datasource App. If the `relatedApp` parameter is specified, either this parameter or `properties.{fieldcode}.referenceTable.relatedApp.code` will be required. If both parameters are set, `properties.{fieldcode}.referenceTable.relatedApp.code` will take priority. code: type: string description: |- The App Code of the Datasource App. If the `relatedApp` parameter is specified, either this parameter or `properties.{fieldcode}.referenceTable.relatedApp.app` will be required. If both parameters are set, `properties.{fieldcode}.referenceTable.relatedApp.code` will take priority. type: object description: |- An object containing data of the **Datasource App** setting. If this parameter is specified, all settings for this Related Records field except for the **Datasource App** setting will return to the default settings. sort: type: string description: |- The **Display Order** setting, in a query format. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) filterCond: type: string description: |- The **Filter** setting, in a query format. For more data on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) [Additional Restrictions for Each API](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#additional-restrictions-for-each-api) displayFields: items: type: string type: array description: A list of field codes of fields specified in the **Datasource App Fields to Display** setting. type: object description: An object containing the settings of the Related Records field. required: - type type: object PreviewAppFormFieldsPutSingleCheckFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: maxLength: 128 minLength: 1 type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPutOptionForm' description: An object including data of the field's options. label: maxLength: 128 minLength: 1 type: string description: The field name. align: enum: - HORIZONTAL - VERTICAL type: string description: |- The layout of the options. - `HORIZONTAL`: The options will be listed horizontally. - `VERTICAL`: The options will be listed vertically. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutSingleLineTextFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. expression: type: string description: The formula expression used in the field. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. minLength: format: int64 type: integer description: The minimum number of digits for the field. unique: type: boolean description: |- The **Prohibit duplicate values** option. - `true`: Duplicate values will be prohibited. - `false`: Duplicate values will not be prohibited. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. maxLength: format: int64 type: integer description: The maximum number of digits for the field. hideExpression: type: boolean description: |- The **Hide formula** settings for the field. - `true`: The formula will be hidden. - `false`: The formula will be displayed. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutSingleSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: maxLength: 128 type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. options: type: object additionalProperties: $ref: '#/components/schemas/PreviewAppFormFieldsPutOptionForm' description: An object including data of the field's options. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutStatusAssigneeFieldForm: properties: code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. enabled: type: boolean required: - type type: object PreviewAppFormFieldsPutStatusFieldForm: properties: code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. enabled: type: boolean required: - type type: object PreviewAppFormFieldsPutTableForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. label: maxLength: 128 minLength: 1 type: string description: The field name. fields: type: object additionalProperties: anyOf: - $ref: '#/components/schemas/PreviewAppFormFieldsPutCalcFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutCategoryFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDateFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDatetimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutDecimalFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutEditorFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutFileFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutGroupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutGroupSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutLinkFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutLookupFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutModifiedAtFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutModifierFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutMultipleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutOrganizationSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutRecordIdFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutReferenceTableFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleCheckFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleLineTextFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutSingleSelectFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutStatusAssigneeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutStatusFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutTableForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutTimeFieldForm' - $ref: '#/components/schemas/PreviewAppFormFieldsPutUserSelectFieldForm' type: object description: |- An object containing data of fields in a table. The parameters of this object are the same as the properties parameter. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormFieldsPutTimeFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. defaultValue: type: string description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. defaultNowValue: type: boolean description: |- The **Default to the record creation date** option. - `true`: The record creation date will be used as the default value. - `false`: The record creation date will not be used as the default value. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormFieldsPutUserSelectFieldForm: properties: noLabel: type: boolean description: |- The **Hide field name** option. - `true`: The field's name will be hidden. - `false`: The field's name will be displayed. code: maxLength: 128 minLength: 1 type: string description: |- The field code of the field. Field codes have the following limitations: - The maximum character limit is 128. - Duplicate field codes cannot exist. - `_` is the only symbol that can be used. - Numbers cannot be used to start a field code. entities: items: $ref: '#/components/schemas/PreviewAppFormFieldsPutEntityForm' type: array description: An array listing the preset users for the field. defaultValue: items: $ref: '#/components/schemas/PreviewAppFormFieldsPutEntityForm' type: array description: |- The default value. For fields that can set multiple default values, specify the value as an array. The `defaultNowValue` will take priority if it also specified. For User/Group/Department fields, an array of objects that include `code` and `type` are required. label: maxLength: 128 minLength: 1 type: string description: The field name. type: enum: - CALC - CATEGORY - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - GROUP - GROUP_SELECT - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - ORGANIZATION_SELECT - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - STATUS - STATUS_ASSIGNEE - SUBTABLE - TIME - UPDATED_TIME - USER_SELECT type: string description: |- The field type. - `GROUP`: Group - `GROUP_SELECT`: Group selection - `CALC`: Calculated - `CHECK_BOX`: Check box - `CREATED_TIME`: Created datetime - `CREATOR`: Created by - `DATE`: Date - `DATETIME`: Date and time - `DROP_DOWN`: Drop-down - `FILE`: Attachment - `LINK`: Link - `MODIFIER`: Updated by - `MULTI_LINE_TEXT`: Text Area - `MULTI_SELECT`: Multi-choice - `NUMBER`: Number - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SUBTABLE`: Table - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: type: boolean description: |- The **Required field** option. - `true`: The field will be a required field. - `false`: The field will not be a required field. required: - type type: object PreviewAppFormLayoutGetCalcField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetCreatedAtField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetCreatorField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetDateField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetDatetimeField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetDecimalField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetEditorField: properties: code: maxLength: 128 type: string size: properties: innerHeight: format: int64 type: integer width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetFileField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetGroupRow: properties: layout: items: $ref: '#/components/schemas/PreviewAppFormLayoutGetRow' type: array code: maxLength: 128 type: string type: enum: - ROW - SUBTABLE - GROUP type: string required: - code - type type: object PreviewAppFormLayoutGetHrField: properties: elementId: maxLength: 64 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - type type: object PreviewAppFormLayoutGetLabelField: properties: elementId: maxLength: 64 type: string size: properties: width: format: int64 type: integer type: object label: type: string type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - type type: object PreviewAppFormLayoutGetLinkField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetLookupField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetModifiedAtField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetModifierField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetMultipleCheckField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetMultipleLineTextField: properties: code: maxLength: 128 type: string size: properties: innerHeight: format: int64 type: integer width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetMultipleSelectField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetRecordIdField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetReferenceTableField: properties: code: maxLength: 128 type: string type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetRow: properties: fields: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutGetLabelField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSingleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetMultipleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetEditorField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetDecimalField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetCalcField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetMultipleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSingleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSingleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetMultipleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetFileField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetDateField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetDatetimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetTimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetUserSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetLinkField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetLookupField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetReferenceTableField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSpacerField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetHrField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetRecordIdField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetCreatorField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetCreatedAtField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetModifierField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetModifiedAtField' type: object type: array type: enum: - ROW - SUBTABLE - GROUP type: string required: - fields - type type: object PreviewAppFormLayoutGetSingleCheckField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetSingleLineTextField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetSingleSelectField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetSpacerField: properties: elementId: maxLength: 64 type: string size: properties: width: format: int64 type: integer height: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - type type: object PreviewAppFormLayoutGetSubtableRow: properties: code: maxLength: 128 type: string fields: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutGetLabelField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSingleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetMultipleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetEditorField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetDecimalField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetCalcField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetMultipleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSingleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSingleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetMultipleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetFileField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetDateField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetDatetimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetTimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetUserSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetLinkField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetLookupField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetReferenceTableField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetSpacerField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetHrField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetRecordIdField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetCreatorField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetCreatedAtField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetModifierField' - $ref: '#/components/schemas/PreviewAppFormLayoutGetModifiedAtField' type: object type: array type: enum: - ROW - SUBTABLE - GROUP type: string required: - code - fields - type type: object PreviewAppFormLayoutGetTimeField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutGetUserSelectField: properties: code: maxLength: 128 type: string size: properties: width: format: int64 type: integer type: object type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string required: - code - type type: object PreviewAppFormLayoutPutCalcField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutCreatedAtField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutCreatorField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutDateField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutDatetimeField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutDecimalField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutEditorField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: innerHeight: format: int64 type: integer description: |- The height of the field in pixels, excluding the height of the field name. Only the following fields can use this parameter: - Text Area - Rich text width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutFileField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutGroupRow: properties: layout: items: $ref: '#/components/schemas/PreviewAppFormLayoutPutRow' type: array description: |- A list of field layouts for each row inside a Group field. The parameters for this are the same for the `layout` property. code: maxLength: 128 type: string description: The field code of the Table or Group field. Ignore, if the row type is not a Table or a Group. type: enum: - ROW - SUBTABLE - GROUP type: string description: |- The type of row. - `ROW`: A normal row of fields. - `SUBTABLE`: A Table. - `GROUP`: A Group field. required: - code - type type: object PreviewAppFormLayoutPutHrField: properties: elementId: maxLength: 64 type: string description: |- The element ID to set to the following field: - Label - Blank space - Border Specify this when `layout[].fields[].type` is `LABEL`, `SPACER`, or `HR`. If ignored, an empty string is set. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormLayoutPutLabelField: properties: elementId: maxLength: 64 type: string description: |- The element ID to set to the following field: - Label - Blank space - Border Specify this when `layout[].fields[].type` is `LABEL`, `SPACER`, or `HR`. If ignored, an empty string is set. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. label: type: string description: |- The text to set into the Label field. Only specify for Label fields. If ignored, an empty string is set. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormLayoutPutLinkField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutLookupField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutModifiedAtField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutModifierField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutMultipleCheckField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutMultipleLineTextField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: innerHeight: format: int64 type: integer description: |- The height of the field in pixels, excluding the height of the field name. Only the following fields can use this parameter: - Text Area - Rich text width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutMultipleSelectField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutRecordIdField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutReferenceTableField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutRow: properties: fields: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutPutLabelField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSingleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutMultipleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutEditorField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutDecimalField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutCalcField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutMultipleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSingleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSingleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutMultipleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutFileField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutDateField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutDatetimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutTimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutUserSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutLinkField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutLookupField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutReferenceTableField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSpacerField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutHrField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutRecordIdField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutCreatorField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutCreatedAtField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutModifierField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutModifiedAtField' type: object type: array description: The list of fields in the row. type: enum: - ROW - SUBTABLE - GROUP type: string description: |- The type of row. - `ROW`: A normal row of fields. - `SUBTABLE`: A Table. - `GROUP`: A Group field. required: - fields - type type: object PreviewAppFormLayoutPutSingleCheckField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutSingleLineTextField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutSingleSelectField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutSpacerField: properties: elementId: maxLength: 64 type: string description: |- The element ID to set to the following field: - Label - Blank space - Border Specify this when `layout[].fields[].type` is `LABEL`, `SPACER`, or `HR`. If ignored, an empty string is set. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection height: format: int64 type: integer description: |- The height of the field in pixels, including the height of the field name. Only Blank space fields can use this parameter. type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - type type: object PreviewAppFormLayoutPutSubtableRow: properties: code: maxLength: 128 type: string description: The field code of the Table or Group field. Ignore, if the row type is not a Table or a Group. fields: items: anyOf: - $ref: '#/components/schemas/PreviewAppFormLayoutPutLabelField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSingleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutMultipleLineTextField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutEditorField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutDecimalField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutCalcField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutMultipleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSingleCheckField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSingleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutMultipleSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutFileField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutDateField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutDatetimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutTimeField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutUserSelectField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutLinkField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutLookupField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutReferenceTableField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutSpacerField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutHrField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutRecordIdField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutCreatorField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutCreatedAtField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutModifierField' - $ref: '#/components/schemas/PreviewAppFormLayoutPutModifiedAtField' type: object type: array description: The list of fields in the row. type: enum: - ROW - SUBTABLE - GROUP type: string description: |- The type of row. - `ROW`: A normal row of fields. - `SUBTABLE`: A Table. - `GROUP`: A Group field. required: - code - fields - type type: object PreviewAppFormLayoutPutTimeField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppFormLayoutPutUserSelectField: properties: code: maxLength: 128 type: string description: The field code of the field. Ignore, if the field is a Label, Blank space or a Border. size: properties: width: format: int64 type: integer description: |- The width of the field in pixels. The width can be set for the following fields: - Attachment - Blank space - Border - Calculated - Check box - Created by - Created datetime - Date and time - Date - Drop-down - Label - Link - Lookup - Multi-choice - Number - Radio button - Record number - Rich text - Text Area - Text - Time - Updated by - Updated datetime - User selection type: object description: |- An object with data of the field's size. Depending on how the field is placed, the field may not become the size that you specified. type: enum: - CALC - CHECK_BOX - CREATED_TIME - CREATOR - DATE - DATETIME - DROP_DOWN - FILE - HR - LABEL - LINK - MODIFIER - MULTI_LINE_TEXT - MULTI_SELECT - NUMBER - RADIO_BUTTON - RECORD_NUMBER - REFERENCE_TABLE - RICH_TEXT - SINGLE_LINE_TEXT - SPACER - TIME - UPDATED_TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT type: string description: |- The type of field. - `CALC`: Calculated - `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 - `ORGANIZATION_SELECT`: Department selection - `RADIO_BUTTON`: Radio button - `RECORD_NUMBER`: Record number - `REFERENCE_TABLE`: Related Records - `RICH_TEXT`: Rich text - `SINGLE_LINE_TEXT`: Text - `SPACER`: Blank space - `TIME`: Time - `UPDATED_TIME`: Updated datetime - `USER_SELECT`: User selection For Lookup fields, specify depending on the Key field type it's looking up. required: - code - type type: object PreviewAppNotificationsGeneralGetNotification: properties: recordEdited: type: boolean recordAdded: type: boolean statusChanged: type: boolean includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object fileImported: type: boolean commentAdded: type: boolean type: object PreviewAppNotificationsGeneralPutNotification: properties: recordEdited: type: boolean description: |- Option to notify the entity when a record is edited. - `true`: Notify when a record is edited - `false`: Do not notify when a record is edited If ignored, this value is false. recordAdded: type: boolean description: |- Option to notify the entity when a record is added. - `true`: Notify when a record is added - `false`: Do not notify when a record is added If ignored, this value is false. statusChanged: type: boolean description: |- Option to notify the entity when a status is changed. - `true`: Notify when a status is changed - `false`: Do not notify when a status is changed If ignored, this value is false. includeSubs: type: boolean description: |- The "Include affiliated departments" setting of the Department. This parameter is available if **notifications[].entity.type** parameter is specified to **ORGANIZATION** or **FIELD_ENTITY**. - `true`: Affiliated departments do inherit the General Notification settings - `false`: Affiliated departments do not inherit the General Notification settings If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the General Notification settings are configured to. Specify the field code if the **notifications[].entity.type** parameter is specified as **FIELD_ENTITY**. For guest users, add **guest/** before the login name. Required when specifying the **entity** parameter. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string description: |- The type of the entity the General Notification settings are configured to. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department - **FIELD_ENTITY**: Created By, Updated By, User Selection, Group Selection, and Department Selection Fields Required when specifying the **entity** parameter. required: - code - type type: object description: |- An object containing data of the entity the General Notification settings are configured to. Required when specifying the **notifications** parameter. fileImported: type: boolean description: |- Option to notify the entity when a file is imported. - `true`: Notify when a file is imported - `false`: Do not notify when a file is imported If ignored, this value is false. commentAdded: type: boolean description: |- Option to notify the entity when a comment is posted. - `true`: Notify when a comment is posted - `false`: Do not notify when a comment is posted If ignored, this value is false. required: - entity type: object PreviewAppNotificationsPerRecordGetNotification: properties: filterCond: format: query type: string title: type: string targets: items: $ref: '#/components/schemas/PreviewAppNotificationsPerRecordGetTarget' type: array type: object PreviewAppNotificationsPerRecordGetTarget: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object PreviewAppNotificationsPerRecordPutNotification: properties: filterCond: format: query type: string description: |- The record's filter condition in query string format. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) [Additional Restrictions for Each API](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#additional-restrictions-for-each-api) Required when specifying the **notifications** parameter. title: maxLength: 100 type: string description: |- The notification subject saved under "Summary". If ignored, the notification subject will be an empty string. targets: items: $ref: '#/components/schemas/PreviewAppNotificationsPerRecordPutTarget' type: array description: |- An array of objects containing the recipients of the Per Record Notification. If the array is empty, the Per Record Notification will not have a recipient. Required when specifying the **notifications** parameter. required: - filterCond - targets type: object PreviewAppNotificationsPerRecordPutTarget: properties: includeSubs: type: boolean description: |- The "Include affiliated departments" setting of the Department. This parameter is available if **notifications[].targets[].entity.type** parameter is specified to **ORGANIZATION** or **FIELD_ENTITY**. - `true`: Affiliated departments do inherit the Per Record Notification settings - `false`: Affiliated departments do not inherit the Per Record Notification settings If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the Per Record Notification settings are configured to. Specify the field code if the **notifications[].targets[].entity.type** parameter is specified as **FIELD_ENTITY**. For guest users, add **guest/** before the login name. Required when specifying the **entity** parameter. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string description: |- The type of the entity the Per Record Notification settings are configured to. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department - **FIELD_ENTITY**: Created By, Updated By, User Selection, Group Selection, and Department Selection Fields Required when specifying the **entity** parameter. required: - code - type type: object description: |- An object containing entity details per recipient of the Per Record Notification. Required when specifying the **notifications** parameter. required: - entity type: object PreviewAppNotificationsReminderGetNotification: properties: timing: anyOf: - $ref: '#/components/schemas/PreviewAppNotificationsReminderGetTimingRelative' - $ref: '#/components/schemas/PreviewAppNotificationsReminderGetTimingAbsolute' type: object filterCond: format: query type: string title: type: string targets: items: $ref: '#/components/schemas/PreviewAppNotificationsReminderGetTarget' type: array type: object PreviewAppNotificationsReminderGetTarget: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object PreviewAppNotificationsReminderGetTimingAbsolute: properties: code: type: string time: type: string daysLater: format: int64 type: integer type: object PreviewAppNotificationsReminderGetTimingRelative: properties: hoursLater: format: int64 type: integer code: type: string daysLater: format: int64 type: integer type: object PreviewAppNotificationsReminderPutNotification: properties: timing: anyOf: - $ref: '#/components/schemas/PreviewAppNotificationsReminderPutTimingRelative' - $ref: '#/components/schemas/PreviewAppNotificationsReminderPutTimingAbsolute' type: object description: |- An object containing the Reminder notification's timing. Required when specifying the **notifications** parameter. filterCond: format: query type: string description: |- The record's filter condition in query string format. For more information on query formats refer to the following article: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) [Additional Restrictions for Each API](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#additional-restrictions-for-each-api) The following cases will have the same result: - "All records" is specified. - "null" is specified. - An empty string is specified. - The parameter is ignored. The request will fail if a deleted User, Group, or Organization is specified in the filter condition. title: maxLength: 100 type: string description: |- The notification subject that is saved under "Summary". The maximum limit is 100 characters. If ignored, the notification subject will be an empty string. targets: items: $ref: '#/components/schemas/PreviewAppNotificationsReminderPutTarget' type: array description: |- An array of objects containing the recipients of the Reminder Notification. Required when specifying the **notifications** parameter. required: - timing - targets type: object PreviewAppNotificationsReminderPutTarget: properties: includeSubs: type: boolean description: |- The "Include affiliated departments" setting of the Department. This parameter is available if **notifications[].targets[].entity.type** parameter is specified to **ORGANIZATION** or **FIELD_ENTITY**. - `true`: Affiliated departments do inherit the Reminder Notification settings - `false`: Affiliated departments do not inherit the Reminder Notification settings If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the Reminder Notification settings are configured to. Specify the field code if the **notifications[].targets[].entity.type** parameter is specified as **FIELD_ENTITY**. For guest users, the login name is preceded by **guest/**. Required when specifying the **notifications[].targets[].entity** parameter. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string description: |- The type of the entity the Reminder Notification settings are configured to. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department - **FIELD_ENTITY**: Created By, Updated By, User Selection, Group Selection, and Department Selection Fields For Apps in a guest space, specifying a Department will result in an error. Required when specifying the **notifications[].targets[].entity** parameter. required: - code - type type: object description: |- An object containing entity details per recipient of the Reminder Notification. Required when specifying the **notifications[].targets** parameter. required: - entity type: object PreviewAppNotificationsReminderPutTimingAbsolute: properties: code: type: string description: |- The field code of the field used to determine the Reminder notification's timing. The field code of the following fields can be used: - Created datetime - Updated datetime - Date - Date and time Required when specifying the **notifications[].timing** parameter. time: type: string description: |- The time when the Reminder notification is sent. Input the time in **HH:MM** format. MM must be "00", "10", "20", "30", "40" or "50". Examples: "09:00", "14:30", or "23:50" Required when specifying the **notifications[].timing** parameter and not specifying the **notifications[].timing.hoursLater** parameter. daysLater: format: int64 type: integer description: |- The number of days after the **notifications[].timing.code** date/datetime when the Reminder notification is sent. Input a negative value for the number of days before the **notifications[].timing.code** date/datetime. The value must be between -10000 and 10000. Required when specifying the **notifications[].timing** parameter. required: - code - time - daysLater type: object PreviewAppNotificationsReminderPutTimingRelative: properties: hoursLater: format: int64 type: integer description: |- The number of hours after the **notifications[].timing.code** datetime shifted by **daysLater** when the Reminder notification is sent. Input a negative value for the number of hours before the **notifications[].timing.code** datetime. The value must be between -10000 and 10000. Required when specifying the **notifications[].timing** parameter and not specifying the **notifications[].timing.time** parameter. code: type: string description: |- The field code of the field used to determine the Reminder notification's timing. The field code of the following fields can be used: - Created datetime - Updated datetime - Date - Date and time Required when specifying the **notifications[].timing** parameter. daysLater: format: int64 type: integer description: |- The number of days after the **notifications[].timing.code** date/datetime when the Reminder notification is sent. Input a negative value for the number of days before the **notifications[].timing.code** date/datetime. The value must be between -10000 and 10000. Required when specifying the **notifications[].timing** parameter. required: - hoursLater - code - daysLater type: object PreviewAppPluginsGetPluginForm: properties: name: type: string id: type: string enabled: type: boolean type: object PreviewAppReportsGetFieldAggregation: properties: code: type: string type: enum: - SUM - AVERAGE - MAX - MIN type: string type: object PreviewAppReportsGetGroup: properties: code: type: string type: object PreviewAppReportsGetGroupDate: properties: code: type: string per: enum: - YEAR - QUARTER - MONTH - WEEK - DAY type: string type: object PreviewAppReportsGetGroupDateTime: properties: code: type: string per: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR - MINUTE type: string type: object PreviewAppReportsGetGroupTime: properties: code: type: string per: enum: - HOUR - MINUTE type: string type: object PreviewAppReportsGetPeriodDay: properties: time: type: string every: enum: - DAY type: string type: object PreviewAppReportsGetPeriodHour: properties: every: enum: - HOUR type: string minute: format: int64 type: integer type: object PreviewAppReportsGetPeriodMonth: properties: dayOfMonth: type: string time: type: string every: enum: - MONTH type: string type: object PreviewAppReportsGetPeriodQuarter: properties: dayOfMonth: type: string pattern: enum: - JAN_APR_JUL_OCT - FEB_MAY_AUG_NOV - MAR_JUN_SEP_DEC type: string time: type: string every: enum: - QUARTER type: string type: object PreviewAppReportsGetPeriodWeek: properties: dayOfWeek: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string time: type: string every: enum: - WEEK type: string type: object PreviewAppReportsGetPeriodYear: properties: month: format: int64 type: integer dayOfMonth: format: int64 type: integer time: type: string every: enum: - YEAR type: string type: object PreviewAppReportsGetRecordAggregation: properties: type: enum: - COUNT type: string type: object PreviewAppReportsGetReport: properties: periodicReport: properties: period: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetPeriodYear' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodQuarter' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodMonth' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodWeek' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodDay' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodHour' type: object active: type: boolean type: object chartType: enum: - PIE - LINE - SPLINE - TABLE - PIVOT_TABLE - BAR - COLUMN - AREA - SPLINE_AREA type: string name: type: string index: format: int64 type: integer groups: items: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetGroup' - $ref: '#/components/schemas/PreviewAppReportsGetGroupDateTime' - $ref: '#/components/schemas/PreviewAppReportsGetGroupDate' - $ref: '#/components/schemas/PreviewAppReportsGetGroupTime' type: object type: array id: format: int64 type: integer filterCond: format: query type: string aggregations: items: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetRecordAggregation' - $ref: '#/components/schemas/PreviewAppReportsGetFieldAggregation' type: object type: array sorts: items: $ref: '#/components/schemas/PreviewAppReportsGetSort' type: array type: object PreviewAppReportsGetReportWithChartMode: properties: periodicReport: properties: period: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetPeriodYear' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodQuarter' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodMonth' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodWeek' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodDay' - $ref: '#/components/schemas/PreviewAppReportsGetPeriodHour' type: object active: type: boolean type: object chartType: enum: - PIE - LINE - SPLINE - TABLE - PIVOT_TABLE - BAR - COLUMN - AREA - SPLINE_AREA type: string name: type: string index: format: int64 type: integer groups: items: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetGroup' - $ref: '#/components/schemas/PreviewAppReportsGetGroupDateTime' - $ref: '#/components/schemas/PreviewAppReportsGetGroupDate' - $ref: '#/components/schemas/PreviewAppReportsGetGroupTime' type: object type: array id: format: int64 type: integer chartMode: enum: - NORMAL - STACKED - PERCENTAGE type: string filterCond: format: query type: string aggregations: items: anyOf: - $ref: '#/components/schemas/PreviewAppReportsGetRecordAggregation' - $ref: '#/components/schemas/PreviewAppReportsGetFieldAggregation' type: object type: array sorts: items: $ref: '#/components/schemas/PreviewAppReportsGetSort' type: array type: object PreviewAppReportsGetSort: properties: by: enum: - TOTAL - GROUP1 - GROUP2 - GROUP3 type: string order: enum: - ASC - DESC type: string type: object PreviewAppReportsPutFieldAggregation: properties: code: type: string description: |- The field code of the field to be used in the "Function" option. Elements with **type** set to **SUM** or **AVERAGE** can specify the following fields: - **Number** fields - **Calculated** fields (Number) - **Calculated** fields (Number with thousands separator) - **Calculated** fields (Hours & minutes) within tables - **Calculated** fields (Days & hours & minutes) within tables - **Lookup** fields with the Key Field set as a **Number** field Elements with **type** set to **MAX** or **MIN** can specify the following fields: - **Number** field - **Calculated** fields (Number) - **Calculated** fields (Number with thousands separator) - **Calculated** fields (Date & time) within tables - **Calculated** fields (Date) within tables - **Calculated** fields (Time) within tables - **Calculated** fields (Hours & minutes) within tables - **Calculated** fields (Days & hours & minutes) within tables - **Date** fields within tables - **Date and time** fields within tables - **Time** fields within tables - **Created datetime** fields within tables - **Updated datetime** fields within tables - **Lookup** fields with the Key Field set as a **Number** field Required for each element of the **reports.{graphname}.aggregations** parameter, except for elements with **type** set to **COUNT**. type: enum: - SUM - AVERAGE - MAX - MIN type: string description: |- The type of the "Function" option. - **COUNT**: number of records - **SUM**: Total - **AVERAGE**: Average - **MAX**: Maximum - **MIN**: Minimum Required when specifying the **reports.{graphname}.aggregations** parameter. required: - code - type type: object PreviewAppReportsPutGroup: properties: code: type: string description: |- The field code of the field used to determine the "Group by" option. Required when specifying the **reports.{graphname}.groups** parameter. per: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR - MINUTE type: string description: |- The time unit used for the "Group by" option. - **YEAR**: by the year - **QUARTER**: by the quarter - **MONTH**: by the month - **WEEK**: by the week - **DAY**: by the day - **HOUR**: by the hour - **MINUTE**: by the minute The following time units ​​can be specified for each field type set to **reports.{graphname}.groups[].code**: - Created datetime: All values - Updated datetime: All values - Date and time: All values - Date: **YEAR**, **QUARTER**, **MONTH**, **WEEK**, or **DAY** - Time: **HOUR** or **MINUTE** Required if one of the fields above is specified in **reports.{graphname}.groups[].code**. required: - code type: object PreviewAppReportsPutPeriodDay: properties: time: type: string description: |- The time when the Periodic Report will be generated. Input the time in **HH:MM** format. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, **MONTH**, **WEEK**, or **DAY**. every: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR type: string description: |- The time interval type used to determine when to generate the Periodic Reports. - **YEAR**: by the year - **QUARTER**: by the quarter - **MONTH**: by the month - **WEEK**: by the week - **DAY**: by the day - **HOUR**: by the hour Required when specifying the **reports.{graphname}.periodicReport.period** parameter. required: - time - every type: object PreviewAppReportsPutPeriodHour: properties: every: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR type: string description: |- The time interval type used to determine when to generate the Periodic Reports. - **YEAR**: by the year - **QUARTER**: by the quarter - **MONTH**: by the month - **WEEK**: by the week - **DAY**: by the day - **HOUR**: by the hour Required when specifying the **reports.{graphname}.periodicReport.period** parameter. minute: format: int64 type: integer description: |- The minute when the hourly Periodic Report will be generated. Set as "0", "10", "20", "30", "40" or "50". Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **HOUR**. required: - every - minute type: object PreviewAppReportsPutPeriodicReport: properties: period: anyOf: - $ref: '#/components/schemas/PreviewAppReportsPutPeriodYear' - $ref: '#/components/schemas/PreviewAppReportsPutPeriodQuarter' - $ref: '#/components/schemas/PreviewAppReportsPutPeriodMonth' - $ref: '#/components/schemas/PreviewAppReportsPutPeriodWeek' - $ref: '#/components/schemas/PreviewAppReportsPutPeriodDay' - $ref: '#/components/schemas/PreviewAppReportsPutPeriodHour' type: object description: |- An object containing the "Period" options. When updating the Periodic Report, either ignore this parameter or keep the parameters the same. Otherwise, an error will be returned. Required when adding a new graph. active: type: boolean description: |- The activation status of the "Periodic Reports" option. - `true`: Active - `false`: Inactive If this parameter is ignored when creating a new Periodic Report, this value is set to true. If this parameter is ignored when updating an existing Periodic Report, this value is not updated. type: object description: |- An object containing the "Periodic Reports" options. If the "Periodic Reports" option is active, no graph settings can be updated except for the following: - **reports.{graphname}.name** - **reports.{graphname}.index** - **reports.{graphname}.periodicReport.active** If this parameter is ignored, no changes will be made to the "Periodic Reports" options. PreviewAppReportsPutPeriodMonth: properties: dayOfMonth: type: string description: |- The day when the Periodic Report will be generated. - Integers from 1 to 31: The specific day of the month - **END_OF_MONTH**: The last day of the month* *Only if **reports.{graphname}.periodicReport.period.every** parameter is set to **QUARTER** or **MONTH**. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, or **MONTH**. time: type: string description: |- The time when the Periodic Report will be generated. Input the time in **HH:MM** format. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, **MONTH**, **WEEK**, or **DAY**. every: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR type: string description: |- The time interval type used to determine when to generate the Periodic Reports. - **YEAR**: by the year - **QUARTER**: by the quarter - **MONTH**: by the month - **WEEK**: by the week - **DAY**: by the day - **HOUR**: by the hour Required when specifying the **reports.{graphname}.periodicReport.period** parameter. required: - dayOfMonth - time - every type: object PreviewAppReportsPutPeriodQuarter: properties: dayOfMonth: type: string description: |- The day when the Periodic Report will be generated. - Integers from 1 to 31: The specific day of the month - **END_OF_MONTH**: The last day of the month* *Only if **reports.{graphname}.periodicReport.period.every** parameter is set to **QUARTER** or **MONTH**. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, or **MONTH**. pattern: enum: - JAN_APR_JUL_OCT - FEB_MAY_AUG_NOV - MAR_JUN_SEP_DEC type: string description: |- The months when the quarterly Periodic Report will be generated. - **JAN_APR_JUL_OCT**: January, April, July, October - **FEB_MAY_AUG_NOV**: February, May, August, November - **MAR_JUN_SEP_DEC**: March, June, September, December Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **QUARTER**. time: type: string description: |- The time when the Periodic Report will be generated. Input the time in **HH:MM** format. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, **MONTH**, **WEEK**, or **DAY**. every: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR type: string description: |- The time interval type used to determine when to generate the Periodic Reports. - **YEAR**: by the year - **QUARTER**: by the quarter - **MONTH**: by the month - **WEEK**: by the week - **DAY**: by the day - **HOUR**: by the hour Required when specifying the **reports.{graphname}.periodicReport.period** parameter. required: - dayOfMonth - pattern - time - every type: object PreviewAppReportsPutPeriodWeek: properties: dayOfWeek: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string description: |- The day of the week when the Periodic Report will be generated. - **SUNDAY** - **MONDAY** - **TUESDAY** - **WEDNESDAY** - **THURSDAY** - **FRIDAY** - **SATURDAY** Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **WEEK**. time: type: string description: |- The time when the Periodic Report will be generated. Input the time in **HH:MM** format. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, **MONTH**, **WEEK**, or **DAY**. every: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR type: string description: |- The time interval type used to determine when to generate the Periodic Reports. - **YEAR**: by the year - **QUARTER**: by the quarter - **MONTH**: by the month - **WEEK**: by the week - **DAY**: by the day - **HOUR**: by the hour Required when specifying the **reports.{graphname}.periodicReport.period** parameter. required: - dayOfWeek - time - every type: object PreviewAppReportsPutPeriodYear: properties: month: format: int64 type: integer description: |- The month when the Periodic Report will be generated. Specify the month as an integer, ranging from 1 (January) to 12 (December). Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**. dayOfMonth: format: int64 type: integer description: |- The day when the Periodic Report will be generated. - Integers from 1 to 31: The specific day of the month - **END_OF_MONTH**: The last day of the month* *Only if **reports.{graphname}.periodicReport.period.every** parameter is set to **QUARTER** or **MONTH**. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, or **MONTH**. time: type: string description: |- The time when the Periodic Report will be generated. Input the time in **HH:MM** format. Required when the **reports.{graphname}.periodicReport.period.every** parameter is set to **YEAR**, **QUARTER**, **MONTH**, **WEEK**, or **DAY**. every: enum: - YEAR - QUARTER - MONTH - WEEK - DAY - HOUR type: string description: |- The time interval type used to determine when to generate the Periodic Reports. - **YEAR**: by the year - **QUARTER**: by the quarter - **MONTH**: by the month - **WEEK**: by the week - **DAY**: by the day - **HOUR**: by the hour Required when specifying the **reports.{graphname}.periodicReport.period** parameter. required: - month - dayOfMonth - time - every type: object PreviewAppReportsPutRecordAggregation: properties: type: enum: - COUNT type: string description: |- The type of the "Function" option. - **COUNT**: number of records - **SUM**: Total - **AVERAGE**: Average - **MAX**: Maximum - **MIN**: Minimum Required when specifying the **reports.{graphname}.aggregations** parameter. required: - type type: object PreviewAppReportsPutReport: properties: periodicReport: $ref: '#/components/schemas/PreviewAppReportsPutPeriodicReport' chartType: enum: - PIE - LINE - SPLINE - TABLE - PIVOT_TABLE - BAR - COLUMN - AREA - SPLINE_AREA type: string description: |- The chart type of the graph. For more information, refer to the following article: [Chart Types and Their Usage](https://us.kintone.help/k/en/id/040581) - **BAR**: Bar chart - **COLUMN**: Column chart - **PIE**: Pie chart - **LINE**: Line chart - **PIVOT_TABLE**: Pivot Table - **TABLE**: Table - **AREA**: Area chart - **SPLINE**: Spline chart - **SPLINE_AREA**: Spline area chart Required when updating an existing graph, or creating a new graph. name: maxLength: 64 minLength: 1 type: string description: |- The name of the graph. 1 to 64 characters can be specified. When adding a new graph, the request will fail if the value of this parameter is not the same as **reports.{graphname}**. Required when adding a new graph. index: format: int64 type: integer description: |- The order of the graphs. The graph is sorted in ascending order, starting from 0. The request will fail if there are duplicate values. Required when updating an existing graph, or creating a new graph. groups: items: $ref: '#/components/schemas/PreviewAppReportsPutGroup' type: array description: |- An array of objects containing the "Group by" options. The order of the objects are in the order of "Level 1", "Level 2", and "Level 3". The request will fail if the **reports.{graphname}.chartType** parameter is set to **PIVOT_TABLE** and **reports.{graphname}.groups** has less than one object. Required when adding a new graph. filterCond: format: query type: string description: |- The record's filter condition in query string format that reflects the "Filter" option. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) If this parameter is ignored for a new graph, it is the same as when "All records" is specified. If this parameter is ignored for an existing graph, the filter setting will not be changed. The request will fail if a deleted User, Group, or Organization is specified in the filter condition. aggregations: items: anyOf: - $ref: '#/components/schemas/PreviewAppReportsPutRecordAggregation' - $ref: '#/components/schemas/PreviewAppReportsPutFieldAggregation' type: object type: array description: |- An array of objects containing the "Function" options. The maximum limit is 10 elements in the array. If the **reports.{graphname}.chartType** parameter is set to **PIVOT_TABLE**, only 1 element can be set in the array. Required when adding a new graph. sorts: items: $ref: '#/components/schemas/PreviewAppReportsPutSort' type: array description: |- An array of objects containing the "Sort by" options. The maximum limit is 3 elements in the array. Required when adding a new graph. required: - chartType - index type: object PreviewAppReportsPutReportResult: properties: id: format: int64 type: integer type: object PreviewAppReportsPutReportWithChartMode: properties: periodicReport: $ref: '#/components/schemas/PreviewAppReportsPutPeriodicReport' chartType: enum: - PIE - LINE - SPLINE - TABLE - PIVOT_TABLE - BAR - COLUMN - AREA - SPLINE_AREA type: string description: |- The chart type of the graph. For more information, refer to the following article: [Chart Types and Their Usage](https://us.kintone.help/k/en/id/040581) - **BAR**: Bar chart - **COLUMN**: Column chart - **PIE**: Pie chart - **LINE**: Line chart - **PIVOT_TABLE**: Pivot Table - **TABLE**: Table - **AREA**: Area chart - **SPLINE**: Spline chart - **SPLINE_AREA**: Spline area chart Required when updating an existing graph, or creating a new graph. name: maxLength: 64 minLength: 1 type: string description: |- The name of the graph. 1 to 64 characters can be specified. When adding a new graph, the request will fail if the value of this parameter is not the same as **reports.{graphname}**. Required when adding a new graph. index: format: int64 type: integer description: |- The order of the graphs. The graph is sorted in ascending order, starting from 0. The request will fail if there are duplicate values. Required when updating an existing graph, or creating a new graph. groups: items: $ref: '#/components/schemas/PreviewAppReportsPutGroup' type: array description: |- An array of objects containing the "Group by" options. The order of the objects are in the order of "Level 1", "Level 2", and "Level 3". The request will fail if the **reports.{graphname}.chartType** parameter is set to **PIVOT_TABLE** and **reports.{graphname}.groups** has less than one object. Required when adding a new graph. chartMode: enum: - NORMAL - STACKED - PERCENTAGE type: string description: |- The display mode of the graph. For more information, refer to the following article: [Chart Types and Their Usage](https://us.kintone.help/k/en/id/040581) - **NORMAL**: Clustered graph or Non-stacked graph - **STACKED**: Stacked graph - **PERCENTAGE**: 100% stacked graph If the **reports.{graphname}.chartType** parameter is set to **BAR** or **COLUMN**, **NORMAL** refers to "Clustered graph" display mode. If the **reports.{graphname}.chartType** parameter is set to **AREA** or **SPLINE_AREA**, **NORMAL** refers to "Non-stacked graph" display mode. Required when the **reports.{graphname}.chartType** parameter is set to **BAR**, **COLUMN**, **AREA**, or **SPLINE_AREA**. filterCond: format: query type: string description: |- The record's filter condition in query string format that reflects the "Filter" option. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) If this parameter is ignored for a new graph, it is the same as when "All records" is specified. If this parameter is ignored for an existing graph, the filter setting will not be changed. The request will fail if a deleted User, Group, or Organization is specified in the filter condition. aggregations: items: anyOf: - $ref: '#/components/schemas/PreviewAppReportsPutRecordAggregation' - $ref: '#/components/schemas/PreviewAppReportsPutFieldAggregation' type: object type: array description: |- An array of objects containing the "Function" options. The maximum limit is 10 elements in the array. If the **reports.{graphname}.chartType** parameter is set to **PIVOT_TABLE**, only 1 element can be set in the array. Required when adding a new graph. sorts: items: $ref: '#/components/schemas/PreviewAppReportsPutSort' type: array description: |- An array of objects containing the "Sort by" options. The maximum limit is 3 elements in the array. Required when adding a new graph. required: - chartType - index - chartMode type: object PreviewAppReportsPutSort: properties: by: enum: - TOTAL - GROUP1 - GROUP2 - GROUP3 type: string description: |- How the graph is sorted. - **TOTAL**: Total - **GROUP1**: Level 1 - **GROUP2**: Level 2 - **GROUP3**: Level 3 Required when specifying the **reports.{graphname}.sorts** parameter. order: enum: - ASC - DESC type: string description: |- The order of sorting. - **ASC**: Ascending order - **DESC**: Descending order Required when specifying the **reports.{graphname}.sorts** parameter. required: - by - order type: object PreviewAppSettingsGetIconFileForm: properties: file: properties: size: type: string name: type: string fileKey: type: string contentType: type: string required: - fileKey type: object type: enum: - FILE - PRESET type: string required: - file - type type: object PreviewAppSettingsGetIconPresetForm: properties: type: enum: - FILE - PRESET type: string key: enum: - APP1 - APP2 - APP3 - APP4 - APP5 - APP6 - APP7 - APP8 - APP9 - APP10 - APP11 - APP12 - APP13 - APP14 - APP15 - APP16 - APP17 - APP18 - APP19 - APP20 - APP21 - APP22 - APP23 - APP24 - APP25 - APP26 - APP27 - APP28 - APP29 - APP30 - APP31 - APP32 - APP33 - APP34 - APP35 - APP36 - APP37 - APP38 - APP39 - APP40 - APP41 - APP42 - APP43 - APP44 - APP45 - APP46 - APP47 - APP48 - APP49 - APP50 - APP51 - APP52 - APP53 - APP54 - APP55 - APP56 - APP57 - APP58 - APP59 - APP60 - APP61 - APP62 - APP63 - APP64 - APP65 - APP66 - APP67 - APP68 - APP69 - APP70 - APP71 - APP72 - APP73 - APP74 - APP75 - APP76 - APP77 - APP78 - APP79 - APP80 - APP81 - APP82 - APP83 - APP84 - APP85 - APP86 - APP87 - APP88 - APP89 - APP90 type: string required: - type - key type: object PreviewAppSettingsGetNumberPrecision: properties: roundingMode: enum: - HALF_EVEN - UP - DOWN type: string decimalPlaces: type: string digits: type: string type: object PreviewAppSettingsGetTitleField: properties: code: type: string selectionMode: enum: - AUTO - MANUAL type: string required: - selectionMode type: object PreviewAppSettingsPutIconFileForm: properties: file: properties: size: type: string name: type: string fileKey: type: string description: |- The fileKey of the icon. To attach a file, specify the fileKey responded when using the following API: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) The maximum file size limit is 800KB. Required, if the `icon.type` parameter is set as `FILE`. contentType: type: string required: - fileKey type: object description: |- An object containing information of uploaded icon files. Required, if the `icon.type` parameter is set as `FILE`. type: enum: - FILE - PRESET type: string description: |- The icon type. Specify one of the following: - `FILE`: An uploaded image. - `PRESET`: A preset icon within Kintone. Required, if the `icon` parameter will be set. required: - file - type type: object PreviewAppSettingsPutIconPresetForm: properties: type: enum: - FILE - PRESET type: string description: |- The icon type. Specify one of the following: - `FILE`: An uploaded image. - `PRESET`: A preset icon within Kintone. Required, if the `icon` parameter will be set. key: enum: - APP1 - APP2 - APP3 - APP4 - APP5 - APP6 - APP7 - APP8 - APP9 - APP10 - APP11 - APP12 - APP13 - APP14 - APP15 - APP16 - APP17 - APP18 - APP19 - APP20 - APP21 - APP22 - APP23 - APP24 - APP25 - APP26 - APP27 - APP28 - APP29 - APP30 - APP31 - APP32 - APP33 - APP34 - APP35 - APP36 - APP37 - APP38 - APP39 - APP40 - APP41 - APP42 - APP43 - APP44 - APP45 - APP46 - APP47 - APP48 - APP49 - APP50 - APP51 - APP52 - APP53 - APP54 - APP55 - APP56 - APP57 - APP58 - APP59 - APP60 - APP61 - APP62 - APP63 - APP64 - APP65 - APP66 - APP67 - APP68 - APP69 - APP70 - APP71 - APP72 - APP73 - APP74 - APP75 - APP76 - APP77 - APP78 - APP79 - APP80 - APP81 - APP82 - APP83 - APP84 - APP85 - APP86 - APP87 - APP88 - APP89 - APP90 type: string description: |- The key identifier of the icon. Required, if the `icon.type` parameter is set as `PRESET`. Preset icons have key identifiers that can be obtained using the following API: [Get General Settings](https://kintone.dev/en/docs/kintone/rest-api/apps/settings/get-general-settings/) required: - type - key type: object PreviewAppSettingsPutNumberPrecision: properties: roundingMode: enum: - HALF_EVEN - UP - DOWN type: string description: |- The **Rounding** setting - `HALF_EVEN`: Round to nearest even number - `UP`: Round up - `DOWN`: Round down decimalPlaces: type: number description: |- The **Number of Decimal Places to Round** setting. Specify an integer from 0 to 10. digits: type: number description: |- The **Total Number of Digits** setting. Specify an integer from 1 to 30. type: object PreviewAppSettingsPutTitleField: properties: code: type: string description: The field code of the field used as the title of the record. Required, if `MANUAL` is set for the `titleField.selectionMode` parameter. selectionMode: enum: - AUTO - MANUAL type: string description: |- The option of **The field to be used as the record title** settings. - `AUTO`: The **Set automatically** option. - `MANUAL`: The **Set manually** option. Required if `titleField` is specified. required: - selectionMode type: object PreviewAppStatusGetActionForm: properties: name: type: string executableUser: properties: entities: items: $ref: '#/components/schemas/PreviewAppStatusGetExecutableUserEntityForm' type: array type: object from: type: string to: type: string filterCond: type: string type: type: string type: object PreviewAppStatusGetAssigneeEntityForm: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY - CREATOR - CUSTOM_FIELD type: string type: object type: object PreviewAppStatusGetExecutableUserEntityForm: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object PreviewAppStatusGetStateForm: properties: name: type: string index: format: int64 type: integer assignee: properties: entities: items: $ref: '#/components/schemas/PreviewAppStatusGetAssigneeEntityForm' type: array type: enum: - ONE - ALL - ANY type: string type: object type: object PreviewAppStatusPutActionForm: properties: name: maxLength: 64 minLength: 1 type: string description: |- The Action name. The maximum length is 64 characters. Required, if setting the `actions` parameter. executableUser: properties: entities: items: $ref: '#/components/schemas/PreviewAppStatusPutExecutableUserEntityForm' type: array required: - entities type: object from: maxLength: 64 minLength: 1 type: string description: |- The Status name before taking action. If a Status name that you want to specify has been changed, place the changed value for this parameter. Required, if setting the `actions` parameter. to: maxLength: 64 minLength: 1 type: string description: |- The Status name after taking action. If a Status name that you want to specify has been changed, place the changed value for this parameter. Required, if setting the `actions` parameter. filterCond: type: string description: |- The branch criteria of the action, specified as a query. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) [Additional Restrictions for Each API](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#additional-restrictions-for-each-api) type: enum: - PRIMARY - SECONDARY type: string required: - name - from - to type: object PreviewAppStatusPutAssigneeEntityForm: properties: includeSubs: type: boolean description: |- The **Include affiliated departments** settings of the department. - `true`: Affiliated departments are included as Assignees - `false`: Affiliated departments are not included as Assignees If ignored, this value is false. entity: properties: code: type: string description: |- The code of the Assignee. To specify guest space users, add the string `guest/` before the guest's log in name. If `FIELD_ENTITY` is specified for the `entity.type`, state the field code of the following fields: - Created by - Updated by - User selection - Department selection - Group selection If `CUSTOM_FIELD` is specified for `entity.type`, state the field code of the Custom Field. For more information, refer to the following article: [Adding Fields in User Information (Custom Fields)](https://us.kintone.help/general/en/id/020219) If `CREATOR` is specified for `entity.type`, ignore this parameter. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY - CREATOR - CUSTOM_FIELD type: string description: |- The entity type of the Assignee. - `USER`: User - `GROUP`: Group - `ORGANIZATION`: Department - `FIELD_ENTITY`: User/Group/Department selection field - `CREATOR`: Created by field - `CUSTOM_FIELD`: A Custom Field For more information, refer to the following article: [Adding Fields in User Information (Custom Fields)](https://us.kintone.help/general/en/id/020219) Required, for each entity stated. Departments cannot be specified in guest space Apps. required: - type type: object description: |- An object containing user data of the Assignees. Required, if setting the `entities` parameter. required: - entity type: object PreviewAppStatusPutExecutableUserEntityForm: properties: includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string required: - type type: object required: - entity type: object PreviewAppStatusPutStateForm: properties: name: maxLength: 64 minLength: 1 type: string description: |- The status name. The maximum length is 64 characters. Required, if stating a new status for `{status_name}`. In this case, state the same value used for `{status_name}`. index: format: int64 type: integer description: The display order (ascending from 0) of the Status, when listed with the other statuses. Required, if setting the `{status_name}` parameter. assignee: properties: entities: items: $ref: '#/components/schemas/PreviewAppStatusPutAssigneeEntityForm' type: array description: |- An array listing data of the Assignees. Required, if setting the `{status_name}.assignee` parameter. type: enum: - ONE - ALL - ANY type: string description: |- The Assignee List type of the Status. - `ONE` : User chooses one assignee from the list to take action - `ALL` : All Assignees in the list must take action - `ANY` : One assignee in the list must take action Required, if setting the `{status_name}.assignee` parameter. required: - entities - type type: object description: An object containing data of the Assignee settings. required: - index type: object description: |- An object containing the settings of each status. - Add a new status: Specify a status name that does not exist. - Update a status: Specify the name of the status to be updated. - Delete a status: Do not specify the status name for deletion. The first status cannot be added. To change the first status, update the name of the existing first status. PreviewAppViewsGetBuiltinCalendarViewOutputForm: properties: date: type: string name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string title: type: string type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string builtinType: enum: - ASSIGNEE type: string type: object PreviewAppViewsGetBuiltinListViewOutputForm: properties: name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string fields: items: type: string type: array type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string builtinType: enum: - ASSIGNEE type: string type: object PreviewAppViewsGetCalendarViewOutputForm: properties: date: type: string name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string title: type: string type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string type: object PreviewAppViewsGetCustomViewOutputForm: properties: pager: type: boolean name: type: string index: format: int64 type: integer html: type: string id: format: int64 type: integer sort: type: string type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string device: enum: - DESKTOP - ANY type: string type: object PreviewAppViewsGetListViewOutputForm: properties: name: type: string index: format: int64 type: integer id: format: int64 type: integer sort: type: string fields: items: type: string type: array type: enum: - LIST - CALENDAR - CUSTOM type: string filterCond: type: string type: object PreviewAppViewsPutCalendarViewForm: properties: date: type: string description: |- Used for Calendar Views. The field to be used as the **Date Field** of the Calendar View. Specify a date type field by their field code. If ignored, the Updated datetime field will be set. name: type: string description: |- The name of the View. The maximum character limit is 64. Required, if `views.{viewname}` is a new View. In this case, specify the same new View name for this parameter. index: format: int64 type: integer description: |- The display order of the View. In the list of views, specified with a number. The list of views will be displayed in ascending order. sort: type: string description: |- The sort order in a query format. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) title: type: string description: |- Used for Calendar views. The field to be used as the **Title Field** of the Calendar View. Specify a text type field by their field code. If ignored, the Record number field will be set. type: enum: - LIST - CALENDAR - CUSTOM type: string description: |- The type of View. - `LIST`: List View - `CALENDAR`: Calendar View - `CUSTOM`: Custom View filterCond: type: string description: |- The filter condition in a query format. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) builtinType: enum: - ASSIGNEE type: string required: - index - type type: object PreviewAppViewsPutCustomViewForm: properties: pager: type: boolean description: |- Used for Custom Views. The pagination settings. Specify one of the following: - `true`: Enable (default) - `false`: Disable name: type: string description: |- The name of the View. The maximum character limit is 64. Required, if `views.{viewname}` is a new View. In this case, specify the same new View name for this parameter. index: format: int64 type: integer description: |- The display order of the View. In the list of views, specified with a number. The list of views will be displayed in ascending order. html: type: string description: |- Used for Custom Views. The HTML code to set for the Custom View. sort: type: string description: |- The sort order in a query format. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) type: enum: - LIST - CALENDAR - CUSTOM type: string description: |- The type of View. - `LIST`: List View - `CALENDAR`: Calendar View - `CUSTOM`: Custom View filterCond: type: string description: |- The filter condition in a query format. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) device: enum: - DESKTOP - ANY type: string description: |- Used for Custom Views. The scope of where the view is displayed. If this parameter is not specified, the default is `DESKTOP`. If view settings are updated without specifying this parameter, this parameter does not change. - `DESKTOP`: Display only on desktop - `ANY`: Display on both desktop and mobile builtinType: enum: - ASSIGNEE type: string required: - index - type type: object PreviewAppViewsPutListViewForm: properties: name: type: string description: |- The name of the View. The maximum character limit is 64. Required, if `views.{viewname}` is a new View. In this case, specify the same new View name for this parameter. index: format: int64 type: integer description: |- The display order of the View. In the list of views, specified with a number. The list of views will be displayed in ascending order. sort: type: string description: |- The sort order in a query format. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) fields: items: type: string type: array description: |- Used for List Views. The list of fields to be displayed in the list. Specify fields by their field codes. This parameter is required, if adding a new List View. type: enum: - LIST - CALENDAR - CUSTOM type: string description: |- The type of View. - `LIST`: List View - `CALENDAR`: Calendar View - `CUSTOM`: Custom View filterCond: type: string description: |- The filter condition in a query format. For more information on query formats refer to the following document: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) There are restrictions on the conditions that can be specified: [Available Operators and Functions for Each Field](https://kintone.dev/en/id/0d9792ee2b6e4b0e3829c9ee/#available-operators-and-functions-for-each-field) builtinType: enum: - ASSIGNEE type: string required: - index - type type: object PreviewAppViewsPutResult: properties: id: format: int64 type: integer type: object PreviewFieldAclGetEntityRight: properties: accessibility: enum: - WRITE - READ - NONE type: string includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object PreviewFieldAclGetRight: properties: code: type: string entities: items: $ref: '#/components/schemas/PreviewFieldAclGetEntityRight' type: array type: object PreviewFieldAclPutFieldRightEntity: properties: accessibility: enum: - WRITE - READ - NONE type: string description: |- The permission to grant to the entity. - `READ`: Permissions to view only. - `WRITE`: Permissions to view and edit. - `NONE`: No permissions to view and edit includeSubs: type: boolean description: |- The permission inheritance settings of the department the permissions are granted to. - `true`: Permissions are inherited. - `false`: Permissions are not inherited. If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the permission is granted to. If the `Everyone` group is not specified, the `Everyone` group will have no permissions to view/edit/delete. To specify guest space users, add the string `guest/` before the guest's log in name. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string description: |- The type of the entity the permission is granted to. - `USER`: User - `GROUP`: Group - `ORGANIZATION`: Department - `FIELD_ENTITY`: User field required: - type type: object description: An object containing data of the entity the permission is granted to. required: - accessibility - entity type: object PreviewFieldAclPutRight: properties: code: type: string description: The field code of the field to set permissions around. entities: items: $ref: '#/components/schemas/PreviewFieldAclPutFieldRightEntity' type: array description: |- An array listing the entities the permissions are granted to. List in order of priority. The `Everyone` group will be treated with the lowest priority, wherever it is placed in the list. required: - code - entities type: object PreviewFormGetBultinProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object PreviewFormGetCalcSimpleProperties: properties: noLabel: type: boolean unit: type: string expression: type: string code: type: string format: enum: - NUMBER - NUMBER_DIGIT - DATETIME - DATE - TIME - HOUR_MINUTE - DAY_HOUR_MINUTE type: string unitPosition: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string displayScale: format: int64 type: integer hideExpression: type: boolean required: type: boolean type: object PreviewFormGetDateSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string defaultExpression: type: string unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetDatetimeSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string defaultExpression: type: string unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetDecimalSimpleProperties: properties: noLabel: type: boolean code: type: string maxValue: format: int64 type: integer defaultValue: type: string unitPosition: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean minValue: format: int64 type: integer unit: type: string unique: type: boolean displayScale: format: int64 type: integer digit: type: boolean type: object PreviewFormGetEditorSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetFileSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetGroupSelectSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetLabelProperties: properties: label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object PreviewFormGetLayoutProperties: properties: type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object PreviewFormGetLinkSimpleProperties: properties: noLabel: type: boolean protocol: enum: - WEB - CALL - MAIL type: string code: type: string defaultValue: type: string minLength: format: int64 type: integer unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string maxLength: format: int64 type: integer required: type: boolean type: object PreviewFormGetLookupSimpleProperties: properties: noLabel: type: boolean code: type: string relatedApp: format: int64 type: integer label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetMultipleLineTextSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetMultipleSelectSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: items: type: string type: array options: items: type: string type: array label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetOrganizationSelectSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetReferenceTableLayoutProperties: properties: noLabel: type: boolean code: type: string relatedApp: format: int64 type: integer label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object PreviewFormGetSingleLineTextSimpleProperties: properties: noLabel: type: boolean expression: type: string code: type: string defaultValue: type: string minLength: format: int64 type: integer unique: type: boolean label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string maxLength: format: int64 type: integer hideExpression: type: boolean required: type: boolean type: object PreviewFormGetSingleSelectSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string options: items: type: string type: array label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetSpacerProperties: properties: elementId: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object PreviewFormGetSubTableLayoutProperties: properties: noLabel: type: boolean code: type: string label: type: string fields: items: anyOf: - $ref: '#/components/schemas/PreviewFormGetLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetLabelProperties' - $ref: '#/components/schemas/PreviewFormGetBultinProperties' - $ref: '#/components/schemas/PreviewFormGetCalcSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDateSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDatetimeSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetDecimalSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetEditorSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetFileSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetLinkSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetMultipleLineTextSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetMultipleSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetSingleLineTextSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetSingleSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetTimeSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetUserSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetOrganizationSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetGroupSelectSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetLookupSimpleProperties' - $ref: '#/components/schemas/PreviewFormGetReferenceTableLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetSubTableLayoutProperties' - $ref: '#/components/schemas/PreviewFormGetSpacerProperties' type: object type: array type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string type: object PreviewFormGetTimeSimpleProperties: properties: noLabel: type: boolean code: type: string defaultValue: type: string defaultExpression: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewFormGetUserSelectSimpleProperties: properties: noLabel: type: boolean code: type: string label: type: string type: enum: - LABEL - SPACER - HR - CREATED_TIME - CREATOR - DATE - DATETIME - NUMBER - CALC - RICH_TEXT - FILE - UPDATED_TIME - MODIFIER - CHECK_BOX - MULTI_LINE_TEXT - MULTI_SELECT - RECORD_NUMBER - RADIO_BUTTON - SINGLE_LINE_TEXT - DROP_DOWN - SUBTABLE - TIME - USER_SELECT - ORGANIZATION_SELECT - GROUP_SELECT - REFERENCE_TABLE - LINK type: string required: type: boolean type: object PreviewRecordAclGetEntityRight: properties: viewable: type: boolean editable: type: boolean deletable: type: boolean includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object PreviewRecordAclGetRight: properties: entities: items: $ref: '#/components/schemas/PreviewRecordAclGetEntityRight' type: array filterCond: type: string type: object PreviewRecordAclPutEntityRightForm: properties: viewable: type: boolean description: |- The view permission of the entity. - `true`: Grant view permission - `false`: Deny view permission If ignored, the value is false. editable: type: boolean description: |- The edit permission of the entity. - `true`: Grant edit permission - `false`: Deny edit permission If ignored, this value is false. If the entity has no permission to view the record, this value is false. deletable: type: boolean description: |- The delete permission of the entity. - `true`: Grant delete permission - `false`: Deny delete permission If ignored, this value is false. If the entity has no permission to view the record, this value is false. includeSubs: type: boolean description: |- The permission inheritance settings of the department the permissions are granted to. - `true`: Permissions are inherited. - `false`: Permissions are not inherited. If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the permissions are granted to. If the "Everyone" group is not specified, the "Everyone" group will have no permissions to view/edit/delete. To specify guest space users, add the string "guest/" before the guest's log in name. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string description: |- The type of the entity the permissions are granted to. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department - **FIELD_ENTITY**: User field required: - type type: object description: An object containing data of the entity the permissions are granted to. required: - entity type: object PreviewRecordAclPutRightForm: properties: entities: items: $ref: '#/components/schemas/PreviewRecordAclPutEntityRightForm' type: array description: |- An array listing the entities the permissions are granted to. List in order of priority. The "Everyone" group will be treated with the lowest priority, wherever it is placed in the list. filterCond: format: query type: string description: |- The filter condition in a query format. For more information on query formats refer to the following article: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) For more information on the limitations regarding filter conditions, refer to the following section: Limitations If this parameter is ignored, the filter condition will be "All records". required: - entities type: object RadioButtonSimpleValue: type: object properties: type: type: string enum: - RADIO_BUTTON value: type: string required: - type description: Radio button example: type: RADIO_BUTTON value: Choice 3 RawRecordIdSimpleValue: properties: type: type: string enum: - __ID__ value: type: string type: object required: - type description: Record ID example: type: __ID__ value: '3' RecordAclGetEntityRight: properties: viewable: type: boolean editable: type: boolean deletable: type: boolean includeSubs: type: boolean entity: properties: code: type: string type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string type: object type: object RecordAclGetRight: properties: entities: items: $ref: '#/components/schemas/RecordAclGetEntityRight' type: array filterCond: type: string type: object RecordAclPutEntityRightForm: properties: viewable: type: boolean description: |- The view permission of the entity. - `true`: Grant view permission - `false`: Deny view permission If ignored, the value is false. editable: type: boolean description: |- The edit permission of the entity. - `true`: Grant edit permission - `false`: Deny edit permission If ignored, this value is false. If the entity has no permission to view the record, this value is false. deletable: type: boolean description: |- The delete permission of the entity. - `true`: Grant delete permission - `false`: Deny delete permission If ignored, this value is false. If the entity has no permission to view the record, this value is false. includeSubs: type: boolean description: |- The permission inheritance settings of the department the permissions are granted to. - `true`: Permissions are inherited. - `false`: Permissions are not inherited. If ignored, this value is false. entity: properties: code: type: string description: |- The code of the entity the permissions are granted to. If the "Everyone" group is not specified, the "Everyone" group will have no permissions to view/edit/delete. To specify guest space users, add the string "guest/" before the guest's log in name. type: enum: - USER - GROUP - ORGANIZATION - FIELD_ENTITY type: string description: |- The type of the entity the permissions are granted to. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department - **FIELD_ENTITY**: User field required: - type type: object description: An object containing data of the entity the permissions are granted to. required: - entity type: object RecordAclPutRightForm: properties: entities: items: $ref: '#/components/schemas/RecordAclPutEntityRightForm' type: array description: |- An array listing the entities the permissions are granted to. List in order of priority. The "Everyone" group will be treated with the lowest priority, wherever it is placed in the list. filterCond: format: query type: string description: |- The filter condition in a query format. For more information on query formats refer to the following article: [Query String](https://kintone.dev/en/docs/kintone/overview/query-string/) For more information on the limitations regarding filter conditions, refer to the following section: Limitations If this parameter is ignored, the filter condition will be "All records". required: - entities type: object RecordCommentPostMentionForm: properties: code: type: string description: |- The code of the user, group or organization that will be mentioned. The maximum number of mentions is 10. Mentioned users will be displayed at the start of the comment text when the API succeeds. When specifying a guest user as the recipient, the `code` parameter must include the prefix `guest/` followed by the login email address. type: enum: - USER - ORGANIZATION - GROUP type: string description: |- The type of the mentioned target. - `USER`: User - `GROUP`: Group - `ORGANIZATION`: Department required: - code - type type: object RecordCommentsGetCommentOutputForm: properties: createdAt: format: date-time type: string creator: properties: code: type: string name: type: string type: object mentions: items: $ref: '#/components/schemas/RecordCommentsGetMentionOutputForm' type: array id: format: int64 type: integer text: type: string type: object RecordCommentsGetMentionOutputForm: properties: code: type: string type: enum: - USER - ORGANIZATION - GROUP type: string type: object RecordIdSimpleValue: properties: type: type: string enum: - RECORD_NUMBER value: type: string type: object required: - type description: Record number example: type: RECORD_NUMBER value: '7' RecordObject: oneOf: - $ref: '#/components/schemas/CalcSimpleValue' - $ref: '#/components/schemas/CategorySimpleValue' - $ref: '#/components/schemas/CheckBoxSimpleValue' - $ref: '#/components/schemas/CreatedTimeSimpleValue' - $ref: '#/components/schemas/CreatorSimpleValue' - $ref: '#/components/schemas/DateSimpleValue' - $ref: '#/components/schemas/DatetimeSimpleValue' - $ref: '#/components/schemas/DecimalSimpleValue' - $ref: '#/components/schemas/EditorSimpleValue' - $ref: '#/components/schemas/FileSimpleValue' - $ref: '#/components/schemas/GroupSelectSimpleValue' - $ref: '#/components/schemas/LinkSimpleValue' - $ref: '#/components/schemas/ModifiedAtSimpleValue' - $ref: '#/components/schemas/ModifierSimpleValue' - $ref: '#/components/schemas/MultipleLineTextSimpleValue' - $ref: '#/components/schemas/MultipleSelectSimpleValue' - $ref: '#/components/schemas/OrganizationSelectSimpleValue' - $ref: '#/components/schemas/RadioButtonSimpleValue' - $ref: '#/components/schemas/RawRecordIdSimpleValue' - $ref: '#/components/schemas/RecordIdSimpleValue' - $ref: '#/components/schemas/RevisionSimpleValue' - $ref: '#/components/schemas/SimpleTableValue' - $ref: '#/components/schemas/SingleLineTextSimpleValue' - $ref: '#/components/schemas/SingleSelectSimpleValue' - $ref: '#/components/schemas/StatusAssigneeSimpleValue' - $ref: '#/components/schemas/StatusSimpleValue' - $ref: '#/components/schemas/TimeSimpleValue' - $ref: '#/components/schemas/UserSelectSimpleValue' discriminator: propertyName: type mapping: CALC: '#/components/schemas/CalcSimpleValue' CATEGORY: '#/components/schemas/CategorySimpleValue' CHECK_BOX: '#/components/schemas/CheckBoxSimpleValue' CREATED_TIME: '#/components/schemas/CreatedTimeSimpleValue' CREATOR: '#/components/schemas/CreatorSimpleValue' DATE: '#/components/schemas/DateSimpleValue' DATETIME: '#/components/schemas/DatetimeSimpleValue' NUMBER: '#/components/schemas/DecimalSimpleValue' RICH_TEXT: '#/components/schemas/EditorSimpleValue' FILE: '#/components/schemas/FileSimpleValue' GROUP_SELECT: '#/components/schemas/GroupSelectSimpleValue' LINK: '#/components/schemas/LinkSimpleValue' UPDATED_TIME: '#/components/schemas/ModifiedAtSimpleValue' MODIFIER: '#/components/schemas/ModifierSimpleValue' MULTI_LINE_TEXT: '#/components/schemas/MultipleLineTextSimpleValue' MULTI_SELECT: '#/components/schemas/MultipleSelectSimpleValue' ORGANIZATION_SELECT: '#/components/schemas/OrganizationSelectSimpleValue' RADIO_BUTTON: '#/components/schemas/RadioButtonSimpleValue' __ID__: '#/components/schemas/RawRecordIdSimpleValue' RECORD_NUMBER: '#/components/schemas/RecordIdSimpleValue' __REVISION__: '#/components/schemas/RevisionSimpleValue' SUBTABLE: '#/components/schemas/SimpleTableValue' SINGLE_LINE_TEXT: '#/components/schemas/SingleLineTextSimpleValue' DROP_DOWN: '#/components/schemas/SingleSelectSimpleValue' STATUS_ASSIGNEE: '#/components/schemas/StatusAssigneeSimpleValue' STATUS: '#/components/schemas/StatusSimpleValue' TIME: '#/components/schemas/TimeSimpleValue' USER_SELECT: '#/components/schemas/UserSelectSimpleValue' RecordPutUpdateKey: properties: field: type: string description: |- The field code of the unique key. Required, if _updateKey_ will be specified. value: maxLength: 64 type: string description: |- The value of the unique key. Required, if _updateKey_ will be specified. required: - field - value type: object RecordsAclEvaluateGetField: properties: viewable: type: boolean editable: type: boolean type: object RecordsAclEvaluateGetRight: properties: record: properties: viewable: type: boolean editable: type: boolean deletable: type: boolean type: object id: format: int64 type: integer fields: type: object additionalProperties: $ref: '#/components/schemas/RecordsAclEvaluateGetField' type: object RecordsPutRecordBean: properties: id: format: int64 type: integer revision: type: string type: object RecordsPutRecordForm: properties: updateKey: $ref: '#/components/schemas/RecordsPutUpdateKey' record: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' description: |- Field codes and values are specified in this object. If ignored, the record will not be updated. For more information on field types, refer to the following article: [Field Types](https://kintone.dev/en/docs/kintone/overview/field-types/) id: format: int64 type: integer description: |- The Record ID of the record to be updated. Required, if `updateKey` will not be specified. If `upsert` is set to `true`: - If the record exists, the record will be updated - If the record does not exist, it will be added as a new record. The specified ID will be ignored, and a new ID will be set to the new record. revision: format: int64 type: integer description: The expected revision number. If the value does not match, an error will occur and all records will not be updated. If the value is not specified or is -1, the revision number will not be checked. type: object RecordsPutUpdateKey: properties: field: type: string description: The field code of the unique key. Required, if `updateKey` will be specified. value: maxLength: 64 type: string description: The value of the unique key. Required, if `updateKey` will be specified. required: - field - value type: object description: |- The unique key of the record to be updated. Required, if `id` will not be specified. Fields that can be specified: - Text fields, with the **Prohibit duplicate values** option turned on - Number fields, with the **Prohibit duplicate values** option turned on If `upsert` is set to `true`: - If the record exists, the record will be updated - If the record does not exist, it will be added as a new record RecordsPutUpsertRecordBean: properties: id: format: int64 type: integer operation: enum: - INSERT - UPDATE type: string revision: type: string type: object RecordsStatusPutRecordsStatusPutFormRecord: properties: action: type: string description: |- The Action name of the action to run. If the localization feature has been used to apply multiple translations of the Action name, specify the name of the Action in the language settings of the user that will run the API. API Tokens follow the language settings set in the User & System Administration settings. For more information, refer to the following article: [Configuring System Language](https://us.kintone.help/general/en/id/020114) id: format: int64 type: integer description: The Record ID. assignee: type: string description: The next Assignee. Specify the Assignee's log in name. revision: format: int64 type: integer description: |- The revision number of the record before updating the status. If the specified revision is not the latest revision, the request will result in an error. The revision will not be checked if this parameter is ignored, or -1 is specified. required: - action - id type: object RecordsStatusPutRecordsStatusPutOutputFormRecord: properties: id: format: int64 type: integer revision: type: string type: object RecordWritableObject: description: |- The value of a single field when writing a record. **Always an object with a `value` property, never a bare value.** ``` correct: { "fieldCode": { "value": "ABC" } } wrong: { "fieldCode": "ABC" } ``` Sending a bare value returns HTTP 400. `type` is optional; when omitted, the App's field settings are used. The shape of `value` depends on the field type, which `GET /k/v1/app/form/fields.json` reports: | Field type | shape of `value` | |---|---| | Single-line text, Multi-line text, Rich text, Link, Number, Date, Time, Date and time, Drop-down, Radio button | string — numbers and dates are strings too, e.g. `"1200000"`, `"2026-08-31"` | | Check box, Multi-choice | array of strings, each matching one of the App's choices exactly | | User selection, Department selection, Group selection | array of `{ "code": "..." }` | | Attachment | array of `{ "fileKey": "..." }` — upload the file first to obtain a key | | Table | array of `{ "id": "...", "value": { "": { "value": ... } } }` | To clear a field, send an empty string for the text-like types, or an empty array for the array types. **A field code that does not exist in the App is silently ignored.** The request still returns HTTP 200 and a new revision, so a typo looks like success even though nothing changed. Copy the codes from `GET /k/v1/app/form/fields.json` exactly. **Table and Attachment fields are replaced, not merged.** When updating an existing record, every table row and every `fileKey` the request does not list is deleted. To change one cell of a table, send the whole table including the `id` of each row to keep. Fields left out of the request entirely are untouched. anyOf: - type: object properties: type: type: string enum: - CHECK_BOX value: type: array items: type: string required: - value description: Check box - properties: type: type: string enum: - DATE value: type: string format: date nullable: true type: object description: Date - properties: type: type: string enum: - DATETIME value: type: string format: date-time nullable: true type: object description: Date and time - properties: type: type: string enum: - NUMBER value: type: string type: object description: Number - properties: type: type: string enum: - RICH_TEXT value: type: string type: object description: Rich text - properties: type: type: string enum: - FILE value: items: $ref: '#/components/schemas/SingleFileSimpleValue' type: array required: - value type: object description: Attachment - properties: type: type: string enum: - GROUP_SELECT value: items: $ref: '#/components/schemas/GroupEntitySimpleValue' type: array required: - value type: object description: Group Selection - properties: type: type: string enum: - LINK value: type: string type: object description: Link - properties: type: type: string enum: - MULTI_LINE_TEXT value: type: string type: object description: Text area - properties: type: type: string enum: - MULTI_SELECT value: items: type: string type: array required: - value type: object description: Multi-choice - properties: type: type: string enum: - ORGANIZATION_SELECT value: items: $ref: '#/components/schemas/OrganizationEntitySimpleValue' type: array required: - value type: object description: Department Selection - type: object properties: type: type: string enum: - RADIO_BUTTON value: type: string description: Radio button - properties: type: type: string enum: - SUBTABLE value: items: $ref: '#/components/schemas/SimpleRowWritableValue' type: array type: object description: Table - properties: type: type: string enum: - SINGLE_LINE_TEXT value: type: string type: object description: Text - properties: type: type: string enum: - DROP_DOWN value: type: string nullable: true type: object description: Drop-down - properties: type: type: string enum: - TIME value: type: string nullable: true type: object description: Time - properties: type: type: string enum: - USER_SELECT value: items: $ref: '#/components/schemas/UserEntitySimpleValue' type: array required: - value type: object description: User selection RevisionSimpleValue: properties: type: type: string enum: - __REVISION__ value: type: string type: object required: - type description: Revision example: type: __REVISION__ value: '9' SimpleRowValue: properties: id: type: string value: type: object additionalProperties: $ref: '#/components/schemas/RecordObject' type: object SimpleRowWritableValue: properties: id: type: string value: type: object additionalProperties: $ref: '#/components/schemas/RecordWritableObject' type: object description: |- One row of a table when writing a record. Include the `id` of an existing row to keep that row; omit `id` to add a new row. Rows the request does not list are deleted. `value` is keyed by the field codes inside the table, and each cell follows the same `{"value": ...}` rule as a top-level field. SimpleTableValue: properties: type: type: string enum: - SUBTABLE value: items: $ref: '#/components/schemas/SimpleRowValue' type: array type: object required: - type description: Table example: type: SUBTABLE value: - id: '48277' value: textfield_0: type: SINGLE_LINE_TEXT value: Hello Kintone 1 numberfield_0: type: NUMBER value: '5' checkboxfield_0: type: CHECK_BOX value: - Choice1 - id: '48278' value: textfield_0: type: SINGLE_LINE_TEXT value: Hello Kintone 2 numberfield_0: type: NUMBER value: '7' checkboxfield_0: type: CHECK_BOX value: - Choice2 SingleFileSimpleValue: properties: size: type: string name: type: string fileKey: type: string contentType: type: string required: - fileKey type: object SingleLineTextSimpleValue: properties: type: type: string enum: - SINGLE_LINE_TEXT value: type: string type: object required: - type description: Text example: type: SINGLE_LINE_TEXT value: Hello Kintone SingleSelectSimpleValue: properties: type: type: string enum: - DROP_DOWN value: type: string nullable: true type: object required: - type description: Drop-down example: type: DROP_DOWN value: Choice 1 SpaceGetAttachedApp: properties: threadId: type: string nullable: true createdAt: format: date-time type: string creator: properties: code: type: string name: type: string type: object code: type: string modifiedAt: format: date-time type: string appId: type: string modifier: properties: code: type: string name: type: string type: object name: type: string description: type: string type: object SpaceMembersGetGroupBean: properties: isAdmin: type: boolean entity: properties: code: type: string type: type: string type: object type: object SpaceMembersGetOrganizationBean: properties: isAdmin: type: boolean includeSubs: type: boolean entity: properties: code: type: string type: type: string type: object type: object SpaceMembersGetUserBean: properties: isImplicit: type: boolean isAdmin: type: boolean entity: properties: code: type: string type: type: string type: object type: object SpaceMembersPutMemberForm: properties: isAdmin: type: boolean description: |- The Space Administration settings of the user. - `true`: The member will be the Administrator of the Space. - `false`: The member will not be the Administrator of the Space. At least 1 Space Administrator is required to be set in the API call. If ignored, this value is false. includeSubs: type: boolean description: |- The "Include Affiliated Departments" settings of the department. - `true`: Affiliated departments will be included. - `false`: Affiliated departments will not be included. If ignored, this value is false. entity: properties: code: type: string description: The code of the entity. type: enum: - USER - GROUP - ORGANIZATION type: string description: |- The entity type of the Space member. - **USER**: User - **Group**: Group - **ORGANIZATION**: Department required: - code - type type: object description: |- The entity information of the Space member. Guest users cannot be specified. required: - entity type: object SpacesStatisticsGetSpaceForm: properties: createdAt: format: date-time type: string creator: properties: code: type: string name: type: string type: object isGuest: type: boolean modifiedAt: format: date-time type: string memberCount: format: int64 type: integer modifier: properties: code: type: string name: type: string type: object name: type: string id: format: int64 type: integer isPrivate: type: boolean administratorCount: format: int64 type: integer type: object SpaceThreadCommentPostFileForm: properties: width: type: string description: |- A width can be specified if the attachment file is an image. The minimum is 100, and the maximum is 750. If this parameter is ignored, the original width will be set (this width is the same size as the size when "Original" is chosen when adding an image to a thread via GUI). This parameter is ignored if the file is not an image. fileKey: type: string description: |- The fileKey of the attachment file. fileKeys can be found from the response of the Upload File API. For more information, refer to the following article: [Upload File](https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/) required: - fileKey type: object SpaceThreadCommentPostMentionForm: properties: code: type: string description: |- The code of the user, group or department that will be mentioned. The maximum number of mentions is 10. The mentioned users will be placed in front of the comment text in the output. type: enum: - USER - ORGANIZATION - GROUP type: string description: |- The entity type of the mentioned target. - **USER**: User - **GROUP**: Group - **ORGANIZATION**: Department required: - code - type type: object StatusAssigneeSimpleValue: type: object properties: type: type: string enum: - STATUS_ASSIGNEE value: type: array items: $ref: '#/components/schemas/UserEntitySimpleValue' required: - value - type description: Assignee (Assignee of the process management status) example: type: STATUS_ASSIGNEE value: - code: john-d name: John Doe StatusSimpleValue: properties: type: type: string enum: - STATUS value: type: string type: object required: - type description: Status (Process management status) example: type: STATUS value: Not started TemplateSpacePostMemberForm: properties: isAdmin: type: boolean description: |- The Space Administration settings of the user. - `true`: The member will be the Administrator of the Space. - `false`: The member will not be the Administrator of the Space. At least 1 Space Administrator is required to be set in the API call. If ignored, this value is `false`. includeSubs: type: boolean description: |- The "**Include Affiliated Departments**" settings of the department. - `true`: Affiliated departments will be included. - `false`: Affiliated departments will not be included. If ignored, this value is `false`. entity: properties: code: type: string description: The code of the entity. type: enum: - USER - GROUP - ORGANIZATION type: string description: |- The entity type of the Space member. - **USER**: User - **Group**: Group - **ORGANIZATION**: Department required: - code - type type: object description: |- The entity information of the Space member. Guest users cannot be specified. required: - entity type: object TimeSimpleValue: properties: type: type: string enum: - TIME value: type: string nullable: true type: object required: - type description: Time example: type: TIME value: '09:00' UserEntitySimpleValue: properties: code: type: string name: type: string required: - code type: object UserSelectSimpleValue: properties: type: type: string enum: - USER_SELECT value: items: $ref: '#/components/schemas/UserEntitySimpleValue' type: array required: - value - type type: object description: User selection example: type: USER_SELECT value: - code: john-d name: John Doe - code: jane-r name: Jane Roe