Smartsheet

Use the @bijection/connectors/smartsheet entrypoint to declare Smartsheet resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Rows	`pull`	Whole-sheet rows by column id, no withdrawal

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Rows

pull: Whole-sheet rows by column id, no withdrawal

The following example matches configuration standard.

import { smartsheet } from "@bijection/connectors/smartsheet";
export const tracker = smartsheet.rows.pull({
  sheet: "6141831453927300",
  columns: { status: "2517104256673668", owner: "7020703884044164" },
});

Inferred record types

Resource without an operational record table

Configuration: standard

Case: smartsheet/rows/pull/standard. Connection and resource configuration are declared by this exact case. Credential kind: smartsheet. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`region`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "smartsheet",
    "output": {
      "kind": "single",
      "collection": "rows"
    },
    "credential_kind": "smartsheet",
    "connection_fields": [
      "region"
    ],
    "address": {
      "kind": "setup",
      "field": "region",
      "prefix": "https://api.smartsheet."
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "region": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: rows

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "sheet": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange sheet",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "rows": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "sheet": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange sheet",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“rows”}	Declared from Smartsheet’s published OpenAPI reference; no check has run it against Smartsheet or qualified it.	Execution result unavailable
identity-account	{“kind”:“connection”}	Declared from Smartsheet’s published OpenAPI reference; no check has run it against Smartsheet or qualified it.	Execution result unavailable

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. A read-only source of one sheet’s rows. Nothing here adds or updates a row: Smartsheet’s row update takes no precondition, so no write is declared. The connection selects the region (region: com, eu or au, for https://api.smartsheet.<region>) and holds a smartsheet bearer credential (smartsheet.credential). Identity is the user id from GET /2.0/users/me. rows.pull reads GET /2.0/sheets/<sheet>?columnIds=<ids> once per pass, with no page or pageSize. Columns are named by id, never by title, because a title can be renamed; each declared field publishes the cell’s raw value (string, number or boolean, null when the cell is empty) and <field>Display publishes its displayValue. Dates arrive as ISO-8601 strings. The read refuses a response whose row count differs from its own totalRowCount, and a response missing a declared column. The read claims no coverage, so a deleted row is not withdrawn: no response field states that the enumeration finished, and Smartsheet answers every missing object with the same 404 / 1006 Not Found, which does not separate a deleted row from a deleted or unreachable sheet. Rows carry no version. Ids are JSON numbers. Row keys are read exactly by the host; the published rowId is decimal text, and an id beyond 2^53 is refused rather than rounded (the reference’s own example user id is beyond it). Smartsheet limits 300 requests per minute per token and answers 429 with errorCode: 4003 without stating a wait, so a 429 fails the pass as transient and no backoff signal is declared. Declared from Smartsheet’s published OpenAPI reference; nothing here has run against Smartsheet or been qualified.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Availability

Resources and modes

Rows

pull: Whole-sheet rows by column id, no withdrawal

Configuration: standard

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Rows

​pull: Whole-sheet rows by column id, no withdrawal

​Configuration: standard

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Rows

pull: Whole-sheet rows by column id, no withdrawal

Configuration: standard

Provider guidance

Provider references

Source and evidence