RangeBorderCollection: ItemAt

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Gets a border object using its index

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Files.ReadWrite	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

HTTP request

GET /me/drive/items/{id}/workbook/names/{name}/range/format/borders/ItemAt(index={index})
GET /me/drive/root:/{item-path}:/workbook/names/{name}/range/format/borders/ItemAt(index={index})
GET /me/drive/items/{id}/workbook/worksheets/{id|name}/range(address='<address>')/format/borders/ItemAt(index={index})
GET /me/drive/root:/{item-path}:/workbook/worksheets/{id|name}/range(address='<address>')/format/borders/ItemAt(index={index})
GET /me/drive/items/{id}/workbook/tables/{id|name}/columns/{id|name}/range/format/borders/ItemAt(index={index})
GET /me/drive/root:/{item-path}:/workbook/tables/{id|name}/columns/{id|name}/range/format/borders/ItemAt(index={index})

Function parameters

The following table shows the parameters that can be used with this function.

Parameter	Type	Description
index	Int32	Index value of the object to be retrieved. Zero-indexed.

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Workbook-Session-Id	Workbook session Id that determines if changes are persisted or not. Optional.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns 200 OK response code and workbookRangeBorder object in the response body.

Example

Here is an example of how to call this API.

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/me/drive/items/{id}/workbook/names/{name}/range/format/borders/ItemAt(index=8)

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

let workbookRangeBorder = await client.api('/me/drive/items/{id}/workbook/names/{name}/range/format/borders/ItemAt(index=8)')
	.version('beta')
	.get();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response. Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "id-value",
  "color": "color-value",
  "style": "style-value",
  "sideIndex": "sideIndex-value",
  "weight": "weight-value"
}