Skip to content

Commit 626028b

Browse files
committed
add auth portion
1 parent b69cf62 commit 626028b

File tree

1 file changed

+32
-25
lines changed

1 file changed

+32
-25
lines changed

docs/embedded/tutorials/metadata.md

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: SharePoint Embedded Container Metadata
3-
description: Add metadata in Containers and Files
3+
description: Add metadata in Containers and Files.
44
ms.date: 3/22/2024
55
ms.localizationpriority: high
66
---
77

8-
# Using Metadata on Containers and Files
8+
# Using Metadata with SharePoint Embedded Containers
99

1010
In SharePoint Embedded, columns can be added to [Containers](../concepts/app-concepts/containertypes.md) to address scenarios requiring custom metadata via Graph APIs. Content in the container can then set desired values for corresponding metadata. Metadata are schematized and can be queried. Note the APIs to create and manage columns are on container instances level – an application is responsible for defining and managing the columns across its containers.
1111

@@ -14,8 +14,8 @@ In SharePoint Embedded, columns can be added to [Containers](../concepts/app-con
1414
1. [Authorization and Authentication](#authorization-and-authentication)
1515
1. [Limitations](#limitations)
1616
1. [POST: Create a column in a fileStorageContainer](#create-a-column-in-a-filestoragecontainer)
17-
1. [GET: Get a column in a fileStorageContainer by id](#get-a-column-in-a-filestoragecontainer-by-id)
18-
1. [PATCH: Update a column in a fileStorageContainer by id](#update-a-column-in-a-filestoragecontainer-by-id)
17+
1. [GET: Get a column in a fileStorageContainer by ID](#get-a-column-in-a-filestoragecontainer-by-id)
18+
1. [PATCH: Update a column in a fileStorageContainer by ID](#update-a-column-in-a-filestoragecontainer-by-id)
1919
1. [DELETE: Delete a column from a fileStorageContainer](#delete-a-column-from-a-filestoragecontainer)
2020
1. [GET: List columns in a fileStorageContainer](#list-columns-in-a-filestoragecontainer)
2121
1. [GET: Get column values of an item in a fileStorageContainer's drive](#get-column-values-of-an-item-in-a-filestoragecontainers-drive)
@@ -28,16 +28,20 @@ In SharePoint Embedded, columns can be added to [Containers](../concepts/app-con
2828

2929
App+User (Delegated) or App-only (Application) Bearer {token} is required in Authorization header.
3030

31+
> [!NOTE]
32+
> Container owners can Create, Update and Delete Container columns
33+
> All Container member can Read and List Container columns
34+
3135
### `microsoft.graph.fileStorageContainer` properties
3236

3337
| Property | Type | Description | Key | Required | ReadOnly |
3438
| -------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------- | --- | -------- | -------- |
3539
| `id` | `Edm.String` | unique stable identifier of the storage container instance | Yes | Yes | Yes |
3640
| `displayName` | `Edm.String` | display name of the container | No | Yes | No |
3741
| `description` | `Edm.String` | description of the container | No | No | No |
38-
| `containerTypeId` | `Edm.Guid` | container type id | No | Yes | Yes |
42+
| `containerTypeId` | `Edm.Guid` | container type ID | No | Yes | Yes |
3943
| `containerTypeDisplayName` | `Edm.String` | display name of the container type | No | No | Yes |
40-
| `externalGroupId` | `Edm.Guid` | external group id | No | No | No |
44+
| `externalGroupId` | `Edm.Guid` | external group ID | No | No | No |
4145
| `permissions` | `Collection<microsoft.graph.permission>` | permissions of users / groups in the container | No | No | No |
4246
| `customProperties` | `microsoft.graph.fileStorageContainerCustomPropertyDictionary` | custom properties | No | No | No |
4347
| `viewpoint` | `microsoft.graph.fileStorageContainerViewpoint` | data that is specific to the current user | No | No | No |
@@ -64,7 +68,7 @@ The following are the properties that SharePoint Embedded Metadata supports:
6468
| dateTime | dateTimeColumn |
6569
| hyperlinkOrPicture | hyperlinkOrPictureColumn |
6670
| isDeletable | Boolean |
67-
| id | string |
71+
| ID | string |
6872
| indexed | Boolean |
6973
| isSealed | Boolean |
7074
| name | string |
@@ -80,20 +84,20 @@ The following are the properties that SharePoint Embedded Metadata supports:
8084
### Column Naming Conventions
8185

8286
Column Names must adhere to the following rules:
83-
- Cannot contain "!".
84-
- Cannot start with a digit, period, minus sign or question mark.
85-
- Cannot contain any space or any non-alphanumeric characters except "_" or "\".
86-
- Cannot look like either type of cell reference.
87-
- A1 mode cell reference with 1 to 3 characters followed by 1 to 5 digits (e.g. A3 F02563, ZZZ12).
87+
- Can't contain "!".
88+
- Can't start with a digit, period, minus sign or question mark.
89+
- Can't contain any space or any nonalphanumeric characters except "_" or "\".
90+
- Can't look like either type of cell reference.
91+
- A1 mode cell reference with 1 to 3 characters followed by 1 to 5 digits (for example, A3 F02563, ZZZ12).
8892
- R1C1 mode cell references that look like r, or c, or r[#], c[#] or r[#]c[#].
89-
- Cannot be any localized word for "true" or "false".
90-
- Cannot be specific names, including "Author", "Created", "Description", etc.
93+
- Can't be any localized word for "true" or "false".
94+
- Can't be specific names, including "Author", "Created", "Description", etc.
9195

9296

9397

9498
## Create a column in a fileStorageContainer
9599

96-
This API will let callers create a new column instance in a fileStorageContainer.
100+
This API lets callers create a new column instance in a fileStorageContainer.
97101

98102
##### Required permissions (at least one of)
99103

@@ -125,6 +129,8 @@ Content-Type: application/json
125129
}
126130
}
127131
```
132+
> [!NOTE]
133+
> Note Type is not supported. `maxLength` should =< 255.
128134
129135
##### Response
130136

@@ -149,9 +155,9 @@ Content-type: application/json
149155
}
150156
```
151157

152-
## Get a column in a fileStorageContainer by id
158+
## Get a column in a fileStorageContainer by ID
153159

154-
This API will let callers get a fileStorageContainer column instance by id.
160+
This API lets callers get a fileStorageContainer column instance by ID.
155161

156162
##### Required permissions (at least one of)
157163

@@ -160,7 +166,7 @@ This API will let callers get a fileStorageContainer column instance by id.
160166
| FileStorageContainer.Selected | Application |
161167
| FileStorageContainer.Selected | Delegated |
162168

163-
#### REST Operation example: get a column in a fileStorageContainer by id
169+
#### REST Operation example: get a column in a fileStorageContainer by ID
164170

165171
##### Request
166172

@@ -191,9 +197,9 @@ Content-type: application/json
191197
}
192198
```
193199

194-
## Update a column in a fileStorageContainer by id
200+
## Update a column in a fileStorageContainer by ID
195201

196-
This API will let callers update a fileStorageContainer column instance by id.
202+
This API lets callers update a fileStorageContainer column instance by ID.
197203
You can update any property of the column other than the **id** property.
198204

199205
##### Required permissions (at least one of)
@@ -203,7 +209,7 @@ You can update any property of the column other than the **id** property.
203209
| FileStorageContainer.Selected | Application |
204210
| FileStorageContainer.Selected | Delegated |
205211

206-
#### REST Operation example: update a column in a fileStorageContainer by id
212+
#### REST Operation example: update a column in a fileStorageContainer by ID
207213

208214
##### Request
209215

@@ -213,7 +219,8 @@ Content-Type: application/json
213219
214220
{
215221
"required": true,
216-
"hidden": false
222+
"hidden": false,
223+
"description": "This is my new column description"
217224
}
218225
```
219226

@@ -244,7 +251,7 @@ Content-type: application/json
244251

245252
## Delete a column from a fileStorageContainer
246253

247-
This API will let callers delele a fileStorageContainer column instance by id.
254+
This API lets callers delete a fileStorageContainer column instance by ID.
248255

249256
##### Required permissions (at least one of)
250257

@@ -269,7 +276,7 @@ HTTP/1.1 204 No Content
269276

270277
## List columns in a fileStorageContainer
271278

272-
This API will let callers enumerate the columns in a fileStorageContainer.
279+
This API lets callers enumerate the columns in a fileStorageContainer.
273280

274281
##### Required permissions (at least one of)
275282

@@ -448,7 +455,7 @@ Content-type: application/json
448455

449456
## Query a fileStorageContainer's driveitems with Odata query options on custom columns
450457

451-
This API will let users query drive items in a fileStorageContainer with `$expand`, `$filter`, and `$orderby` Odata query options on their custom columns.
458+
This API lets users query drive items in a fileStorageContainer with `$expand`, `$filter`, and `$orderby` Odata query options on their custom columns.
452459

453460
##### Required permissions (at least one of)
454461

0 commit comments

Comments
 (0)