Skip to content

parent.md

Latest commit

 

History

History
37 lines (27 loc) · 1.3 KB

parent.md

File metadata and controls

37 lines (27 loc) · 1.3 KB
Raw

Parent

A Parent object represents the parent of a page, database, or block. The parent can be a workspace, page, database, or block.

This model accepts additional fields of type Object.

Structure

Parent

Fields

Name Type Tags Description
type Type Required The type of parent.
database_id UUID | String Optional The ID of the parent database. Present when type is "database_id".
page_id UUID | String Optional The ID of the parent page. Present when type is "page_id".
block_id UUID | String Optional The ID of the parent block. Present when type is "block_id".
workspace TrueClass | FalseClass Optional Always true when the parent is the workspace. Present when type is "workspace".
additional_properties Hash[String, Object] Optional -

Example

parent = Parent.new(
  type: Type::BLOCK_ID,
  database_id: '000015f2-0000-0000-0000-000000000000',
  page_id: '00001234-0000-0000-0000-000000000000',
  block_id: '00001a0c-0000-0000-0000-000000000000',
  workspace: false,
  additional_properties: {
    'exampleAdditionalProperty' => JSON.parse('{"key1":"val1","key2":"val2"}')
  }
)