> ## Documentation Index > Fetch the complete documentation index at: https://help.teable.ai/llms.txt > Use this file to discover all available pages before exploring further. # Copy selected table content by record and field ids > Copy content using record and field identifiers instead of row ranges. Required token scopes: `record|read`, `record|copy` ## OpenAPI ````yaml /swagger.json post /table/{tableId}/selection/copy-by-id openapi: 3.0.0 info: version: 1.0.0 title: Teable App description: Manage Data as easy as drink a cup of tea x-logo: backgroundColor: '#F0F0F0' altText: Teable logo servers: - url: https://app.teable.ai/api security: [] tags: - name: base x-group: project - name: base node x-group: project node - name: base-share x-group: project-share paths: /table/{tableId}/selection/copy-by-id: post: tags: - selection summary: Copy selected table content by record and field ids description: |- Copy content using record and field identifiers instead of row ranges. Required token scopes: `record|read`, `record|copy` parameters: - schema: type: string required: true name: tableId in: path requestBody: content: application/json: schema: type: object properties: viewId: type: string example: viwXXXXXXX description: >- Set the view you want to fetch. When provided, records will follow that view's filter and sort settings. When omitted, the API queries the table without applying a view. ignoreViewQuery: anyOf: - type: string - type: boolean description: >- When a viewId is specified, configure this to true will ignore the view's filter, sort, etc filterByTql: type: string example: '{field} = ''Completed'' AND {field} > 5' deprecated: true filter: type: string description: >- A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters. search: anyOf: - type: array items: type: string minItems: 1 maxItems: 1 - type: array items: type: string minItems: 2 maxItems: 2 - type: array items: anyOf: - type: string - anyOf: - type: string - type: boolean minItems: 3 maxItems: 3 default: - searchValue - fieldIdOrName - false description: Search for records that match the specified field and value filterLinkCellCandidate: anyOf: - type: array items: type: string minItems: 2 maxItems: 2 - type: string example: - fldXXXXXXX - recXXXXXXX description: >- Filter out the records that can be selected by a given link cell from the relational table. For example, if the specified field is one to many or one to one relationship, recordId for which the field has already been selected will not appear. filterLinkCellSelected: anyOf: - type: array items: type: string minItems: 2 maxItems: 2 - type: string example: - fldXXXXXXX - recXXXXXXX description: >- Filter out selected records based on this link cell from the relational table. Note that viewId, filter, and orderBy will not take effect in this case because selected records has it own order. Ignoring recordId gets all the selected records for the field selectedRecordIds: type: array items: type: string description: Filter selected records by record ids orderBy: type: string description: >- An array of sort objects that specifies how the records should be ordered. groupBy: type: string description: >- An array of group objects that specifies how the records should be grouped. collapsedGroupIds: type: string description: >- An array of group ids that specifies which groups are collapsed queryId: type: string example: qry_xxxxxxxx description: >- When provided, other query parameters will be merged with the saved ones. includeQueryExtra: anyOf: - type: string - type: boolean description: >- Whether to include query extra metadata such as group points and search hit indexes. Group metadata defaults to enabled; optimized generated-index searches require explicit opt-in for search hit indexes. projection: type: array items: type: string description: >- Visible field ids for query-scoped field selection. If omitted, all visible view fields are used. selection: type: object properties: recordIds: type: array items: type: string description: >- Explicit selected record ids. If omitted, records are resolved from the current query scope. An empty array means no existing records are selected. excludeRecordIds: type: array items: type: string description: >- Record ids to exclude from the current query scope, for inverse selections. fieldIds: type: array items: type: string minItems: 1 description: >- Explicit selected field ids. If omitted, fields are resolved from visible query fields. required: - selection responses: '200': description: Copy content content: application/json: schema: type: object properties: content: type: string header: type: array items: type: object properties: id: type: string description: The id of the field. name: type: string description: >- The name of the field. can not be duplicated in the table. example: Tags type: type: string enum: - singleLineText - longText - user - attachment - checkbox - multipleSelect - singleSelect - date - number - rating - formula - rollup - conditionalRollup - link - createdTime - lastModifiedTime - createdBy - lastModifiedBy - autoNumber - button description: The field types supported by teable. example: singleSelect description: type: string nullable: true description: The description of the field. example: this is a summary options: anyOf: - type: object properties: expression: type: string enum: - countall({values}) - counta({values}) - count({values}) - sum({values}) - average({values}) - max({values}) - min({values}) - and({values}) - or({values}) - xor({values}) - array_join({values}) - array_unique({values}) - array_compact({values}) - concatenate({values}) timeZone: type: string description: >- The time zone that should be used to format dates formatting: description: >- Different cell value types are determined based on the results of expression parsing showAs: anyOf: - type: object properties: type: type: string enum: - url - email - phone description: >- can display as email or phone in string field with a button to perform the corresponding action, send an email or start a phone call. "url" is deprecated: URLs inside text values are detected and rendered as links automatically required: - type additionalProperties: false - type: object properties: type: type: string enum: - bar - ring description: >- can display as bar or ring in number field with single cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 showValue: type: boolean description: >- whether to displays the specific value on the graph maxValue: type: number description: >- the value that represents a 100% maximum value, it does not represent a hard limit on the value required: - type - color - showValue - maxValue additionalProperties: false - type: object properties: type: type: string enum: - bar - line description: >- can display as bar or line in number field with multiple cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 required: - type - color additionalProperties: false description: >- According to the results of expression parsing to determine different visual effects, where strings, numbers will provide customized "show as" required: - expression additionalProperties: false - type: object properties: expression: type: string enum: - countall({values}) - counta({values}) - count({values}) - sum({values}) - average({values}) - max({values}) - min({values}) - and({values}) - or({values}) - xor({values}) - array_join({values}) - array_unique({values}) - array_compact({values}) - concatenate({values}) timeZone: type: string description: >- The time zone that should be used to format dates formatting: description: >- Different cell value types are determined based on the results of expression parsing showAs: anyOf: - type: object properties: type: type: string enum: - url - email - phone description: >- can display as email or phone in string field with a button to perform the corresponding action, send an email or start a phone call. "url" is deprecated: URLs inside text values are detected and rendered as links automatically required: - type additionalProperties: false - type: object properties: type: type: string enum: - bar - ring description: >- can display as bar or ring in number field with single cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 showValue: type: boolean description: >- whether to displays the specific value on the graph maxValue: type: number description: >- the value that represents a 100% maximum value, it does not represent a hard limit on the value required: - type - color - showValue - maxValue additionalProperties: false - type: object properties: type: type: string enum: - bar - line description: >- can display as bar or line in number field with multiple cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 required: - type - color additionalProperties: false description: >- According to the results of expression parsing to determine different visual effects, where strings, numbers will provide customized "show as" baseId: type: string foreignTableId: type: string lookupFieldId: type: string filter: type: object description: >- A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters. sort: type: object properties: fieldId: type: string order: type: string enum: - asc - desc required: - fieldId - order limit: type: integer minimum: 0 exclusiveMinimum: true maximum: 5000 required: - expression additionalProperties: false - type: object properties: expression: type: string description: >- The formula including fields referenced by their IDs. For example, LEFT(4, {Birthday}) input will be returned as LEFT(4, {fldXXX}) via API. timeZone: type: string description: >- The time zone that should be used to format dates formatting: description: >- Different cell value types are determined based on the results of expression parsing showAs: anyOf: - type: object properties: type: type: string enum: - url - email - phone description: >- can display as email or phone in string field with a button to perform the corresponding action, send an email or start a phone call. "url" is deprecated: URLs inside text values are detected and rendered as links automatically required: - type additionalProperties: false - type: object properties: type: type: string enum: - bar - ring description: >- can display as bar or ring in number field with single cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 showValue: type: boolean description: >- whether to displays the specific value on the graph maxValue: type: number description: >- the value that represents a 100% maximum value, it does not represent a hard limit on the value required: - type - color - showValue - maxValue additionalProperties: false - type: object properties: type: type: string enum: - bar - line description: >- can display as bar or line in number field with multiple cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 required: - type - color additionalProperties: false description: >- According to the results of expression parsing to determine different visual effects, where strings, numbers will provide customized "show as" required: - expression additionalProperties: false - type: object properties: baseId: type: string description: >- the project id of the table that this field is linked to, only required for cross project link relationship: type: string enum: - oneOne - manyMany - oneMany - manyOne description: >- describe the relationship from this table to the foreign table foreignTableId: type: string description: the table this field is linked to lookupFieldId: type: string description: >- the field in the foreign table that will be displayed as the current field isOneWay: type: boolean description: >- whether the field is a one-way link, when true, it will not generate a symmetric field, it is generally has better performance fkHostTableName: type: string description: >- the table name for storing keys, in many-to-many relationships, keys are stored in a separate intermediate table; in other relationships, keys are stored on one side as needed selfKeyName: type: string description: >- the name of the field that stores the current table primary key foreignKeyName: type: string description: >- The name of the field that stores the foreign table primary key symmetricFieldId: type: string description: >- the symmetric field in the foreign table, empty if the field is a one-way link filterByViewId: type: string nullable: true description: >- the view id that limits the number of records in the link field visibleFieldIds: type: array nullable: true items: type: string description: >- the fields that will be displayed in the link field, the primary field is always visible even if omitted from this list filter: type: object description: >- A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters. required: - relationship - foreignTableId - lookupFieldId - fkHostTableName - selfKeyName - foreignKeyName additionalProperties: false - type: object properties: formatting: type: object properties: date: type: string description: >- the display formatting of the date. you can use the following presets: M/D/YYYY, D/M/YYYY, YYYY/MM/DD, YYYY-MM-DD, YYYY-MM, MM-DD, YYYY, MM, DD time: type: string enum: - HH:mm - hh:mm A - None description: >- the display formatting of the time. you can use the following presets: HH:mm, hh:mm A, None timeZone: type: string description: >- The time zone that should be used to format dates required: - date - time - timeZone description: >- caveat: the formatting is just a formatter, it dose not effect the storing value of the record defaultValue: type: string nullable: true enum: - now description: >- Whether the new row is automatically filled with the current time, caveat: the defaultValue is just a flag, it dose not effect the storing value of the record required: - formatting additionalProperties: false - type: object properties: defaultValue: type: boolean nullable: true additionalProperties: false - type: object properties: {} additionalProperties: false - type: object properties: showAs: type: object properties: type: type: string enum: - url - email - phone description: >- can display as email or phone in string field with a button to perform the corresponding action, send an email or start a phone call. "url" is deprecated: URLs inside text values are detected and rendered as links automatically required: - type description: >- Only be used in single line text field or formula / rollup field with cellValueType equals String and isMultipleCellValue is not true defaultValue: type: string nullable: true additionalProperties: false - type: object properties: showAs: type: object nullable: true properties: type: type: string enum: - markdown required: - type defaultValue: type: string nullable: true additionalProperties: false - type: object properties: icon: type: string enum: - star - moon - sun - zap - flame - heart - apple - thumb-up color: type: string enum: - yellowBright - redBright - tealBright max: type: integer maximum: 10 minimum: 1 required: - icon - color - max additionalProperties: false - type: object properties: isMultiple: type: boolean description: Allow adding multiple users shouldNotify: type: boolean description: >- Notify users when their name is added to a cell defaultValue: anyOf: - type: string - type: string enum: - me - type: array items: anyOf: - type: string - type: string enum: - me - nullable: true additionalProperties: false - type: object properties: {} additionalProperties: false - type: object properties: trackedFieldIds: type: array items: type: string additionalProperties: false - type: object properties: label: type: string description: Button label color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 description: Button color maxCount: type: number description: Max count of button clicks resetCount: type: boolean description: Reset count workflow: type: object nullable: true properties: id: type: string description: Workflow ID name: type: string description: Workflow Name isActive: type: boolean description: Workflow is active description: Workflow confirm: type: object nullable: true properties: title: type: string description: type: string confirmText: type: string description: Confirm config before click required: - label - color additionalProperties: false - type: object properties: expression: type: string enum: - countall({values}) - counta({values}) - count({values}) - sum({values}) - average({values}) - max({values}) - min({values}) - and({values}) - or({values}) - xor({values}) - array_join({values}) - array_unique({values}) - array_compact({values}) - concatenate({values}) timeZone: type: string description: >- The time zone that should be used to format dates formatting: description: >- Different cell value types are determined based on the results of expression parsing showAs: anyOf: - type: object properties: type: type: string enum: - url - email - phone description: >- can display as email or phone in string field with a button to perform the corresponding action, send an email or start a phone call. "url" is deprecated: URLs inside text values are detected and rendered as links automatically required: - type additionalProperties: false - type: object properties: type: type: string enum: - bar - ring description: >- can display as bar or ring in number field with single cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 showValue: type: boolean description: >- whether to displays the specific value on the graph maxValue: type: number description: >- the value that represents a 100% maximum value, it does not represent a hard limit on the value required: - type - color - showValue - maxValue additionalProperties: false - type: object properties: type: type: string enum: - bar - line description: >- can display as bar or line in number field with multiple cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 required: - type - color additionalProperties: false description: >- According to the results of expression parsing to determine different visual effects, where strings, numbers will provide customized "show as" baseId: type: string foreignTableId: type: string lookupFieldId: type: string filter: type: object description: >- A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters. sort: type: object properties: fieldId: type: string order: type: string enum: - asc - desc required: - fieldId - order limit: type: integer minimum: 0 exclusiveMinimum: true maximum: 5000 required: - expression additionalProperties: false - type: object properties: baseId: type: string description: >- the project id of the table that this field is linked to, only required for cross project link relationship: type: string enum: - oneOne - manyMany - oneMany - manyOne description: >- describe the relationship from this table to the foreign table foreignTableId: type: string description: the table this field is linked to lookupFieldId: type: string description: >- the field in the foreign table that will be displayed as the current field isOneWay: type: boolean description: >- whether the field is a one-way link, when true, it will not generate a symmetric field, it is generally has better performance fkHostTableName: type: string description: >- the table name for storing keys, in many-to-many relationships, keys are stored in a separate intermediate table; in other relationships, keys are stored on one side as needed selfKeyName: type: string description: >- the name of the field that stores the current table primary key foreignKeyName: type: string description: >- The name of the field that stores the foreign table primary key symmetricFieldId: type: string description: >- the symmetric field in the foreign table, empty if the field is a one-way link filterByViewId: type: string nullable: true description: >- the view id that limits the number of records in the link field visibleFieldIds: type: array nullable: true items: type: string description: >- the fields that will be displayed in the link field, the primary field is always visible even if omitted from this list filter: type: object description: >- A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters. required: - relationship - foreignTableId - lookupFieldId - fkHostTableName - selfKeyName - foreignKeyName additionalProperties: false - type: object properties: choices: type: array items: type: object properties: id: type: string name: type: string color: type: string required: - id - name - color defaultValue: anyOf: - type: string - type: array items: type: string - nullable: true preventAutoNewOptions: type: boolean required: - choices additionalProperties: false - type: object properties: formatting: oneOf: - type: object properties: precision: type: number maximum: 5 minimum: 0 type: type: string enum: - decimal required: - precision - type additionalProperties: false - type: object properties: precision: type: number maximum: 5 minimum: 0 type: type: string enum: - percent required: - precision - type additionalProperties: false - type: object properties: precision: type: number maximum: 5 minimum: 0 type: type: string enum: - currency symbol: type: string required: - precision - type - symbol additionalProperties: false description: >- Only be used in number field (number field or formula / rollup field with cellValueType equals Number showAs: anyOf: - type: object properties: type: type: string enum: - bar - ring description: >- can display as bar or ring in number field with single cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 showValue: type: boolean description: >- whether to displays the specific value on the graph maxValue: type: number description: >- the value that represents a 100% maximum value, it does not represent a hard limit on the value required: - type - color - showValue - maxValue additionalProperties: false - type: object properties: type: type: string enum: - bar - line description: >- can display as bar or line in number field with multiple cellValue value color: type: string enum: - blueLight2 - blueLight1 - blueBright - blue - blueDark1 - cyanLight2 - cyanLight1 - cyanBright - cyan - cyanDark1 - grayLight2 - grayLight1 - grayBright - gray - grayDark1 - greenLight2 - greenLight1 - greenBright - green - greenDark1 - orangeLight2 - orangeLight1 - orangeBright - orange - orangeDark1 - pinkLight2 - pinkLight1 - pinkBright - pink - pinkDark1 - purpleLight2 - purpleLight1 - purpleBright - purple - purpleDark1 - redLight2 - redLight1 - redBright - red - redDark1 - tealLight2 - tealLight1 - tealBright - teal - tealDark1 - yellowLight2 - yellowLight1 - yellowBright - yellow - yellowDark1 required: - type - color additionalProperties: false description: >- Only be used in number field (number field or formula / rollup field with cellValueType equals Number defaultValue: type: number nullable: true required: - formatting additionalProperties: false - type: object properties: expression: type: string enum: - AUTO_NUMBER() required: - expression additionalProperties: false - type: object properties: expression: type: string enum: - CREATED_TIME() formatting: type: object properties: date: type: string description: >- the display formatting of the date. you can use the following presets: M/D/YYYY, D/M/YYYY, YYYY/MM/DD, YYYY-MM-DD, YYYY-MM, MM-DD, YYYY, MM, DD time: type: string enum: - HH:mm - hh:mm A - None description: >- the display formatting of the time. you can use the following presets: HH:mm, hh:mm A, None timeZone: type: string description: >- The time zone that should be used to format dates required: - date - time - timeZone description: >- caveat: the formatting is just a formatter, it dose not effect the storing value of the record required: - expression - formatting additionalProperties: false - type: object properties: expression: type: string enum: - LAST_MODIFIED_TIME() default: LAST_MODIFIED_TIME() formatting: type: object properties: date: type: string description: >- the display formatting of the date. you can use the following presets: M/D/YYYY, D/M/YYYY, YYYY/MM/DD, YYYY-MM-DD, YYYY-MM, MM-DD, YYYY, MM, DD time: type: string enum: - HH:mm - hh:mm A - None description: >- the display formatting of the time. you can use the following presets: HH:mm, hh:mm A, None timeZone: type: string description: >- The time zone that should be used to format dates required: - date - time - timeZone description: >- caveat: the formatting is just a formatter, it dose not effect the storing value of the record trackedFieldIds: type: array items: type: string additionalProperties: nullable: true description: >- The configuration options of the field. The structure of the field's options depend on the field's type. meta: anyOf: - type: object properties: persistedAsGeneratedColumn: type: boolean default: false description: >- Whether this formula field is persisted as a generated column in the database. When true, the field value is computed and stored as a database generated column. - type: object properties: hasOrderColumn: type: boolean default: false description: >- Whether this link field has an order column for maintaining insertion order. When true, the field uses a separate order column to preserve the order of linked records. - nullable: true description: >- The metadata of the field. The structure of the field's meta depend on the field's type. Currently formula and link fields have meta. aiConfig: anyOf: - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - extraction sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - summary sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - translation sourceFieldId: type: string targetLanguage: type: string required: - modelKey - type - sourceFieldId - targetLanguage - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - improvement sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - customization prompt: type: string description: > The prompt to use for the AI operation, use {fieldId} to reference the field in the table, example: "Summarize the content of {fieldId} into 100 words" required: - modelKey - type - prompt - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - classification sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - customization prompt: type: string onlyAllowConfiguredOptions: type: boolean required: - modelKey - type - prompt - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - tag sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - customization prompt: type: string onlyAllowConfiguredOptions: type: boolean required: - modelKey - type - prompt - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string 'n': type: number minimum: 1 maximum: 10 size: type: string pattern: ^\d+x\d+$ quality: type: string enum: - low - medium - high aspectRatio: type: string pattern: ^\d+(?:\.\d+)?:\d+(?:\.\d+)?$ resolution: type: string enum: - 1K - 2K - 4K type: type: string enum: - imageGeneration sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string 'n': type: number minimum: 1 maximum: 10 size: type: string pattern: ^\d+x\d+$ quality: type: string enum: - low - medium - high aspectRatio: type: string pattern: ^\d+(?:\.\d+)?:\d+(?:\.\d+)?$ resolution: type: string enum: - 1K - 2K - 4K type: type: string enum: - imageCustomization prompt: type: string required: - modelKey - type - prompt - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - rating sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - customization prompt: type: string required: - modelKey - type - prompt - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - extraction sourceFieldId: type: string required: - modelKey - type - sourceFieldId - type: object properties: modelKey: type: string isAutoFill: type: boolean nullable: true attachPrompt: type: string type: type: string enum: - customization prompt: type: string required: - modelKey - type - prompt - nullable: true description: The AI configuration of the field. isLookup: type: boolean nullable: true description: >- Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table. isConditionalLookup: type: boolean nullable: true description: >- Whether this lookup field applies a conditional filter when resolving linked records. lookupOptions: anyOf: - type: object properties: isUnique: type: boolean description: >- Remove duplicate lookup values while preserving their type and first occurrence. baseId: type: string description: >- the project id of the table that this field is linked to, only required for cross project link relationship: type: string enum: - oneOne - manyMany - oneMany - manyOne description: >- describe the relationship from this table to the foreign table foreignTableId: type: string description: the table this field is linked to lookupFieldId: type: string description: >- the field in the foreign table that will be displayed as the current field fkHostTableName: type: string description: >- the table name for storing keys, in many-to-many relationships, keys are stored in a separate intermediate table; in other relationships, keys are stored on one side as needed selfKeyName: type: string description: >- the name of the field that stores the current table primary key foreignKeyName: type: string description: >- The name of the field that stores the foreign table primary key filterByViewId: type: string nullable: true description: >- Optional foreign view used to filter lookup candidates. visibleFieldIds: type: array nullable: true items: type: string description: >- Optional foreign fields shown when presenting lookup-linked records. isOneWay: type: boolean description: >- Whether the underlying relationship is stored as one-way. Present in some persisted lookup payloads. symmetricFieldId: type: string description: >- Optional symmetric link field id preserved on some lookup payloads for compatibility. filter: type: object description: >- A filter object for complex query conditions based on fields, operators, and values. Use our visual query builder at https://app.teable.ai/developer/tool/query-builder to build filters. linkFieldId: type: string description: >- The id of Linked record field to use for lookup required: - relationship - foreignTableId - lookupFieldId - fkHostTableName - selfKeyName - foreignKeyName - linkFieldId additionalProperties: false - type: object properties: isUnique: type: boolean description: >- Remove duplicate lookup values after filtering, sorting, and limiting records. baseId: type: string description: >- the project id of the table that this field is linked to, only required for cross project link foreignTableId: type: string description: the table this field is linked to lookupFieldId: type: string description: >- the field in the foreign table that will be displayed as the current field filter: type: object description: >- Filter to apply when resolving conditional lookup values. sort: type: object properties: fieldId: type: string description: >- The field in the foreign table used to order lookup records. order: type: string enum: - asc - desc description: >- Ordering direction to apply to the sorted field. required: - fieldId - order description: >- Optional sort configuration applied before aggregating lookup values. limit: type: integer minimum: 0 exclusiveMinimum: true maximum: 5000 description: >- Maximum number of matching records to include in the lookup result. required: - foreignTableId - lookupFieldId - filter additionalProperties: false - nullable: true description: field lookup options. notNull: type: boolean nullable: true description: Whether this field is not null. unique: type: boolean nullable: true description: Whether this field is not unique. isPrimary: type: boolean nullable: true description: Whether this field is primary field. isComputed: type: boolean nullable: true description: >- Whether this field is computed field, you can not modify cellValue in computed field. isPending: type: boolean nullable: true description: Whether this field's calculation is pending. computeMeta: type: object nullable: true properties: status: type: string enum: - idle - queued - running - failed estimatedComplexity: type: number estimatedDirtyRecords: type: number startedAt: type: string lastDurationMs: type: number lastError: type: object nullable: true properties: code: type: string message: type: string context: type: object additionalProperties: nullable: true required: - message required: - status description: >- Async computed activity for this field (formula/lookup/rollup recalculation status). hasError: type: boolean nullable: true description: >- Whether This field has a configuration error. Check the fields referenced by this field's formula or configuration. cellValueType: type: string enum: - string - number - boolean - dateTime description: The cell value type of the field. isMultipleCellValue: type: boolean nullable: true description: Whether this field has multiple cell value. dbFieldType: type: string enum: - TEXT - INTEGER - DATETIME - REAL - BLOB - JSON - BOOLEAN description: >- The field type of database that cellValue really store. dbFieldName: type: string minLength: 1 pattern: ^\w{0,63}$ description: >- Field(column) name in backend database. Limitation: 1-63 characters, can only contain letters, numbers and underscore, case sensitive, cannot be duplicated with existing db field name in the table. recordRead: type: boolean nullable: true description: >- Field record read permission. When set to false, reading records is denied. When true or not set, reading records is allowed. recordCreate: type: boolean nullable: true description: >- Field record create permission. When set to false, creating records is denied. When true or not set, creating records is allowed. required: - id - name - type - options - cellValueType - dbFieldType - dbFieldName required: - content - header security: - bearerAuth: [] x-codeSamples: - lang: Shell source: |- curl --request POST \ --url https://app.teable.ai/api/table/%7BtableId%7D/selection/copy-by-id \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \ --header 'content-type: application/json' \ --data '{"viewId":"viwXXXXXXX","ignoreViewQuery":"string","filterByTql":"{field} = '\''Completed'\'' AND {field} > 5","filter":"string","search":["searchValue","fieldIdOrName",false],"filterLinkCellCandidate":["fldXXXXXXX","recXXXXXXX"],"filterLinkCellSelected":["fldXXXXXXX","recXXXXXXX"],"selectedRecordIds":["string"],"orderBy":"string","groupBy":"string","collapsedGroupIds":"string","queryId":"qry_xxxxxxxx","includeQueryExtra":"string","projection":["string"],"selection":{"recordIds":["string"],"excludeRecordIds":["string"],"fieldIds":["string"]}}' - lang: JavaScript source: >- const url = 'https://app.teable.ai/api/table/%7BtableId%7D/selection/copy-by-id'; const options = { method: 'POST', headers: { Authorization: 'Bearer REPLACE_BEARER_TOKEN', 'content-type': 'application/json' }, body: '{"viewId":"viwXXXXXXX","ignoreViewQuery":"string","filterByTql":"{field} = \'Completed\' AND {field} > 5","filter":"string","search":["searchValue","fieldIdOrName",false],"filterLinkCellCandidate":["fldXXXXXXX","recXXXXXXX"],"filterLinkCellSelected":["fldXXXXXXX","recXXXXXXX"],"selectedRecordIds":["string"],"orderBy":"string","groupBy":"string","collapsedGroupIds":"string","queryId":"qry_xxxxxxxx","includeQueryExtra":"string","projection":["string"],"selection":{"recordIds":["string"],"excludeRecordIds":["string"],"fieldIds":["string"]}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } - lang: Node.js source: |- const http = require('https'); const options = { method: 'POST', hostname: 'app.teable.ai', port: null, path: '/api/table/%7BtableId%7D/selection/copy-by-id', headers: { Authorization: 'Bearer REPLACE_BEARER_TOKEN', 'content-type': 'application/json' } }; const req = http.request(options, function (res) { const chunks = []; res.on('data', function (chunk) { chunks.push(chunk); }); res.on('end', function () { const body = Buffer.concat(chunks); console.log(body.toString()); }); }); req.write(JSON.stringify({ viewId: 'viwXXXXXXX', ignoreViewQuery: 'string', filterByTql: '{field} = \'Completed\' AND {field} > 5', filter: 'string', search: ['searchValue', 'fieldIdOrName', false], filterLinkCellCandidate: ['fldXXXXXXX', 'recXXXXXXX'], filterLinkCellSelected: ['fldXXXXXXX', 'recXXXXXXX'], selectedRecordIds: ['string'], orderBy: 'string', groupBy: 'string', collapsedGroupIds: 'string', queryId: 'qry_xxxxxxxx', includeQueryExtra: 'string', projection: ['string'], selection: {recordIds: ['string'], excludeRecordIds: ['string'], fieldIds: ['string']} })); req.end(); - lang: Python source: >- import http.client conn = http.client.HTTPSConnection("app.teable.ai") payload = "{\"viewId\":\"viwXXXXXXX\",\"ignoreViewQuery\":\"string\",\"filterByTql\":\"{field} = 'Completed' AND {field} > 5\",\"filter\":\"string\",\"search\":[\"searchValue\",\"fieldIdOrName\",false],\"filterLinkCellCandidate\":[\"fldXXXXXXX\",\"recXXXXXXX\"],\"filterLinkCellSelected\":[\"fldXXXXXXX\",\"recXXXXXXX\"],\"selectedRecordIds\":[\"string\"],\"orderBy\":\"string\",\"groupBy\":\"string\",\"collapsedGroupIds\":\"string\",\"queryId\":\"qry_xxxxxxxx\",\"includeQueryExtra\":\"string\",\"projection\":[\"string\"],\"selection\":{\"recordIds\":[\"string\"],\"excludeRecordIds\":[\"string\"],\"fieldIds\":[\"string\"]}}" headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN", 'content-type': "application/json" } conn.request("POST", "/api/table/%7BtableId%7D/selection/copy-by-id", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8")) components: securitySchemes: bearerAuth: type: http scheme: bearer ````