Skip to content

Commit b8b9cc8

Browse files
Merge pull request #15 from Tools4ever-NIM/sblankenshipt4e-patch-1
Update README.md
2 parents 3db224c + 2c06af1 commit b8b9cc8

File tree

1 file changed

+49
-4
lines changed

1 file changed

+49
-4
lines changed

README.md

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,13 @@ This is a native rest connector. This repo is for additional tools specific to G
152152

153153

154154
## Custom Schemas
155-
If you need to import custom schema data into NIM you can extend the table schemas by adding a custom json file.
155+
### Schema Definition File
156+
If you need to import custom schema data into NIM you can extend the table schemas by adding a custom json file where the [SYSTEMNAME] is the name of your system within the NIM console.
156157

157-
C:\ProgramData\Tools4ever\NIM\config\rest\systems\SYSTEMNAME.json
158-
159-
SYSTEMNAME = The name of the system in NIM.
158+
**File Path & Name**
159+
>C:\ProgramData\Tools4ever\NIM\config\rest\systems\[SYSTEMNAME].json
160160
161+
**File Contents**
161162
```
162163
{
163164
"schema": {
@@ -177,7 +178,51 @@ SYSTEMNAME = The name of the system in NIM.
177178
}
178179
}
179180
```
181+
### Adding T4e Custom Schema Attributes
182+
Custom schema attributes can be added directly from the Google Admin console or the Developer API console (preferred).
183+
184+
Open the Developer API console and use the below values for the customerId and Request Body values and then press Execute. If prompted, allow access for the application to execute the command. You should see a response payload show up once the command has finished.
185+
186+
_Developer API Console:_
187+
> https://developers.google.com/admin-sdk/directory/reference/rest/v1/schemas/insert#try-it
188+
189+
_Request Parameters:_
190+
```
191+
customerId = my_customer
192+
```
180193

194+
_Request Body:_
195+
```
196+
{
197+
"fields":
198+
[
199+
{
200+
"fieldName": "ID",
201+
"fieldType": "STRING",
202+
"readAccessType": "ADMINS_AND_SELF",
203+
"multiValued": false,
204+
"displayName": "ID"
205+
},
206+
{
207+
"fieldName": "Type",
208+
"fieldType": "STRING",
209+
"readAccessType": "ADMINS_AND_SELF",
210+
"multiValued": false,
211+
"displayName": "Type"
212+
},
213+
{
214+
"fieldName": "DeleteDate",
215+
"fieldType": "STRING",
216+
"readAccessType": "ADMINS_AND_SELF",
217+
"multiValued": false,
218+
"displayName": "DeleteDate"
219+
}
220+
],
221+
"schemaName": "Tools4ever"
222+
"displayName": "Tools4ever"
223+
}
224+
```
225+
![image](https://github.com/Tools4ever-NIM/NIM-System-REST-Google-Workspace/assets/134305269/5be43fc3-5840-4595-938f-49a7900fdc33)
181226

182227
# NIM Docs
183228
The official NIM documentation can be found at: https://docs.nimsuite.com

0 commit comments

Comments
 (0)