SMsmartsheet
crossSheetReferences

Get cross-sheet reference

Gets the cross-sheet reference specified in the URL.

get/sheets/{sheetId}/crosssheetreferences/{crossSheetReferenceId}

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: READ_SHEETS

Response

CrossSheetReference object

endColumnIdnumber

Defines ending edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.

endRowIdnumber

Defines ending edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.

idnumber

Cross-sheet reference ID, guaranteed unique within referencing sheet.

namestring

Friendly name of reference. Auto-generated unless specified in Create Cross-sheet References.

startColumnIdnumber

Defines beginning edge of range when specifying one or more columns. To specify an entire column, omit the startRowId and endRowId parameters.

startRowIdnumber

Defines beginning edge of range when specifying one or more rows. To specify an entire row, omit the startColumnId and endColumnId parameters.

status'BLOCKED' | 'BROKEN' | 'CIRCULAR' | 'DISABLED' | 'INVALID/UNKNOWN' | 'NOT-SHARED' | 'OK'

Status of request:

  • 'BLOCKED' - A reference is downstream of a circular issue.
  • 'BROKEN' - The data source location (column, row or sheet) was deleted.
  • 'CIRCULAR' - The formula reference is self referencing and cannot be resolved.
  • 'DISABLED' - Updating the reference is temporarily disabled due to maintenance.
  • 'INVALID/UNKNOWN' - The reference is new and had not been validated.
  • 'NOT_SHARED' - No common shared users.
  • 'OK' - The reference is in a good state.
sourceSheetIdnumber

Sheet ID of source sheet.

Changes

No recorded changes to this operation across all 16 revisions of this API.