Get data connector definition

Shell - curl
1

200
application/schema+json
1{
2  "$schema": "http://json-schema.org/draft-04/schema#",
3  "title": "DNFS",
4  "description": "dnfs",
5  "type": "object",
6  "additionalProperties": false,
7  "required": [
8    "engineName"
9  ],
10  "properties": {
11    "engineName": {
12      "title": "DNFS",
13      "type": "string",
14      "default": "DNFS",
15      "enum": [
16        "DNFS"
17      ]
18    },
19    "general": {
20      "title": "General options",
21      "description": "General options for this Caslib.",
22      "type": "object",
23      "additionalProperties": false,
24      "properties": {
25        "path": {
26          "type": "string",
27          "title": "Path",
28          "description": "specifies data source-specific information.  For PATH, DNFS and HDFS, this is a file system path.",
29          "default": "",
30          "properties": {
31            "isUserName": {
32              "enum": [
33                false
34              ]
35            },
36            "isPassword": {
37              "enum": [
38                false
39              ]
40            },
41            "isPath": {
42              "enum": [
43                false
44              ]
45            },
46            "isHideValue": {
47              "enum": [
48                false
49              ]
50            },
51            "isRequired": {
52              "enum": [
53                false
54              ]
55            },
56            "isCommon": {
57              "enum": [
58                true
59              ]
60            },
61            "toolTip": {
62              "enum": [
63                "Specifies data source-specific information.  For PATH, DNFS and HDFS, this is a file system path."
64              ]
65            }
66          }
67        },
68        "hidden": {
69          "type": "boolean",
70          "title": "Hidden",
71          "description": "when set to True, the Caslib is added as a hidden Caslib.",
72          "default": false,
73          "properties": {
74            "isHideValue": {
75              "enum": [
76                false
77              ]
78            },
79            "isRequired": {
80              "enum": [
81                false
82              ]
83            },
84            "isCommon": {
85              "enum": [
86                true
87              ]
88            },
89            "toolTip": {
90              "enum": [
91                "When set to True, the Caslib is added as a hidden Caslib."
92              ]
93            }
94          }
95        },
96        "transient": {
97          "type": "boolean",
98          "title": "Transient",
99          "description": "when set to True, the Caslib is added as a transient Caslib.",
100          "default": false,
101          "properties": {
102            "isHideValue": {
103              "enum": [
104                false
105              ]
106            },
107            "isRequired": {
108              "enum": [
109                false
110              ]
111            },
112            "isCommon": {
113              "enum": [
114                true
115              ]
116            },
117            "toolTip": {
118              "enum": [
119                "When set to True, the Caslib is added as a transient Caslib."
120              ]
121            }
122          }
123        },
124        "session": {
125          "type": "boolean",
126          "title": "Session scope",
127          "description": "when set to True, the Caslib is scoped to the current session only. Tables that you load in this session cannot be accessed from other sessions. If you specify False, then the Caslib is visible to other sessions, subject to access controls.",
128          "default": true,
129          "properties": {
130            "isHideValue": {
131              "enum": [
132                false
133              ]
134            },
135            "isRequired": {
136              "enum": [
137                false
138              ]
139            },
140            "isCommon": {
141              "enum": [
142                true
143              ]
144            },
145            "toolTip": {
146              "enum": [
147                "When set to True, the Caslib is scoped to the current session only. Tables that you load in this session cannot be accessed from other sessions. If you specify False, then the Caslib is visible to other sessions, subject to access controls."
148              ]
149            }
150          }
151        },
152        "name": {
153          "type": "string",
154          "title": "Caslib",
155          "description": "specifies the name of the Caslib to add.",
156          "properties": {
157            "isUserName": {
158              "enum": [
159                false
160              ]
161            },
162            "isPassword": {
163              "enum": [
164                false
165              ]
166            },
167            "isPath": {
168              "enum": [
169                false
170              ]
171            },
172            "isHideValue": {
173              "enum": [
174                false
175              ]
176            },
177            "isRequired": {
178              "enum": [
179                true
180              ]
181            },
182            "isCommon": {
183              "enum": [
184                true
185              ]
186            },
187            "toolTip": {
188              "enum": [
189                "Specifies the name of the Caslib to add."
190              ]
191            }
192          }
193        },
194        "description": {
195          "type": "string",
196          "title": "Description",
197          "description": "specifies a description of the Caslib.",
198          "default": "",
199          "properties": {
200            "isUserName": {
201              "enum": [
202                false
203              ]
204            },
205            "isPassword": {
206              "enum": [
207                false
208              ]
209            },
210            "isPath": {
211              "enum": [
212                false
213              ]
214            },
215            "isHideValue": {
216              "enum": [
217                false
218              ]
219            },
220            "isRequired": {
221              "enum": [
222                false
223              ]
224            },
225            "isCommon": {
226              "enum": [
227                true
228              ]
229            },
230            "toolTip": {
231              "enum": [
232                "Specifies a description of the Caslib."
233              ]
234            }
235          }
236        },
237        "createDirectory": {
238          "type": "boolean",
239          "title": "Create directory",
240          "description": "when set to True, the server attempts to create the directory for the Caslib.",
241          "default": false,
242          "properties": {
243            "isHideValue": {
244              "enum": [
245                false
246              ]
247            },
248            "isRequired": {
249              "enum": [
250                false
251              ]
252            },
253            "isCommon": {
254              "enum": [
255                true
256              ]
257            },
258            "toolTip": {
259              "enum": [
260                "When set to True, the server attempts to create the directory for the Caslib."
261              ]
262            }
263          }
264        },
265        "permission": {
266          "type": "string",
267          "title": "Permission",
268          "description": "specifies the host access controls on the Caslib when directory creation is requested.",
269          "enum": [
270            "GroupRead",
271            "GroupWrite",
272            "GroupWritePublicRead",
273            "Private",
274            "PublicRead",
275            "PublicWrite"
276          ],
277          "properties": {
278            "isUserName": {
279              "enum": [
280                false
281              ]
282            },
283            "isPassword": {
284              "enum": [
285                false
286              ]
287            },
288            "isPath": {
289              "enum": [
290                false
291              ]
292            },
293            "isHideValue": {
294              "enum": [
295                false
296              ]
297            },
298            "isRequired": {
299              "enum": [
300                false
301              ]
302            },
303            "isCommon": {
304              "enum": [
305                true
306              ]
307            },
308            "toolTip": {
309              "enum": [
310                "Specifies the host access controls on the Caslib when directory creation is requested."
311              ]
312            }
313          }
314        },
315        "subDirectories": {
316          "type": "boolean",
317          "title": "Subdirectories",
318          "description": "when set to True, tables and files in subdirectories of the path specified in the Caslib definition are accessible from the Caslib.",
319          "default": false,
320          "properties": {
321            "isHideValue": {
322              "enum": [
323                false
324              ]
325            },
326            "isRequired": {
327              "enum": [
328                false
329              ]
330            },
331            "isCommon": {
332              "enum": [
333                true
334              ]
335            },
336            "toolTip": {
337              "enum": [
338                "When set to True, tables and files in subdirectories of the path specified in the Caslib definition are accessible from the Caslib."
339              ]
340            }
341          }
342        },
343        "activeOnAdd": {
344          "type": "boolean",
345          "title": "Active on add",
346          "description": "when set to True, the new Caslib becomes the active Caslib.",
347          "default": true,
348          "properties": {
349            "isHideValue": {
350              "enum": [
351                false
352              ]
353            },
354            "isRequired": {
355              "enum": [
356                false
357              ]
358            },
359            "isCommon": {
360              "enum": [
361                true
362              ]
363            },
364            "toolTip": {
365              "enum": [
366                "When set to True, the new Caslib becomes the active Caslib."
367              ]
368            }
369          }
370        }
371      }
372    },
373    "datasource": {
374      "title": "Data source options",
375      "description": "Data source options for this Caslib.",
376      "type": "object",
377      "additionalProperties": false,
378      "properties": {
379        "srcType": {
380          "type": "string",
381          "title": "srcType",
382          "description": "",
383          "enum": [
384            "dnfs"
385          ],
386          "properties": {
387            "isUserName": {
388              "enum": [
389                false
390              ]
391            },
392            "isPassword": {
393              "enum": [
394                false
395              ]
396            },
397            "isPath": {
398              "enum": [
399                false
400              ]
401            },
402            "isHideValue": {
403              "enum": [
404                false
405              ]
406            },
407            "isRequired": {
408              "enum": [
409                true
410              ]
411            },
412            "isCommon": {
413              "enum": [
414                false
415              ]
416            },
417            "toolTip": {
418              "enum": [
419                ""
420              ]
421            }
422          }
423        },
424        "encryptionPassword": {
425          "type": "string",
426          "title": "Data encryption password",
427          "description": "specifies a password for encrypting or decrypting stored data.",
428          "properties": {
429            "isUserName": {
430              "enum": [
431                false
432              ]
433            },
434            "isPassword": {
435              "enum": [
436                true
437              ]
438            },
439            "isPath": {
440              "enum": [
441                false
442              ]
443            },
444            "isHideValue": {
445              "enum": [
446                true
447              ]
448            },
449            "isRequired": {
450              "enum": [
451                false
452              ]
453            },
454            "isCommon": {
455              "enum": [
456                false
457              ]
458            },
459            "toolTip": {
460              "enum": [
461                "Specifies a password for encrypting or decrypting stored data."
462              ]
463            }
464          }
465        },
466        "encryptionDomain": {
467          "type": "string",
468          "title": "Encryption domain",
469          "description": "specifies the name for a collection of data that is stored with a common encryption password.",
470          "properties": {
471            "isUserName": {
472              "enum": [
473                false
474              ]
475            },
476            "isPassword": {
477              "enum": [
478                false
479              ]
480            },
481            "isPath": {
482              "enum": [
483                false
484              ]
485            },
486            "isHideValue": {
487              "enum": [
488                false
489              ]
490            },
491            "isRequired": {
492              "enum": [
493                false
494              ]
495            },
496            "isCommon": {
497              "enum": [
498                false
499              ]
500            },
501            "toolTip": {
502              "enum": [
503                "Specifies the name for a collection of data that is stored with a common encryption password."
504              ]
505            }
506          }
507        }
508      }
509    }
510  }
511}