Other Objects

AutoNumberFormat Object

fill
string

Indicates zero-padding. Must be between 0 and 10 "0" (zero) characters.

prefix
string

The prefix. Can include the date tokens:

  • {DD}
  • {MM}
  • {YY}
  • {YYYY}
startingNumber
number

The starting number for the auto-id.

suffix
string

The suffix. Can include the date tokens:

  • {DD}
  • {MM}
  • {YY}
  • {YYYY}
{
  • "fill": "string",
  • "prefix": "string",
  • "startingNumber": 0,
  • "suffix": "string"
}

BulkItemFailure Object

rowId
number Nullable

The Id of the row that failed. Applicable only to bulk row operations.

object

The error caused by the failed item.

index
number

The index of the failed item in the bulk request array.

{
  • "rowId": 0,
  • "error": {
    },
  • "index": 0
}

ContainerDestination Object

destinationId
number

The Id of the destination container (when copying or moving a sheet or a folder). Required if destinationType is "folder" or "workspace". If destinationType is "home", this value must be null.

destinationType
string Nullable
Enum: "folder" "home" "workspace"

Type of the destination container.

newName
string

Name of the newly created object (when creating a copy of a dashboard, folder, sheet, or workspace). This attribute is not supported for "move" operations.

{
  • "destinationId": 0,
  • "destinationType": "folder",
  • "newName": "string"
}

Currency Object

code
string

The ISO 4217 currency code.

symbol
string

The currency symbol.

{
  • "code": "EUR",
  • "symbol": "€"
}

Error Object

refId
string

The Id of the specific error occurrence. Please include this information when contacting Smartsheet support.

errorCode
number

Custom error code from Smartsheet. See the complete Error Code List.

message
string

Descriptive error message.

{
  • "refId": "string",
  • "errorCode": 0,
  • "message": "string"
}

FontFamily Object

name
string

Name of the font family.

traits
Array of strings
Items Enum: "sans-serif" "serif"

Platform-independent traits of the font family. Contains one of the listed enum values.

{
  • "name": "Arial",
  • "traits": [
    ]
}

FormatTables Object

defaults
string

A format descriptor where each element describes the formats the Smartsheet Web app displays for format values that have not been set. Each value refers to an index of the following options.

bold
Array of strings
color
Array of strings

The default setting is "none". Typically this is black text and a white background.

Array of objects
dateFormat
Array of strings
decimalCount
Array of strings
Array of objects
fontSize
Array of strings
horizontalAlign
Array of strings

The default setting is "default" which is equivalent to "left".

italic
Array of strings
numberFormat
Array of strings
strikethrough
Array of strings
textWrap
Array of strings
thousandsSeparator
Array of strings
underline
Array of strings
verticalAlign
Array of strings

The default setting is "default" which is equivalent to "top".

{
  • "defaults": ",,1,1,,,,,,,,,,,,,",
  • "bold": [
    ],
  • "color": [
    ],
  • "currency": [
    ],
  • "dateFormat": [
    ],
  • "decimalCount": [
    ],
  • "fontFamily": [
    ],
  • "fontSize": [
    ],
  • "horizontalAlign": [
    ],
  • "italic": [
    ],
  • "numberFormat": [
    ],
  • "strikethrough": [
    ],
  • "textWrap": [
    ],
  • "thousandsSeparator": [
    ],
  • "underline": [
    ],
  • "verticalAlign": [
    ]
}

IndexResult Object

pageNumber
number

The current page in the full result set that the data array represents. NOTE when a page number greater than totalPages is requested, the last page is instead returned.

pageSize
number Nullable

The number of items in a page. Omitted if there is no limit to page size (and hence, all results are included). Unless otherwise specified, this defaults to 100 for most endpoints.

totalPages
number

The total number of pages in the full result set.

totalCount
number

The total number of items in the full result set.

{
  • "pageNumber": 1,
  • "pageSize": 50,
  • "totalPages": 25,
  • "totalCount": 136
}

Result Object

version
number Nullable

New version of the sheet. Applicable only for operations which update sheet data.

Array of objects Nullable

Array of BulkItemFailure objects which represents the items that failed to be added or updated. See Partial Success for more information. Applicable only for bulk operations that support partial success.

message
string
Enum: "PARTIAL_SUCCESS" "SUCCESS"

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode
number
Enum: 0 3
  • '0' Success
  • '3' Partial Success of Bulk Operation
{
  • "version": 0,
  • "failedItems": [
    ],
  • "message": "SUCCESS",
  • "resultCode": 0
}
➔ Next to Contacts Basics