Skip to main content

Section

A content block within an accord's summary (or a playbook); type says which kind it is and how data is shaped.

type Section implements Node {
  nodeId: ID!
  id: String!
  workspaceId: String!
  playbookId: String
  summaryId: String
  order: BigFloat!
  type: String!
  title: String
  data: JSON
  createdByWorkspaceAccountId: String
  version: Int!
  deletedAt: Datetime
  updatedAt: Datetime!
  createdAt: Datetime!
  internal: Boolean!
  summary: Summary
  playbook: Playbook
  workspace: Workspace
  createdByWorkspaceAccount: WorkspaceAccount
  commentsConnection(
    first: Int
    last: Int
    offset: Int
    before: Cursor
    after: Cursor
    orderBy: [CommentsOrderBy!] = [PRIMARY_KEY_ASC]
    condition: CommentCondition
    filter: CommentFilter
  ): CommentsConnection!
  comments(
    first: Int
    offset: Int
    orderBy: [CommentsOrderBy!]
    condition: CommentCondition
    filter: CommentFilter
  ): [Comment!]!
  sectionPickListItemsConnection(
    first: Int
    last: Int
    offset: Int
    before: Cursor
    after: Cursor
    orderBy: [SectionPickListItemsOrderBy!] = [PRIMARY_KEY_ASC]
    condition: SectionPickListItemCondition
    filter: SectionPickListItemFilter
  ): SectionPickListItemsConnection!
  sectionPickListItems(
    first: Int
    offset: Int
    orderBy: [SectionPickListItemsOrderBy!]
    condition: SectionPickListItemCondition
    filter: SectionPickListItemFilter
  ): [SectionPickListItem!]!
}

Fields​

Section.nodeId ● ID! non-null scalar​

A globally unique identifier. Can be used in various places throughout the system to identify this single value.

Section.id ● String! non-null scalar​

Section.workspaceId ● String! non-null scalar​

Section.playbookId ● String scalar​

When set, the playbook (template) this section belongs to rather than a live accord's summary.

Section.summaryId ● String scalar​

The summary this section belongs to.

Section.order ● BigFloat! non-null scalar​

Sort position of the section within its summary or playbook.

Section.type ● String! non-null scalar​

The kind of section, which determines how data is interpreted: rich-text, pick-list, resource, embed-url, reportable-table, or intro. text is a legacy value that the copy paths still accept but nothing creates.

Section.title ● String scalar​

Section.data ● JSON scalar​

JSON payload holding the section's type-specific content.

Section.createdByWorkspaceAccountId ● String scalar​

Section.version ● Int! non-null scalar​

Section.deletedAt ● Datetime scalar​

Section.updatedAt ● Datetime! non-null scalar​

Section.createdAt ● Datetime! non-null scalar​

Section.internal ● Boolean! non-null scalar​

When true, the section is visible only to the internal seller side, not the customer.

Section.summary ● Summary object​

Reads a single Summary that is related to this Section.

Section.playbook ● Playbook object​

Reads a single Playbook that is related to this Section.

Section.workspace ● Workspace object​

Reads a single Workspace that is related to this Section.

Section.createdByWorkspaceAccount ● WorkspaceAccount object​

Reads a single WorkspaceAccount that is related to this Section.

Section.commentsConnection ● CommentsConnection! non-null object​

Reads and enables pagination through a set of Comment.

Section.commentsConnection.first ● Int scalar​

Only read the first n values of the set.

Section.commentsConnection.last ● Int scalar​

Only read the last n values of the set.

Section.commentsConnection.offset ● Int scalar​

Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.

Section.commentsConnection.before ● Cursor scalar​

Read all values in the set before (above) this cursor.

Section.commentsConnection.after ● Cursor scalar​

Read all values in the set after (below) this cursor.

Section.commentsConnection.orderBy ● [CommentsOrderBy!] list enum​

The method to use when ordering Comment.

Section.commentsConnection.condition ● CommentCondition input​

A condition to be used in determining which values should be returned by the collection.

Section.commentsConnection.filter ● CommentFilter input​

A filter to be used in determining which values should be returned by the collection.

Section.comments ● [Comment!]! non-null object​

Reads and enables pagination through a set of Comment.

Section.comments.first ● Int scalar​

Only read the first n values of the set.

Section.comments.offset ● Int scalar​

Skip the first n values.

Section.comments.orderBy ● [CommentsOrderBy!] list enum​

The method to use when ordering Comment.

Section.comments.condition ● CommentCondition input​

A condition to be used in determining which values should be returned by the collection.

Section.comments.filter ● CommentFilter input​

A filter to be used in determining which values should be returned by the collection.

Section.sectionPickListItemsConnection ● SectionPickListItemsConnection! non-null object​

Reads and enables pagination through a set of SectionPickListItem.

Section.sectionPickListItemsConnection.first ● Int scalar​

Only read the first n values of the set.

Section.sectionPickListItemsConnection.last ● Int scalar​

Only read the last n values of the set.

Section.sectionPickListItemsConnection.offset ● Int scalar​

Skip the first n values from our after cursor, an alternative to cursor based pagination. May not be used with last.

Section.sectionPickListItemsConnection.before ● Cursor scalar​

Read all values in the set before (above) this cursor.

Section.sectionPickListItemsConnection.after ● Cursor scalar​

Read all values in the set after (below) this cursor.

Section.sectionPickListItemsConnection.orderBy ● [SectionPickListItemsOrderBy!] list enum​

The method to use when ordering SectionPickListItem.

Section.sectionPickListItemsConnection.condition ● SectionPickListItemCondition input​

A condition to be used in determining which values should be returned by the collection.

Section.sectionPickListItemsConnection.filter ● SectionPickListItemFilter input​

A filter to be used in determining which values should be returned by the collection.

Section.sectionPickListItems ● [SectionPickListItem!]! non-null object​

Reads and enables pagination through a set of SectionPickListItem.

Section.sectionPickListItems.first ● Int scalar​

Only read the first n values of the set.

Section.sectionPickListItems.offset ● Int scalar​

Skip the first n values.

Section.sectionPickListItems.orderBy ● [SectionPickListItemsOrderBy!] list enum​

The method to use when ordering SectionPickListItem.

Section.sectionPickListItems.condition ● SectionPickListItemCondition input​

A condition to be used in determining which values should be returned by the collection.

Section.sectionPickListItems.filter ● SectionPickListItemFilter input​

A filter to be used in determining which values should be returned by the collection.

Interfaces​

Node interface​

An object with a globally unique ID.

Returned By​

section query ● sectionByNodeId query ● sections query

Member Of​

Comment object ● CopySectionToSummaryPayload object ● CreateCommentPayload object ● CreateSectionPayload object ● CreateSectionPickListItemPayload object ● CreationSectionTypePayload object ● DeleteCommentPayload object ● DeleteSectionPayload object ● DeleteSectionPickListItemPayload object ● Playbook object ● RecoverCommentPayload object ● RecoverSectionPayload object ● RecoverSectionPickListItemPayload object ● SectionPickListItem object ● SectionsConnection object ● SectionsEdge object ● Summary object ● UpdateCommentPayload object ● UpdateSectionPayload object ● UpdateSectionPickListItemPayload object ● UpsertSectionPayload object ● Workspace object ● WorkspaceAccount object