Skip to contents

Get SharePoint list column definition for a single column

Source: R/sp_list.R
get_sp_list_column.Rd

get_sp_list_column() gets a list column definition for a single column specified by column name or ID.

Usage

get_sp_list_column(
  sp_list = NULL,
  column_name = NULL,
  column_id = NULL,
  ...,
  list_name = NULL,
  site_url = NULL,
  site = NULL,
  column_name_type = "name",
  call = caller_env()
)

Arguments

sp_list

A ms_list object. If supplied, list_name, list_id, site_url, site, drive_name, drive_id, drive, and any additional parameters passed to ... are all ignored.

column_name, column_id

Column name or ID to get a definition for.

...

Arguments passed on to get_sp_list

list_name,list_id

SharePoint List name or ID string.

keep

One of "visible" (default), "all", "editable", or "external" (non-internal fields). Argument determines if the returned list metadata includes read only columns or hidden columns. Only "all" requests hidden columns, which the Graph API omits by default, so "visible", "editable", and "external" never include hidden columns.

select

Optional character vector of columnDefinition properties to return, e.g. c("name", "displayName"), to reduce the size of the response. Must be one of the columnDefinition properties documented by the Graph API, including the column type properties such as "text" or "lookup". Properties required by keep are added: "hidden" for "all", "readOnly" for "editable", and "name" for "external". If NULL (default), the Graph API default properties are returned, except that keep = "all" requests every known columnDefinition property (and "hidden") because the API only returns hidden columns when a selection is made. A property that the package does not list is not returned by keep = "all".

drive_name,drive_id

SharePoint Drive name or ID passed to get_drive method for SharePoint site object.

drive

A ms_drive object. If drive is supplied, drive_name and drive_id are ignored.

filter

A string with an OData expression apply as a filter to the results. Learn more in the Microsoft Graph API documentation on using filter query parameters.

n

Maximum number of lists, plans, tasks, or other items to return. Defaults to NULL which sets n to Inf.

list_name

SharePoint List name. Optional if sp_list or list_id are provided.

site_url

A SharePoint site URL in the format "https://[tenant name].sharepoint.com/sites/[site name]". Any SharePoint item or document URL can also be parsed to build a site URL using the tenant and site name included in the URL.

site

A ms_site object. If site is supplied, site_url, site_name, and site_id are ignored.

column_name_type

"name" or "displayName". Used to match column ID so column_name must be unique if column_name_type = "displayName".

call

The execution environment of a currently running function, e.g. caller_env(). The function will be mentioned in error messages as the source of the error. See the call argument of abort() for more information.

Value

A named list with the columnDefinition resource for the matched column.

Details

See the Get columnDefinition Graph API documentation for more information.