@ibm-cloud/ibm_dph_services 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +19 -0
- package/dph/v1.d.ts +1880 -196
- package/dph/v1.js +1575 -233
- package/dph/v1.js.map +1 -1
- package/examples/dph.v1.test.js +1898 -0
- package/package.json +2 -2
package/dph/v1.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* (C) Copyright IBM Corp.
|
|
2
|
+
* (C) Copyright IBM Corp. 2025.
|
|
3
3
|
*
|
|
4
4
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
5
|
* you may not use this file except in compliance with the License.
|
|
@@ -14,12 +14,15 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
/// <reference types="node" />
|
|
17
|
+
/// <reference types="node" />
|
|
18
|
+
/// <reference types="node" />
|
|
19
|
+
/// <reference types="node" />
|
|
17
20
|
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
|
|
18
21
|
import { BaseService, UserOptions } from 'ibm-cloud-sdk-core';
|
|
19
22
|
/**
|
|
20
23
|
* Data Product Hub API Service
|
|
21
24
|
*
|
|
22
|
-
* API Version: 1
|
|
25
|
+
* API Version: 1
|
|
23
26
|
*/
|
|
24
27
|
declare class DphV1 extends BaseService {
|
|
25
28
|
static DEFAULT_SERVICE_NAME: string;
|
|
@@ -112,19 +115,50 @@ declare class DphV1 extends BaseService {
|
|
|
112
115
|
* @returns {Promise<DphV1.Response<DphV1.EmptyObject>>}
|
|
113
116
|
*/
|
|
114
117
|
manageApiKeys(params?: DphV1.ManageApiKeysParams): Promise<DphV1.Response<DphV1.EmptyObject>>;
|
|
118
|
+
/*************************
|
|
119
|
+
* dataAssetVisualization
|
|
120
|
+
************************/
|
|
121
|
+
/**
|
|
122
|
+
* Create visualization asset and initialize profiling for the provided data assets.
|
|
123
|
+
*
|
|
124
|
+
* Use this API to create visualization asset and initialize profiling for the provided data assets<br/><br/>Provide
|
|
125
|
+
* the below required fields<br/><br/>Required fields:<br/><br/>- catalog_id<br/>- Collection of assetId with it's
|
|
126
|
+
* related asset id<br/><br/>.
|
|
127
|
+
*
|
|
128
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
129
|
+
* @param {DataAssetRelationship[]} [params.assets] - Data product hub asset and it's related part asset.
|
|
130
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
131
|
+
* @returns {Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>}
|
|
132
|
+
*/
|
|
133
|
+
createDataAssetVisualization(params?: DphV1.CreateDataAssetVisualizationParams): Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>;
|
|
134
|
+
/**
|
|
135
|
+
* Reinitiate visualization for an asset.
|
|
136
|
+
*
|
|
137
|
+
* Use this API to Reinitiate visualization for an asset which is in below scenarios<br/><br/>- Previous bucket got
|
|
138
|
+
* deleted and new bucket is created.<br/>- Data visualization attachment is missing in asset details.<br/>-
|
|
139
|
+
* Visualization asset reference is missing in related asset details.<br/><br/>.
|
|
140
|
+
*
|
|
141
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
142
|
+
* @param {DataAssetRelationship[]} [params.assets] - Data product hub asset and it's related part asset.
|
|
143
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
144
|
+
* @returns {Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>}
|
|
145
|
+
*/
|
|
146
|
+
reinitiateDataAssetVisualization(params?: DphV1.ReinitiateDataAssetVisualizationParams): Promise<DphV1.Response<DphV1.DataAssetVisualizationRes>>;
|
|
115
147
|
/*************************
|
|
116
148
|
* dataProducts
|
|
117
149
|
************************/
|
|
118
150
|
/**
|
|
151
|
+
* Retrieve a list of data products.
|
|
152
|
+
*
|
|
119
153
|
* Retrieve a list of data products.
|
|
120
154
|
*
|
|
121
155
|
* @param {Object} [params] - The parameters to send to the service.
|
|
122
156
|
* @param {number} [params.limit] - Limit the number of data products in the results. The maximum limit is 200.
|
|
123
157
|
* @param {string} [params.start] - Start token for pagination.
|
|
124
158
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
125
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
159
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductCollection>>}
|
|
126
160
|
*/
|
|
127
|
-
listDataProducts(params?: DphV1.ListDataProductsParams): Promise<DphV1.Response<DphV1.
|
|
161
|
+
listDataProducts(params?: DphV1.ListDataProductsParams): Promise<DphV1.Response<DphV1.DataProductCollection>>;
|
|
128
162
|
/**
|
|
129
163
|
* Create a new data product.
|
|
130
164
|
*
|
|
@@ -133,12 +167,16 @@ declare class DphV1 extends BaseService {
|
|
|
133
167
|
* default version **1.0.0** will be used.<br/><br/>The `domain` is optional.
|
|
134
168
|
*
|
|
135
169
|
* @param {Object} params - The parameters to send to the service.
|
|
136
|
-
* @param {
|
|
170
|
+
* @param {DataProductDraftPrototype[]} params.drafts - Collection of data products drafts to add to data product.
|
|
171
|
+
* @param {number} [params.limit] - Limit the number of data products in the results. The maximum limit is 200.
|
|
172
|
+
* @param {string} [params.start] - Start token for pagination.
|
|
137
173
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
138
174
|
* @returns {Promise<DphV1.Response<DphV1.DataProduct>>}
|
|
139
175
|
*/
|
|
140
176
|
createDataProduct(params: DphV1.CreateDataProductParams): Promise<DphV1.Response<DphV1.DataProduct>>;
|
|
141
177
|
/**
|
|
178
|
+
* Retrieve a data product identified by id.
|
|
179
|
+
*
|
|
142
180
|
* Retrieve a data product identified by id.
|
|
143
181
|
*
|
|
144
182
|
* @param {Object} params - The parameters to send to the service.
|
|
@@ -154,7 +192,8 @@ declare class DphV1 extends BaseService {
|
|
|
154
192
|
* Complete a contract document upload operation.
|
|
155
193
|
*
|
|
156
194
|
* After uploading a file to the provided signed URL, call this endpoint to mark the upload as complete. After the
|
|
157
|
-
* upload operation is marked as complete, the file is available to download.
|
|
195
|
+
* upload operation is marked as complete, the file is available to download. Use '-' for the `data_product_id` to
|
|
196
|
+
* skip specifying the data product ID explicitly.
|
|
158
197
|
* - After the upload is marked as complete, the returned URL is displayed in the "url" field. The signed URL is used
|
|
159
198
|
* to download the document.
|
|
160
199
|
* - Calling complete on referential documents results in an error.
|
|
@@ -172,6 +211,9 @@ declare class DphV1 extends BaseService {
|
|
|
172
211
|
/**
|
|
173
212
|
* Retrieve a list of data product drafts.
|
|
174
213
|
*
|
|
214
|
+
* Retrieve a list of data product drafts. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
215
|
+
* explicitly.
|
|
216
|
+
*
|
|
175
217
|
* @param {Object} params - The parameters to send to the service.
|
|
176
218
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
177
219
|
* @param {string} [params.assetContainerId] - Filter the list of data product drafts by container id.
|
|
@@ -183,6 +225,8 @@ declare class DphV1 extends BaseService {
|
|
|
183
225
|
*/
|
|
184
226
|
listDataProductDrafts(params: DphV1.ListDataProductDraftsParams): Promise<DphV1.Response<DphV1.DataProductDraftCollection>>;
|
|
185
227
|
/**
|
|
228
|
+
* Create a new draft of an existing data product.
|
|
229
|
+
*
|
|
186
230
|
* Create a new draft of an existing data product.
|
|
187
231
|
*
|
|
188
232
|
* @param {Object} params - The parameters to send to the service.
|
|
@@ -201,10 +245,7 @@ declare class DphV1 extends BaseService {
|
|
|
201
245
|
* @param {string[]} [params.tags] - Tags on the data product.
|
|
202
246
|
* @param {UseCase[]} [params.useCases] - A list of use cases associated with the data product version.
|
|
203
247
|
* @param {string[]} [params.types] - Types of parts on the data product.
|
|
204
|
-
* @param {
|
|
205
|
-
* product.
|
|
206
|
-
* @param {boolean} [params.isRestricted] - Indicates whether the data product is restricted or not. A restricted data
|
|
207
|
-
* product indicates that orders of the data product requires explicit approval before data is delivered.
|
|
248
|
+
* @param {ContractTerms[]} [params.contractTerms] - Contract terms binding various aspects of the data product.
|
|
208
249
|
* @param {Domain} [params.domain] - Domain that the data product version belongs to. If this is the first version of
|
|
209
250
|
* a data product, this field is required. If this is a new version of an existing data product, the domain will
|
|
210
251
|
* default to the domain of the previous version of the data product.
|
|
@@ -213,13 +254,25 @@ declare class DphV1 extends BaseService {
|
|
|
213
254
|
* version of an existing data product, the data product parts will default to the parts list from the previous
|
|
214
255
|
* version of the data product.
|
|
215
256
|
* @param {DataProductWorkflows} [params.workflows] - The workflows associated with the data product version.
|
|
257
|
+
* @param {boolean} [params.dataviewEnabled] - Indicates whether the dataView has enabled for data product.
|
|
258
|
+
* @param {string} [params.comments] - Comments by a producer that are provided either at the time of data product
|
|
259
|
+
* version creation or retiring.
|
|
260
|
+
* @param {AssetListAccessControl} [params.accessControl] - Access control object.
|
|
261
|
+
* @param {string} [params.lastUpdatedAt] - Timestamp of last asset update.
|
|
262
|
+
* @param {ContainerIdentity} [params.subContainer] - The identity schema for a IBM knowledge catalog container
|
|
263
|
+
* (catalog/project/space).
|
|
264
|
+
* @param {boolean} [params.isRestricted] - Indicates whether the data product is restricted or not. A restricted data
|
|
265
|
+
* product indicates that orders of the data product requires explicit approval before data is delivered.
|
|
216
266
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
217
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
267
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDraft>>}
|
|
218
268
|
*/
|
|
219
|
-
createDataProductDraft(params: DphV1.CreateDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
269
|
+
createDataProductDraft(params: DphV1.CreateDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductDraft>>;
|
|
220
270
|
/**
|
|
221
271
|
* Upload a contract document to the data product draft contract terms.
|
|
222
272
|
*
|
|
273
|
+
* Upload a contract document to the data product draft identified by draft_id. Use '-' for the `data_product_id` to
|
|
274
|
+
* skip specifying the data product ID explicitly.
|
|
275
|
+
*
|
|
223
276
|
* - If the request object contains a "url" parameter, a referential document is created to store the provided url.
|
|
224
277
|
* - If the request object does not contain a "url" parameter, an attachment document is created, and a signed url
|
|
225
278
|
* will be returned in an "upload_url" parameter. The data product producer can upload the document using the provided
|
|
@@ -241,16 +294,22 @@ declare class DphV1 extends BaseService {
|
|
|
241
294
|
/**
|
|
242
295
|
* Get a draft of an existing data product.
|
|
243
296
|
*
|
|
297
|
+
* Get a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
298
|
+
* explicitly.
|
|
299
|
+
*
|
|
244
300
|
* @param {Object} params - The parameters to send to the service.
|
|
245
301
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
246
302
|
* @param {string} params.draftId - Data product draft id.
|
|
247
303
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
248
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
304
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDraft>>}
|
|
249
305
|
*/
|
|
250
|
-
getDataProductDraft(params: DphV1.GetDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
306
|
+
getDataProductDraft(params: DphV1.GetDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductDraft>>;
|
|
251
307
|
/**
|
|
252
308
|
* Delete a data product draft identified by ID.
|
|
253
309
|
*
|
|
310
|
+
* Delete a data product draft identified by a valid ID. Use '-' for the `data_product_id` to skip specifying the data
|
|
311
|
+
* product ID explicitly.
|
|
312
|
+
*
|
|
254
313
|
* @param {Object} params - The parameters to send to the service.
|
|
255
314
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
256
315
|
* @param {string} params.draftId - Data product draft id.
|
|
@@ -261,10 +320,11 @@ declare class DphV1 extends BaseService {
|
|
|
261
320
|
/**
|
|
262
321
|
* Update the data product draft identified by ID.
|
|
263
322
|
*
|
|
264
|
-
* Use this API to update the properties of a data product draft identified by a valid ID
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
*
|
|
323
|
+
* Use this API to update the properties of a data product draft identified by a valid ID. Use '-' for the
|
|
324
|
+
* `data_product_id` to skip specifying the data product ID explicitly.<br/><br/>Specify patch operations using
|
|
325
|
+
* http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a
|
|
326
|
+
* data product<br/><br/>- Add/Remove parts from a data product (up to 20 parts)<br/><br/>- Add/Remove use cases from
|
|
327
|
+
* a data product<br/><br/>- Update the data product state<br/><br/>.
|
|
268
328
|
*
|
|
269
329
|
* @param {Object} params - The parameters to send to the service.
|
|
270
330
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -272,16 +332,17 @@ declare class DphV1 extends BaseService {
|
|
|
272
332
|
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
273
333
|
* http://jsonpatch.com/ for more information.
|
|
274
334
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
275
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
335
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDraft>>}
|
|
276
336
|
*/
|
|
277
|
-
updateDataProductDraft(params: DphV1.UpdateDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
337
|
+
updateDataProductDraft(params: DphV1.UpdateDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductDraft>>;
|
|
278
338
|
/**
|
|
279
339
|
* Get a contract document.
|
|
280
340
|
*
|
|
281
341
|
* If a document has a completed attachment, the response contains the `url` which can be used to download the
|
|
282
342
|
* attachment. If a document does not have a completed attachment, the response contains the `url` which was submitted
|
|
283
343
|
* at document creation. If a document has an attachment that is incomplete, an error is returned to prompt the user
|
|
284
|
-
* to upload the document file and complete it.
|
|
344
|
+
* to upload the document file and complete it. Use '-' for the `data_product_id` to skip specifying the data product
|
|
345
|
+
* ID explicitly.
|
|
285
346
|
*
|
|
286
347
|
* @param {Object} params - The parameters to send to the service.
|
|
287
348
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -295,7 +356,10 @@ declare class DphV1 extends BaseService {
|
|
|
295
356
|
/**
|
|
296
357
|
* Delete a contract document.
|
|
297
358
|
*
|
|
298
|
-
*
|
|
359
|
+
* Delete an existing contract document.
|
|
360
|
+
*
|
|
361
|
+
* Contract documents can only be deleted for data product versions that are in DRAFT state. Use '-' for the
|
|
362
|
+
* `data_product_id` to skip specifying the data product ID explicitly.
|
|
299
363
|
*
|
|
300
364
|
* @param {Object} params - The parameters to send to the service.
|
|
301
365
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -317,6 +381,7 @@ declare class DphV1 extends BaseService {
|
|
|
317
381
|
* - Update the url of document if it does not have an attachment.
|
|
318
382
|
* - Update the type of the document.
|
|
319
383
|
* <br/><br/>Contract terms documents can only be updated if the associated data product version is in DRAFT state.
|
|
384
|
+
* Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.
|
|
320
385
|
*
|
|
321
386
|
* @param {Object} params - The parameters to send to the service.
|
|
322
387
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -329,38 +394,131 @@ declare class DphV1 extends BaseService {
|
|
|
329
394
|
* @returns {Promise<DphV1.Response<DphV1.ContractTermsDocument>>}
|
|
330
395
|
*/
|
|
331
396
|
updateDraftContractTermsDocument(params: DphV1.UpdateDraftContractTermsDocumentParams): Promise<DphV1.Response<DphV1.ContractTermsDocument>>;
|
|
397
|
+
/**
|
|
398
|
+
* Retrieve a data product contract terms identified by id.
|
|
399
|
+
*
|
|
400
|
+
* Retrieve a data product contract terms identified by id.
|
|
401
|
+
*
|
|
402
|
+
* @param {Object} params - The parameters to send to the service.
|
|
403
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
404
|
+
* @param {string} params.draftId - Data product draft id.
|
|
405
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
406
|
+
* @param {string} [params.accept] - The type of the response: application/json or application/odcs+yaml.
|
|
407
|
+
* @param {boolean} [params.includeContractDocuments] - Set to false to exclude external contract documents (e.g.,
|
|
408
|
+
* Terms and Conditions URLs) from the response. By default, these are included.
|
|
409
|
+
* @param {boolean} [params.autopopulateServerInformation] - Set to true to autopopulate server information from
|
|
410
|
+
* connection details. Default is false.
|
|
411
|
+
* @param {string} [params.serverAssetId] - Asset ID of the server used for autopopulating connection details.
|
|
412
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
413
|
+
* @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
|
|
414
|
+
*/
|
|
415
|
+
getDataProductDraftContractTerms(params: DphV1.GetDataProductDraftContractTermsParams): Promise<DphV1.Response<DphV1.ContractTerms>>;
|
|
416
|
+
/**
|
|
417
|
+
* Update a data product contract terms identified by id.
|
|
418
|
+
*
|
|
419
|
+
* Update a data product contract terms identified by id.
|
|
420
|
+
*
|
|
421
|
+
* @param {Object} params - The parameters to send to the service.
|
|
422
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
423
|
+
* @param {string} params.draftId - Data product draft id.
|
|
424
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
425
|
+
* @param {AssetReference} [params.asset] - The reference schema for a asset in a container.
|
|
426
|
+
* @param {string} [params.id] - ID of the contract terms.
|
|
427
|
+
* @param {ContractTermsDocument[]} [params.documents] - Collection of contract terms documents.
|
|
428
|
+
* @param {string} [params.errorMsg] - An error message, if existing, relating to the contract terms.
|
|
429
|
+
* @param {Overview} [params.overview] - Overview details of a data contract.
|
|
430
|
+
* @param {Description} [params.description] - Description details of a data contract.
|
|
431
|
+
* @param {ContractTemplateOrganization[]} [params.organization] - List of sub domains to be added within a domain.
|
|
432
|
+
* @param {Roles[]} [params.roles] - List of roles associated with the contract.
|
|
433
|
+
* @param {Pricing} [params.price] - Represents the pricing details of the contract.
|
|
434
|
+
* @param {ContractTemplateSLA[]} [params.sla] - Service Level Agreement details.
|
|
435
|
+
* @param {ContractTemplateSupportAndCommunication[]} [params.supportAndCommunication] - Support and communication
|
|
436
|
+
* details for the contract.
|
|
437
|
+
* @param {ContractTemplateCustomProperty[]} [params.customProperties] - Custom properties that are not part of the
|
|
438
|
+
* standard contract.
|
|
439
|
+
* @param {ContractTest} [params.contractTest] - Contains the contract test status and related metadata.
|
|
440
|
+
* @param {ContractServer[]} [params.servers] - List of server definitions.
|
|
441
|
+
* @param {ContractSchema[]} [params.schema] - Schema details of the data asset.
|
|
442
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
443
|
+
* @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
|
|
444
|
+
*/
|
|
445
|
+
replaceDataProductDraftContractTerms(params: DphV1.ReplaceDataProductDraftContractTermsParams): Promise<DphV1.Response<DphV1.ContractTerms>>;
|
|
446
|
+
/**
|
|
447
|
+
* Update a contract terms property.
|
|
448
|
+
*
|
|
449
|
+
* Use this API to update the properties of a contract terms that is identified by a valid ID.
|
|
450
|
+
*
|
|
451
|
+
* Specify patch operations using http://jsonpatch.com/ syntax.
|
|
452
|
+
*
|
|
453
|
+
* Supported patch operations include:
|
|
454
|
+
* - Update the contract terms properties.
|
|
455
|
+
* <br/><br/>Contract terms can only be updated if the associated data product version is in DRAFT state.
|
|
456
|
+
*
|
|
457
|
+
* @param {Object} params - The parameters to send to the service.
|
|
458
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
459
|
+
* @param {string} params.draftId - Data product draft id.
|
|
460
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
461
|
+
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
462
|
+
* http://jsonpatch.com/ for more information.
|
|
463
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
464
|
+
* @returns {Promise<DphV1.Response<DphV1.ContractTerms>>}
|
|
465
|
+
*/
|
|
466
|
+
updateDataProductDraftContractTerms(params: DphV1.UpdateDataProductDraftContractTermsParams): Promise<DphV1.Response<DphV1.ContractTerms>>;
|
|
467
|
+
/**
|
|
468
|
+
* Retrieve a data product contract terms identified by id in specified format.
|
|
469
|
+
*
|
|
470
|
+
* Retrieve a data product contract terms identified by id in specified format.
|
|
471
|
+
*
|
|
472
|
+
* @param {Object} params - The parameters to send to the service.
|
|
473
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
474
|
+
* @param {string} params.draftId - Data product draft id.
|
|
475
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
476
|
+
* @param {string} params.format - The format for returning contract terms. For example: odcs.
|
|
477
|
+
* @param {string} params.formatVersion - The version of the format for returning contract terms. For example: 3.
|
|
478
|
+
* @param {string} [params.accept] - The type of the response: application/odcs+yaml or application/json.
|
|
479
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
480
|
+
* @returns {Promise<DphV1.Response<NodeJS.ReadableStream>>}
|
|
481
|
+
*/
|
|
482
|
+
getContractTermsInSpecifiedFormat(params: DphV1.GetContractTermsInSpecifiedFormatParams): Promise<DphV1.Response<NodeJS.ReadableStream>>;
|
|
332
483
|
/**
|
|
333
484
|
* Publish a draft of an existing data product.
|
|
334
485
|
*
|
|
486
|
+
* Publish a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product
|
|
487
|
+
* ID explicitly.
|
|
488
|
+
*
|
|
335
489
|
* @param {Object} params - The parameters to send to the service.
|
|
336
490
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
337
491
|
* @param {string} params.draftId - Data product draft id.
|
|
338
492
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
339
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
493
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
340
494
|
*/
|
|
341
|
-
publishDataProductDraft(params: DphV1.PublishDataProductDraftParams): Promise<DphV1.Response<DphV1.
|
|
495
|
+
publishDataProductDraft(params: DphV1.PublishDataProductDraftParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
342
496
|
/*************************
|
|
343
497
|
* dataProductReleases
|
|
344
498
|
************************/
|
|
345
499
|
/**
|
|
346
500
|
* Get a release of an existing data product.
|
|
347
501
|
*
|
|
502
|
+
* Get a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
503
|
+
* explicitly.
|
|
504
|
+
*
|
|
348
505
|
* @param {Object} params - The parameters to send to the service.
|
|
349
506
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
350
507
|
* @param {string} params.releaseId - Data product release id.
|
|
351
508
|
* @param {boolean} [params.checkCallerApproval] - If the value is true, then it will be verfied whether the caller is
|
|
352
509
|
* present in the data access request pre-approved user list.
|
|
353
510
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
354
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
511
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
355
512
|
*/
|
|
356
|
-
getDataProductRelease(params: DphV1.GetDataProductReleaseParams): Promise<DphV1.Response<DphV1.
|
|
513
|
+
getDataProductRelease(params: DphV1.GetDataProductReleaseParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
357
514
|
/**
|
|
358
515
|
* Update the data product release identified by ID.
|
|
359
516
|
*
|
|
360
|
-
* Use this API to update the properties of a data product release identified by a valid ID
|
|
361
|
-
*
|
|
362
|
-
*
|
|
363
|
-
*
|
|
517
|
+
* Use this API to update the properties of a data product release identified by a valid ID. Use '-' for the
|
|
518
|
+
* `data_product_id` to skip specifying the data product ID explicitly.<br/><br/>Specify patch operations using
|
|
519
|
+
* http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a
|
|
520
|
+
* data product<br/><br/>- Add/remove parts from a data product (up to 20 parts)<br/><br/>- Add/remove use cases from
|
|
521
|
+
* a data product<br/><br/>.
|
|
364
522
|
*
|
|
365
523
|
* @param {Object} params - The parameters to send to the service.
|
|
366
524
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -368,16 +526,17 @@ declare class DphV1 extends BaseService {
|
|
|
368
526
|
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
369
527
|
* http://jsonpatch.com/ for more information.
|
|
370
528
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
371
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
529
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
372
530
|
*/
|
|
373
|
-
updateDataProductRelease(params: DphV1.UpdateDataProductReleaseParams): Promise<DphV1.Response<DphV1.
|
|
531
|
+
updateDataProductRelease(params: DphV1.UpdateDataProductReleaseParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
374
532
|
/**
|
|
375
533
|
* Get a contract document.
|
|
376
534
|
*
|
|
377
535
|
* If the document has a completed attachment, the response contains the `url` to download the attachment.<br/><br/>
|
|
378
536
|
* If the document does not have an attachment, the response contains the `url` which was submitted at document
|
|
379
537
|
* creation.<br/><br/> If the document has an incomplete attachment, an error is returned to prompt the user to upload
|
|
380
|
-
* the document file to complete the attachment.
|
|
538
|
+
* the document file to complete the attachment. Use '-' for the `data_product_id` to skip specifying the data product
|
|
539
|
+
* ID explicitly.
|
|
381
540
|
*
|
|
382
541
|
* @param {Object} params - The parameters to send to the service.
|
|
383
542
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
@@ -388,9 +547,28 @@ declare class DphV1 extends BaseService {
|
|
|
388
547
|
* @returns {Promise<DphV1.Response<DphV1.ContractTermsDocument>>}
|
|
389
548
|
*/
|
|
390
549
|
getReleaseContractTermsDocument(params: DphV1.GetReleaseContractTermsDocumentParams): Promise<DphV1.Response<DphV1.ContractTermsDocument>>;
|
|
550
|
+
/**
|
|
551
|
+
* Retrieve a published data product contract terms identified by id.
|
|
552
|
+
*
|
|
553
|
+
* Retrieve a published data product contract terms identified by id.
|
|
554
|
+
*
|
|
555
|
+
* @param {Object} params - The parameters to send to the service.
|
|
556
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
557
|
+
* @param {string} params.releaseId - Data product release id.
|
|
558
|
+
* @param {string} params.contractTermsId - Contract terms id.
|
|
559
|
+
* @param {string} [params.accept] - The type of the response: application/odcs+yaml or application/json.
|
|
560
|
+
* @param {boolean} [params.includeContractDocuments] - Set to false to exclude external contract documents (e.g.,
|
|
561
|
+
* Terms and Conditions URLs) from the response. By default, these are included.
|
|
562
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
563
|
+
* @returns {Promise<DphV1.Response<NodeJS.ReadableStream>>}
|
|
564
|
+
*/
|
|
565
|
+
getPublishedDataProductDraftContractTerms(params: DphV1.GetPublishedDataProductDraftContractTermsParams): Promise<DphV1.Response<NodeJS.ReadableStream>>;
|
|
391
566
|
/**
|
|
392
567
|
* Retrieve a list of data product releases.
|
|
393
568
|
*
|
|
569
|
+
* Retrieve a list of data product releases. Use '-' for the `data_product_id` to skip specifying the data product ID
|
|
570
|
+
* explicitly.
|
|
571
|
+
*
|
|
394
572
|
* @param {Object} params - The parameters to send to the service.
|
|
395
573
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
396
574
|
* @param {string} [params.assetContainerId] - Filter the list of data product releases by container id.
|
|
@@ -406,13 +584,267 @@ declare class DphV1 extends BaseService {
|
|
|
406
584
|
/**
|
|
407
585
|
* Retire a release of an existing data product.
|
|
408
586
|
*
|
|
587
|
+
* Retire a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product
|
|
588
|
+
* ID explicitly.
|
|
589
|
+
*
|
|
409
590
|
* @param {Object} params - The parameters to send to the service.
|
|
410
591
|
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
411
592
|
* @param {string} params.releaseId - Data product release id.
|
|
593
|
+
* @param {boolean} [params.revokeAccess] - Revoke's Access from all the Subscriptions of the Data Product. No user's
|
|
594
|
+
* can able to see the subscribed assets anymore.
|
|
595
|
+
* @param {string} [params.startAt] - The date and time when the revoke access operation should start (ISO 8601
|
|
596
|
+
* format, e.g., 2025-09-24T06:55:29Z). If not provided, the operation starts immediately.
|
|
597
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
598
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductRelease>>}
|
|
599
|
+
*/
|
|
600
|
+
retireDataProductRelease(params: DphV1.RetireDataProductReleaseParams): Promise<DphV1.Response<DphV1.DataProductRelease>>;
|
|
601
|
+
/**
|
|
602
|
+
* Revoke access from Data Product subscriptions.
|
|
603
|
+
*
|
|
604
|
+
* Revoke's access from Subscriptions of the data product id passed in the path parameter. Optionally specify a future
|
|
605
|
+
* date-time when the revoke access operation should start using the start_at field in ISO 8601 format (e.g.,
|
|
606
|
+
* 2025-09-24T06:55:29Z). If start_at is not provided, the revoke access operation starts immediately.
|
|
607
|
+
*
|
|
608
|
+
* @param {Object} params - The parameters to send to the service.
|
|
609
|
+
* @param {string} params.dataProductId - Data product ID. Use '-' to skip specifying the data product ID explicitly.
|
|
610
|
+
* @param {string} params.releaseId - The unique identifier of the data product release.
|
|
611
|
+
* @param {NodeJS.ReadableStream | Buffer} [params.body] - Request parameters to handle revoke access from
|
|
612
|
+
* subscriptions. The start_at field can be used to schedule the revoke access operation for a future date-time.
|
|
613
|
+
* @param {string} [params.contentType] - The type of the input.
|
|
614
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
615
|
+
* @returns {Promise<DphV1.Response<DphV1.RevokeAccessResponse>>}
|
|
616
|
+
*/
|
|
617
|
+
createRevokeAccessProcess(params: DphV1.CreateRevokeAccessProcessParams): Promise<DphV1.Response<DphV1.RevokeAccessResponse>>;
|
|
618
|
+
/*************************
|
|
619
|
+
* dataProductContractTemplates
|
|
620
|
+
************************/
|
|
621
|
+
/**
|
|
622
|
+
* Retrieve a list of data product contract templates.
|
|
623
|
+
*
|
|
624
|
+
* Retrieve a list of data product contract templates.
|
|
625
|
+
*
|
|
626
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
627
|
+
* @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
|
|
628
|
+
* catalog is looked up by using the uid of the default data product catalog.
|
|
629
|
+
* @param {string} [params.contractTemplateName] - Name of the data product contract template. If not supplied, the
|
|
630
|
+
* data product templates within the catalog will returned.
|
|
631
|
+
* @param {string} [params.domainIds] - Comma-separated domain IDs to filter data product contract templates. If not
|
|
632
|
+
* supplied, the data product templates within the catalog will returned.
|
|
633
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
634
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplateCollection>>}
|
|
635
|
+
*/
|
|
636
|
+
listDataProductContractTemplate(params?: DphV1.ListDataProductContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplateCollection>>;
|
|
637
|
+
/**
|
|
638
|
+
* Create new data product contract template.
|
|
639
|
+
*
|
|
640
|
+
* Create new data product contract template.
|
|
641
|
+
*
|
|
642
|
+
* @param {Object} params - The parameters to send to the service.
|
|
643
|
+
* @param {ContainerReference} params.container - Container reference.
|
|
644
|
+
* @param {string} [params.id] - The identifier of the data product contract template.
|
|
645
|
+
* @param {string} [params.creatorId] - The identifier of the user who created the data product contract template.
|
|
646
|
+
* @param {string} [params.createdAt] - The timestamp when the data product contract template was created.
|
|
647
|
+
* @param {string} [params.name] - The name of the contract template.
|
|
648
|
+
* @param {ErrorMessage} [params.error] - Contains the code and details.
|
|
649
|
+
* @param {ContractTerms} [params.contractTerms] - Defines the complete structure of a contract terms.
|
|
650
|
+
* @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
|
|
651
|
+
* catalog is looked up by using the uid of the default data product catalog.
|
|
652
|
+
* @param {string} [params.contractTemplateName] - Name of the data product contract template. If not supplied, the
|
|
653
|
+
* data product templates within the catalog will returned.
|
|
654
|
+
* @param {string} [params.domainIds] - Comma-separated domain IDs to filter data product contract templates. If not
|
|
655
|
+
* supplied, the data product templates within the catalog will returned.
|
|
656
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
657
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplate>>}
|
|
658
|
+
*/
|
|
659
|
+
createContractTemplate(params: DphV1.CreateContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplate>>;
|
|
660
|
+
/**
|
|
661
|
+
* Retrieve a data product contract template identified by id.
|
|
662
|
+
*
|
|
663
|
+
* Retrieve a data product contract template identified by id.
|
|
664
|
+
*
|
|
665
|
+
* @param {Object} params - The parameters to send to the service.
|
|
666
|
+
* @param {string} params.contractTemplateId - Data Product Contract Template id.
|
|
667
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
668
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
669
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplate>>}
|
|
670
|
+
*/
|
|
671
|
+
getContractTemplate(params: DphV1.GetContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplate>>;
|
|
672
|
+
/**
|
|
673
|
+
* Delete a data product contract template identified by id.
|
|
674
|
+
*
|
|
675
|
+
* Delete a data product contract template identified by id.
|
|
676
|
+
*
|
|
677
|
+
* @param {Object} params - The parameters to send to the service.
|
|
678
|
+
* @param {string} params.contractTemplateId - Data Product Contract Template id.
|
|
679
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
412
680
|
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
413
|
-
* @returns {Promise<DphV1.Response<DphV1.
|
|
681
|
+
* @returns {Promise<DphV1.Response<DphV1.EmptyObject>>}
|
|
682
|
+
*/
|
|
683
|
+
deleteDataProductContractTemplate(params: DphV1.DeleteDataProductContractTemplateParams): Promise<DphV1.Response<DphV1.EmptyObject>>;
|
|
684
|
+
/**
|
|
685
|
+
* Update the data product contract template identified by ID.
|
|
686
|
+
*
|
|
687
|
+
* Use this API to update the properties of a data product contract template identified by a valid
|
|
688
|
+
* ID.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations
|
|
689
|
+
* include:<br/><br/>- Update the name of a data product contract template<br/><br/>- Update the contract terms of
|
|
690
|
+
* data product contract template<br/><br/>.
|
|
691
|
+
*
|
|
692
|
+
* @param {Object} params - The parameters to send to the service.
|
|
693
|
+
* @param {string} params.contractTemplateId - Data Product Contract Template id.
|
|
694
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
695
|
+
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
696
|
+
* http://jsonpatch.com/ for more information.
|
|
697
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
698
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductContractTemplate>>}
|
|
699
|
+
*/
|
|
700
|
+
updateDataProductContractTemplate(params: DphV1.UpdateDataProductContractTemplateParams): Promise<DphV1.Response<DphV1.DataProductContractTemplate>>;
|
|
701
|
+
/*************************
|
|
702
|
+
* dataProductDomains
|
|
703
|
+
************************/
|
|
704
|
+
/**
|
|
705
|
+
* Retrieve a list of data product domains.
|
|
706
|
+
*
|
|
707
|
+
* Retrieve a list of data product domains.
|
|
708
|
+
*
|
|
709
|
+
* @param {Object} [params] - The parameters to send to the service.
|
|
710
|
+
* @param {string} [params.containerId] - Container ID of the data product catalog. If not supplied, the data product
|
|
711
|
+
* catalog is looked up by using the uid of the default data product catalog.
|
|
712
|
+
* @param {boolean} [params.includeSubdomains] - Include subdomains in the response.
|
|
713
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
714
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomainCollection>>}
|
|
715
|
+
*/
|
|
716
|
+
listDataProductDomains(params?: DphV1.ListDataProductDomainsParams): Promise<DphV1.Response<DphV1.DataProductDomainCollection>>;
|
|
717
|
+
/**
|
|
718
|
+
* Create new data product domain.
|
|
719
|
+
*
|
|
720
|
+
* Create new data product domain.
|
|
721
|
+
*
|
|
722
|
+
* @param {Object} params - The parameters to send to the service.
|
|
723
|
+
* @param {ContainerReference} params.container - Container reference.
|
|
724
|
+
* @param {string} [params.trace] - The id to trace the failed domain creations.
|
|
725
|
+
* @param {ErrorModelResource[]} [params.errors] - Set of errors on the sub domain creation.
|
|
726
|
+
* @param {string} [params.name] - The name of the data product domain.
|
|
727
|
+
* @param {string} [params.description] - The description of the data product domain.
|
|
728
|
+
* @param {string} [params.id] - The identifier of the data product domain.
|
|
729
|
+
* @param {string} [params.createdBy] - The identifier of the creator of the data product domain.
|
|
730
|
+
* @param {MemberRolesSchema} [params.memberRoles] - Member roles of a corresponding asset.
|
|
731
|
+
* @param {PropertiesSchema} [params.properties] - Properties of the corresponding asset.
|
|
732
|
+
* @param {InitializeSubDomain[]} [params.subDomains] - List of sub domains to be added within a domain.
|
|
733
|
+
* @param {ContainerIdentity} [params.subContainer] - The identity schema for a IBM knowledge catalog container
|
|
734
|
+
* (catalog/project/space).
|
|
735
|
+
* @param {boolean} [params.linkToSubcontainers] - Link domains to subcontainers.
|
|
736
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
737
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomain>>}
|
|
738
|
+
*/
|
|
739
|
+
createDataProductDomain(params: DphV1.CreateDataProductDomainParams): Promise<DphV1.Response<DphV1.DataProductDomain>>;
|
|
740
|
+
/**
|
|
741
|
+
* Create data product subdomains for a specific domain identified by id.
|
|
742
|
+
*
|
|
743
|
+
* Create data product subdomains for a specific domain identified by id.
|
|
744
|
+
*
|
|
745
|
+
* @param {Object} params - The parameters to send to the service.
|
|
746
|
+
* @param {string} params.domainId - Domain id.
|
|
747
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
748
|
+
* @param {string} [params.name] - The name of the data product subdomain.
|
|
749
|
+
* @param {string} [params.id] - The identifier of the data product subdomain.
|
|
750
|
+
* @param {string} [params.description] - The description of the data product subdomain.
|
|
751
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
752
|
+
* @returns {Promise<DphV1.Response<DphV1.InitializeSubDomain>>}
|
|
753
|
+
*/
|
|
754
|
+
createDataProductSubdomain(params: DphV1.CreateDataProductSubdomainParams): Promise<DphV1.Response<DphV1.InitializeSubDomain>>;
|
|
755
|
+
/**
|
|
756
|
+
* Retrieve a data product domain or subdomain identified by id.
|
|
757
|
+
*
|
|
758
|
+
* Retrieve a data product domain or subdomain identified by id.
|
|
759
|
+
*
|
|
760
|
+
* @param {Object} params - The parameters to send to the service.
|
|
761
|
+
* @param {string} params.domainId - Domain id.
|
|
762
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
763
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomain>>}
|
|
764
|
+
*/
|
|
765
|
+
getDomain(params: DphV1.GetDomainParams): Promise<DphV1.Response<DphV1.DataProductDomain>>;
|
|
766
|
+
/**
|
|
767
|
+
* Delete a data product domain identified by id.
|
|
768
|
+
*
|
|
769
|
+
* Delete a data product domain identified by id.
|
|
770
|
+
*
|
|
771
|
+
* @param {Object} params - The parameters to send to the service.
|
|
772
|
+
* @param {string} params.domainId - Domain id.
|
|
773
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
774
|
+
* @returns {Promise<DphV1.Response<DphV1.EmptyObject>>}
|
|
775
|
+
*/
|
|
776
|
+
deleteDomain(params: DphV1.DeleteDomainParams): Promise<DphV1.Response<DphV1.EmptyObject>>;
|
|
777
|
+
/**
|
|
778
|
+
* Update the data product domain identified by ID.
|
|
779
|
+
*
|
|
780
|
+
* Use this API to update the properties of a data product domain identified by a valid ID.<br/><br/>Specify patch
|
|
781
|
+
* operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the
|
|
782
|
+
* name of a data product domain<br/><br/>- Update the description of a data product domain<br/><br/>- Update the rov
|
|
783
|
+
* of a data product domain<br/><br/>.
|
|
784
|
+
*
|
|
785
|
+
* @param {Object} params - The parameters to send to the service.
|
|
786
|
+
* @param {string} params.domainId - Domain id.
|
|
787
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
788
|
+
* @param {JsonPatchOperation[]} params.jsonPatchInstructions - A set of patch operations as defined in RFC 6902. See
|
|
789
|
+
* http://jsonpatch.com/ for more information.
|
|
790
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
791
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductDomain>>}
|
|
792
|
+
*/
|
|
793
|
+
updateDataProductDomain(params: DphV1.UpdateDataProductDomainParams): Promise<DphV1.Response<DphV1.DataProductDomain>>;
|
|
794
|
+
/**
|
|
795
|
+
* Retrieve all data products in a domain specified by id or any of it's subdomains.
|
|
796
|
+
*
|
|
797
|
+
* Retrieve all the data products tagged to the domain identified by id or any of it's subdomains.
|
|
798
|
+
*
|
|
799
|
+
* @param {Object} params - The parameters to send to the service.
|
|
800
|
+
* @param {string} params.domainId - Domain id.
|
|
801
|
+
* @param {string} params.containerId - Container ID of the data product catalog.
|
|
802
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
803
|
+
* @returns {Promise<DphV1.Response<DphV1.DataProductVersionCollection>>}
|
|
804
|
+
*/
|
|
805
|
+
getDataProductByDomain(params: DphV1.GetDataProductByDomainParams): Promise<DphV1.Response<DphV1.DataProductVersionCollection>>;
|
|
806
|
+
/*************************
|
|
807
|
+
* bucketServices
|
|
808
|
+
************************/
|
|
809
|
+
/**
|
|
810
|
+
* Create a new Bucket.
|
|
811
|
+
*
|
|
812
|
+
* Use this API to create a new S3 Bucket on an AWS Hosting.
|
|
813
|
+
*
|
|
814
|
+
* @param {Object} params - The parameters to send to the service.
|
|
815
|
+
* @param {boolean} params.isShared - Flag to specify whether the bucket is dedicated or shared.
|
|
816
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
817
|
+
* @returns {Promise<DphV1.Response<DphV1.BucketResponse>>}
|
|
818
|
+
*/
|
|
819
|
+
createS3Bucket(params: DphV1.CreateS3BucketParams): Promise<DphV1.Response<DphV1.BucketResponse>>;
|
|
820
|
+
/**
|
|
821
|
+
* Validate the Bucket Existence.
|
|
822
|
+
*
|
|
823
|
+
* Use this API to validate the bucket existence on an AWS hosting.
|
|
824
|
+
*
|
|
825
|
+
* @param {Object} params - The parameters to send to the service.
|
|
826
|
+
* @param {string} params.bucketName - Name of the bucket to validate.
|
|
827
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
828
|
+
* @returns {Promise<DphV1.Response<DphV1.BucketValidationResponse>>}
|
|
829
|
+
*/
|
|
830
|
+
getS3BucketValidation(params: DphV1.GetS3BucketValidationParams): Promise<DphV1.Response<DphV1.BucketValidationResponse>>;
|
|
831
|
+
/*************************
|
|
832
|
+
* dataProductRevokeAccessJobRuns
|
|
833
|
+
************************/
|
|
834
|
+
/**
|
|
835
|
+
* Access revoke status of the subscriptions against the data product release id.
|
|
836
|
+
*
|
|
837
|
+
* Retrieves the status of revoke access requests.
|
|
838
|
+
*
|
|
839
|
+
* @param {Object} params - The parameters to send to the service.
|
|
840
|
+
* @param {string} params.releaseId - Pass the data product release version id to retrieve job runs state for that
|
|
841
|
+
* specific DPV ID.
|
|
842
|
+
* @param {number} [params.limit] - Limit the number of tracking assets in the results. The maximum is 200.
|
|
843
|
+
* @param {string} [params.start] - Start token for pagination.
|
|
844
|
+
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
|
|
845
|
+
* @returns {Promise<DphV1.Response<DphV1.RevokeAccessStateResponse>>}
|
|
414
846
|
*/
|
|
415
|
-
|
|
847
|
+
getRevokeAccessProcessState(params: DphV1.GetRevokeAccessProcessStateParams): Promise<DphV1.Response<DphV1.RevokeAccessStateResponse>>;
|
|
416
848
|
}
|
|
417
849
|
/*************************
|
|
418
850
|
* interfaces
|
|
@@ -467,14 +899,25 @@ declare namespace DphV1 {
|
|
|
467
899
|
WORKFLOWS = "workflows",
|
|
468
900
|
PROJECT = "project",
|
|
469
901
|
CATALOG_CONFIGURATIONS = "catalog_configurations",
|
|
470
|
-
FUNCTIONAL_ADMIN_USER_GROUP = "functional_admin_user_group"
|
|
471
|
-
ACCOUNT_OWNER_INTO_CATALOG_MEMBERS = "account_owner_into_catalog_members"
|
|
902
|
+
FUNCTIONAL_ADMIN_USER_GROUP = "functional_admin_user_group"
|
|
472
903
|
}
|
|
473
904
|
}
|
|
474
905
|
/** Parameters for the `manageApiKeys` operation. */
|
|
475
906
|
interface ManageApiKeysParams {
|
|
476
907
|
headers?: OutgoingHttpHeaders;
|
|
477
908
|
}
|
|
909
|
+
/** Parameters for the `createDataAssetVisualization` operation. */
|
|
910
|
+
interface CreateDataAssetVisualizationParams {
|
|
911
|
+
/** Data product hub asset and it's related part asset. */
|
|
912
|
+
assets?: DataAssetRelationship[];
|
|
913
|
+
headers?: OutgoingHttpHeaders;
|
|
914
|
+
}
|
|
915
|
+
/** Parameters for the `reinitiateDataAssetVisualization` operation. */
|
|
916
|
+
interface ReinitiateDataAssetVisualizationParams {
|
|
917
|
+
/** Data product hub asset and it's related part asset. */
|
|
918
|
+
assets?: DataAssetRelationship[];
|
|
919
|
+
headers?: OutgoingHttpHeaders;
|
|
920
|
+
}
|
|
478
921
|
/** Parameters for the `listDataProducts` operation. */
|
|
479
922
|
interface ListDataProductsParams {
|
|
480
923
|
/** Limit the number of data products in the results. The maximum limit is 200. */
|
|
@@ -486,7 +929,11 @@ declare namespace DphV1 {
|
|
|
486
929
|
/** Parameters for the `createDataProduct` operation. */
|
|
487
930
|
interface CreateDataProductParams {
|
|
488
931
|
/** Collection of data products drafts to add to data product. */
|
|
489
|
-
drafts:
|
|
932
|
+
drafts: DataProductDraftPrototype[];
|
|
933
|
+
/** Limit the number of data products in the results. The maximum limit is 200. */
|
|
934
|
+
limit?: number;
|
|
935
|
+
/** Start token for pagination. */
|
|
936
|
+
start?: string;
|
|
490
937
|
headers?: OutgoingHttpHeaders;
|
|
491
938
|
}
|
|
492
939
|
/** Parameters for the `getDataProduct` operation. */
|
|
@@ -552,11 +999,7 @@ declare namespace DphV1 {
|
|
|
552
999
|
/** Types of parts on the data product. */
|
|
553
1000
|
types?: CreateDataProductDraftConstants.Types[] | string[];
|
|
554
1001
|
/** Contract terms binding various aspects of the data product. */
|
|
555
|
-
contractTerms?:
|
|
556
|
-
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
557
|
-
* the data product requires explicit approval before data is delivered.
|
|
558
|
-
*/
|
|
559
|
-
isRestricted?: boolean;
|
|
1002
|
+
contractTerms?: ContractTerms[];
|
|
560
1003
|
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
561
1004
|
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
562
1005
|
* previous version of the data product.
|
|
@@ -569,6 +1012,20 @@ declare namespace DphV1 {
|
|
|
569
1012
|
partsOut?: DataProductPart[];
|
|
570
1013
|
/** The workflows associated with the data product version. */
|
|
571
1014
|
workflows?: DataProductWorkflows;
|
|
1015
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
1016
|
+
dataviewEnabled?: boolean;
|
|
1017
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
1018
|
+
comments?: string;
|
|
1019
|
+
/** Access control object. */
|
|
1020
|
+
accessControl?: AssetListAccessControl;
|
|
1021
|
+
/** Timestamp of last asset update. */
|
|
1022
|
+
lastUpdatedAt?: string;
|
|
1023
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
1024
|
+
subContainer?: ContainerIdentity;
|
|
1025
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1026
|
+
* the data product requires explicit approval before data is delivered.
|
|
1027
|
+
*/
|
|
1028
|
+
isRestricted?: boolean;
|
|
572
1029
|
headers?: OutgoingHttpHeaders;
|
|
573
1030
|
}
|
|
574
1031
|
/** Constants for the `createDataProductDraft` operation. */
|
|
@@ -673,34 +1130,138 @@ declare namespace DphV1 {
|
|
|
673
1130
|
jsonPatchInstructions: JsonPatchOperation[];
|
|
674
1131
|
headers?: OutgoingHttpHeaders;
|
|
675
1132
|
}
|
|
676
|
-
/** Parameters for the `
|
|
677
|
-
interface
|
|
1133
|
+
/** Parameters for the `getDataProductDraftContractTerms` operation. */
|
|
1134
|
+
interface GetDataProductDraftContractTermsParams {
|
|
678
1135
|
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
679
1136
|
dataProductId: string;
|
|
680
1137
|
/** Data product draft id. */
|
|
681
1138
|
draftId: string;
|
|
1139
|
+
/** Contract terms id. */
|
|
1140
|
+
contractTermsId: string;
|
|
1141
|
+
/** The type of the response: application/json or application/odcs+yaml. */
|
|
1142
|
+
accept?: GetDataProductDraftContractTermsConstants.Accept | string;
|
|
1143
|
+
/** Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By
|
|
1144
|
+
* default, these are included.
|
|
1145
|
+
*/
|
|
1146
|
+
includeContractDocuments?: boolean;
|
|
1147
|
+
/** Set to true to autopopulate server information from connection details. Default is false. */
|
|
1148
|
+
autopopulateServerInformation?: boolean;
|
|
1149
|
+
/** Asset ID of the server used for autopopulating connection details. */
|
|
1150
|
+
serverAssetId?: string;
|
|
682
1151
|
headers?: OutgoingHttpHeaders;
|
|
683
1152
|
}
|
|
684
|
-
/**
|
|
685
|
-
|
|
1153
|
+
/** Constants for the `getDataProductDraftContractTerms` operation. */
|
|
1154
|
+
namespace GetDataProductDraftContractTermsConstants {
|
|
1155
|
+
/** The type of the response: application/json or application/odcs+yaml. */
|
|
1156
|
+
enum Accept {
|
|
1157
|
+
APPLICATION_JSON = "application/json",
|
|
1158
|
+
APPLICATION_ODCS_YAML = "application/odcs+yaml"
|
|
1159
|
+
}
|
|
1160
|
+
}
|
|
1161
|
+
/** Parameters for the `replaceDataProductDraftContractTerms` operation. */
|
|
1162
|
+
interface ReplaceDataProductDraftContractTermsParams {
|
|
686
1163
|
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
687
1164
|
dataProductId: string;
|
|
688
|
-
/** Data product
|
|
689
|
-
|
|
690
|
-
/**
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
1165
|
+
/** Data product draft id. */
|
|
1166
|
+
draftId: string;
|
|
1167
|
+
/** Contract terms id. */
|
|
1168
|
+
contractTermsId: string;
|
|
1169
|
+
/** The reference schema for a asset in a container. */
|
|
1170
|
+
asset?: AssetReference;
|
|
1171
|
+
/** ID of the contract terms. */
|
|
1172
|
+
id?: string;
|
|
1173
|
+
/** Collection of contract terms documents. */
|
|
1174
|
+
documents?: ContractTermsDocument[];
|
|
1175
|
+
/** An error message, if existing, relating to the contract terms. */
|
|
1176
|
+
errorMsg?: string;
|
|
1177
|
+
/** Overview details of a data contract. */
|
|
1178
|
+
overview?: Overview;
|
|
1179
|
+
/** Description details of a data contract. */
|
|
1180
|
+
description?: Description;
|
|
1181
|
+
/** List of sub domains to be added within a domain. */
|
|
1182
|
+
organization?: ContractTemplateOrganization[];
|
|
1183
|
+
/** List of roles associated with the contract. */
|
|
1184
|
+
roles?: Roles[];
|
|
1185
|
+
/** Represents the pricing details of the contract. */
|
|
1186
|
+
price?: Pricing;
|
|
1187
|
+
/** Service Level Agreement details. */
|
|
1188
|
+
sla?: ContractTemplateSLA[];
|
|
1189
|
+
/** Support and communication details for the contract. */
|
|
1190
|
+
supportAndCommunication?: ContractTemplateSupportAndCommunication[];
|
|
1191
|
+
/** Custom properties that are not part of the standard contract. */
|
|
1192
|
+
customProperties?: ContractTemplateCustomProperty[];
|
|
1193
|
+
/** Contains the contract test status and related metadata. */
|
|
1194
|
+
contractTest?: ContractTest;
|
|
1195
|
+
/** List of server definitions. */
|
|
1196
|
+
servers?: ContractServer[];
|
|
1197
|
+
/** Schema details of the data asset. */
|
|
1198
|
+
schema?: ContractSchema[];
|
|
694
1199
|
headers?: OutgoingHttpHeaders;
|
|
695
1200
|
}
|
|
696
|
-
/** Parameters for the `
|
|
697
|
-
interface
|
|
1201
|
+
/** Parameters for the `updateDataProductDraftContractTerms` operation. */
|
|
1202
|
+
interface UpdateDataProductDraftContractTermsParams {
|
|
698
1203
|
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
699
1204
|
dataProductId: string;
|
|
700
|
-
/** Data product
|
|
701
|
-
|
|
702
|
-
/**
|
|
703
|
-
|
|
1205
|
+
/** Data product draft id. */
|
|
1206
|
+
draftId: string;
|
|
1207
|
+
/** Contract terms id. */
|
|
1208
|
+
contractTermsId: string;
|
|
1209
|
+
/** A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information. */
|
|
1210
|
+
jsonPatchInstructions: JsonPatchOperation[];
|
|
1211
|
+
headers?: OutgoingHttpHeaders;
|
|
1212
|
+
}
|
|
1213
|
+
/** Parameters for the `getContractTermsInSpecifiedFormat` operation. */
|
|
1214
|
+
interface GetContractTermsInSpecifiedFormatParams {
|
|
1215
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1216
|
+
dataProductId: string;
|
|
1217
|
+
/** Data product draft id. */
|
|
1218
|
+
draftId: string;
|
|
1219
|
+
/** Contract terms id. */
|
|
1220
|
+
contractTermsId: string;
|
|
1221
|
+
/** The format for returning contract terms. For example: odcs. */
|
|
1222
|
+
format: string;
|
|
1223
|
+
/** The version of the format for returning contract terms. For example: 3. */
|
|
1224
|
+
formatVersion: string;
|
|
1225
|
+
/** The type of the response: application/odcs+yaml or application/json. */
|
|
1226
|
+
accept?: GetContractTermsInSpecifiedFormatConstants.Accept | string;
|
|
1227
|
+
headers?: OutgoingHttpHeaders;
|
|
1228
|
+
}
|
|
1229
|
+
/** Constants for the `getContractTermsInSpecifiedFormat` operation. */
|
|
1230
|
+
namespace GetContractTermsInSpecifiedFormatConstants {
|
|
1231
|
+
/** The type of the response: application/odcs+yaml or application/json. */
|
|
1232
|
+
enum Accept {
|
|
1233
|
+
APPLICATION_ODCS_YAML = "application/odcs+yaml",
|
|
1234
|
+
APPLICATION_JSON = "application/json"
|
|
1235
|
+
}
|
|
1236
|
+
}
|
|
1237
|
+
/** Parameters for the `publishDataProductDraft` operation. */
|
|
1238
|
+
interface PublishDataProductDraftParams {
|
|
1239
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1240
|
+
dataProductId: string;
|
|
1241
|
+
/** Data product draft id. */
|
|
1242
|
+
draftId: string;
|
|
1243
|
+
headers?: OutgoingHttpHeaders;
|
|
1244
|
+
}
|
|
1245
|
+
/** Parameters for the `getDataProductRelease` operation. */
|
|
1246
|
+
interface GetDataProductReleaseParams {
|
|
1247
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1248
|
+
dataProductId: string;
|
|
1249
|
+
/** Data product release id. */
|
|
1250
|
+
releaseId: string;
|
|
1251
|
+
/** If the value is true, then it will be verfied whether the caller is present in the data access request
|
|
1252
|
+
* pre-approved user list.
|
|
1253
|
+
*/
|
|
1254
|
+
checkCallerApproval?: boolean;
|
|
1255
|
+
headers?: OutgoingHttpHeaders;
|
|
1256
|
+
}
|
|
1257
|
+
/** Parameters for the `updateDataProductRelease` operation. */
|
|
1258
|
+
interface UpdateDataProductReleaseParams {
|
|
1259
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1260
|
+
dataProductId: string;
|
|
1261
|
+
/** Data product release id. */
|
|
1262
|
+
releaseId: string;
|
|
1263
|
+
/** A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information. */
|
|
1264
|
+
jsonPatchInstructions: JsonPatchOperation[];
|
|
704
1265
|
headers?: OutgoingHttpHeaders;
|
|
705
1266
|
}
|
|
706
1267
|
/** Parameters for the `getReleaseContractTermsDocument` operation. */
|
|
@@ -715,6 +1276,30 @@ declare namespace DphV1 {
|
|
|
715
1276
|
documentId: string;
|
|
716
1277
|
headers?: OutgoingHttpHeaders;
|
|
717
1278
|
}
|
|
1279
|
+
/** Parameters for the `getPublishedDataProductDraftContractTerms` operation. */
|
|
1280
|
+
interface GetPublishedDataProductDraftContractTermsParams {
|
|
1281
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1282
|
+
dataProductId: string;
|
|
1283
|
+
/** Data product release id. */
|
|
1284
|
+
releaseId: string;
|
|
1285
|
+
/** Contract terms id. */
|
|
1286
|
+
contractTermsId: string;
|
|
1287
|
+
/** The type of the response: application/odcs+yaml or application/json. */
|
|
1288
|
+
accept?: GetPublishedDataProductDraftContractTermsConstants.Accept | string;
|
|
1289
|
+
/** Set to false to exclude external contract documents (e.g., Terms and Conditions URLs) from the response. By
|
|
1290
|
+
* default, these are included.
|
|
1291
|
+
*/
|
|
1292
|
+
includeContractDocuments?: boolean;
|
|
1293
|
+
headers?: OutgoingHttpHeaders;
|
|
1294
|
+
}
|
|
1295
|
+
/** Constants for the `getPublishedDataProductDraftContractTerms` operation. */
|
|
1296
|
+
namespace GetPublishedDataProductDraftContractTermsConstants {
|
|
1297
|
+
/** The type of the response: application/odcs+yaml or application/json. */
|
|
1298
|
+
enum Accept {
|
|
1299
|
+
APPLICATION_ODCS_YAML = "application/odcs+yaml",
|
|
1300
|
+
APPLICATION_JSON = "application/json"
|
|
1301
|
+
}
|
|
1302
|
+
}
|
|
718
1303
|
/** Parameters for the `listDataProductReleases` operation. */
|
|
719
1304
|
interface ListDataProductReleasesParams {
|
|
720
1305
|
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
@@ -747,17 +1332,231 @@ declare namespace DphV1 {
|
|
|
747
1332
|
dataProductId: string;
|
|
748
1333
|
/** Data product release id. */
|
|
749
1334
|
releaseId: string;
|
|
1335
|
+
/** Revoke's Access from all the Subscriptions of the Data Product. No user's can able to see the subscribed
|
|
1336
|
+
* assets anymore.
|
|
1337
|
+
*/
|
|
1338
|
+
revokeAccess?: boolean;
|
|
1339
|
+
/** The date and time when the revoke access operation should start (ISO 8601 format, e.g.,
|
|
1340
|
+
* 2025-09-24T06:55:29Z). If not provided, the operation starts immediately.
|
|
1341
|
+
*/
|
|
1342
|
+
startAt?: string;
|
|
1343
|
+
headers?: OutgoingHttpHeaders;
|
|
1344
|
+
}
|
|
1345
|
+
/** Parameters for the `createRevokeAccessProcess` operation. */
|
|
1346
|
+
interface CreateRevokeAccessProcessParams {
|
|
1347
|
+
/** Data product ID. Use '-' to skip specifying the data product ID explicitly. */
|
|
1348
|
+
dataProductId: string;
|
|
1349
|
+
/** The unique identifier of the data product release. */
|
|
1350
|
+
releaseId: string;
|
|
1351
|
+
/** Request parameters to handle revoke access from subscriptions. The start_at field can be used to schedule
|
|
1352
|
+
* the revoke access operation for a future date-time.
|
|
1353
|
+
*/
|
|
1354
|
+
body?: NodeJS.ReadableStream | Buffer;
|
|
1355
|
+
/** The type of the input. */
|
|
1356
|
+
contentType?: string;
|
|
1357
|
+
headers?: OutgoingHttpHeaders;
|
|
1358
|
+
}
|
|
1359
|
+
/** Parameters for the `listDataProductContractTemplate` operation. */
|
|
1360
|
+
interface ListDataProductContractTemplateParams {
|
|
1361
|
+
/** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
|
|
1362
|
+
* the uid of the default data product catalog.
|
|
1363
|
+
*/
|
|
1364
|
+
containerId?: string;
|
|
1365
|
+
/** Name of the data product contract template. If not supplied, the data product templates within the catalog
|
|
1366
|
+
* will returned.
|
|
1367
|
+
*/
|
|
1368
|
+
contractTemplateName?: string;
|
|
1369
|
+
/** Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product
|
|
1370
|
+
* templates within the catalog will returned.
|
|
1371
|
+
*/
|
|
1372
|
+
domainIds?: string;
|
|
1373
|
+
headers?: OutgoingHttpHeaders;
|
|
1374
|
+
}
|
|
1375
|
+
/** Parameters for the `createContractTemplate` operation. */
|
|
1376
|
+
interface CreateContractTemplateParams {
|
|
1377
|
+
/** Container reference. */
|
|
1378
|
+
container: ContainerReference;
|
|
1379
|
+
/** The identifier of the data product contract template. */
|
|
1380
|
+
id?: string;
|
|
1381
|
+
/** The identifier of the user who created the data product contract template. */
|
|
1382
|
+
creatorId?: string;
|
|
1383
|
+
/** The timestamp when the data product contract template was created. */
|
|
1384
|
+
createdAt?: string;
|
|
1385
|
+
/** The name of the contract template. */
|
|
1386
|
+
name?: string;
|
|
1387
|
+
/** Contains the code and details. */
|
|
1388
|
+
error?: ErrorMessage;
|
|
1389
|
+
/** Defines the complete structure of a contract terms. */
|
|
1390
|
+
contractTerms?: ContractTerms;
|
|
1391
|
+
/** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
|
|
1392
|
+
* the uid of the default data product catalog.
|
|
1393
|
+
*/
|
|
1394
|
+
containerId?: string;
|
|
1395
|
+
/** Name of the data product contract template. If not supplied, the data product templates within the catalog
|
|
1396
|
+
* will returned.
|
|
1397
|
+
*/
|
|
1398
|
+
contractTemplateName?: string;
|
|
1399
|
+
/** Comma-separated domain IDs to filter data product contract templates. If not supplied, the data product
|
|
1400
|
+
* templates within the catalog will returned.
|
|
1401
|
+
*/
|
|
1402
|
+
domainIds?: string;
|
|
1403
|
+
headers?: OutgoingHttpHeaders;
|
|
1404
|
+
}
|
|
1405
|
+
/** Parameters for the `getContractTemplate` operation. */
|
|
1406
|
+
interface GetContractTemplateParams {
|
|
1407
|
+
/** Data Product Contract Template id. */
|
|
1408
|
+
contractTemplateId: string;
|
|
1409
|
+
/** Container ID of the data product catalog. */
|
|
1410
|
+
containerId: string;
|
|
1411
|
+
headers?: OutgoingHttpHeaders;
|
|
1412
|
+
}
|
|
1413
|
+
/** Parameters for the `deleteDataProductContractTemplate` operation. */
|
|
1414
|
+
interface DeleteDataProductContractTemplateParams {
|
|
1415
|
+
/** Data Product Contract Template id. */
|
|
1416
|
+
contractTemplateId: string;
|
|
1417
|
+
/** Container ID of the data product catalog. */
|
|
1418
|
+
containerId: string;
|
|
1419
|
+
headers?: OutgoingHttpHeaders;
|
|
1420
|
+
}
|
|
1421
|
+
/** Parameters for the `updateDataProductContractTemplate` operation. */
|
|
1422
|
+
interface UpdateDataProductContractTemplateParams {
|
|
1423
|
+
/** Data Product Contract Template id. */
|
|
1424
|
+
contractTemplateId: string;
|
|
1425
|
+
/** Container ID of the data product catalog. */
|
|
1426
|
+
containerId: string;
|
|
1427
|
+
/** A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information. */
|
|
1428
|
+
jsonPatchInstructions: JsonPatchOperation[];
|
|
1429
|
+
headers?: OutgoingHttpHeaders;
|
|
1430
|
+
}
|
|
1431
|
+
/** Parameters for the `listDataProductDomains` operation. */
|
|
1432
|
+
interface ListDataProductDomainsParams {
|
|
1433
|
+
/** Container ID of the data product catalog. If not supplied, the data product catalog is looked up by using
|
|
1434
|
+
* the uid of the default data product catalog.
|
|
1435
|
+
*/
|
|
1436
|
+
containerId?: string;
|
|
1437
|
+
/** Include subdomains in the response. */
|
|
1438
|
+
includeSubdomains?: boolean;
|
|
1439
|
+
headers?: OutgoingHttpHeaders;
|
|
1440
|
+
}
|
|
1441
|
+
/** Parameters for the `createDataProductDomain` operation. */
|
|
1442
|
+
interface CreateDataProductDomainParams {
|
|
1443
|
+
/** Container reference. */
|
|
1444
|
+
container: ContainerReference;
|
|
1445
|
+
/** The id to trace the failed domain creations. */
|
|
1446
|
+
trace?: string;
|
|
1447
|
+
/** Set of errors on the sub domain creation. */
|
|
1448
|
+
errors?: ErrorModelResource[];
|
|
1449
|
+
/** The name of the data product domain. */
|
|
1450
|
+
name?: string;
|
|
1451
|
+
/** The description of the data product domain. */
|
|
1452
|
+
description?: string;
|
|
1453
|
+
/** The identifier of the data product domain. */
|
|
1454
|
+
id?: string;
|
|
1455
|
+
/** The identifier of the creator of the data product domain. */
|
|
1456
|
+
createdBy?: string;
|
|
1457
|
+
/** Member roles of a corresponding asset. */
|
|
1458
|
+
memberRoles?: MemberRolesSchema;
|
|
1459
|
+
/** Properties of the corresponding asset. */
|
|
1460
|
+
properties?: PropertiesSchema;
|
|
1461
|
+
/** List of sub domains to be added within a domain. */
|
|
1462
|
+
subDomains?: InitializeSubDomain[];
|
|
1463
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
1464
|
+
subContainer?: ContainerIdentity;
|
|
1465
|
+
/** Link domains to subcontainers. */
|
|
1466
|
+
linkToSubcontainers?: boolean;
|
|
1467
|
+
headers?: OutgoingHttpHeaders;
|
|
1468
|
+
}
|
|
1469
|
+
/** Parameters for the `createDataProductSubdomain` operation. */
|
|
1470
|
+
interface CreateDataProductSubdomainParams {
|
|
1471
|
+
/** Domain id. */
|
|
1472
|
+
domainId: string;
|
|
1473
|
+
/** Container ID of the data product catalog. */
|
|
1474
|
+
containerId: string;
|
|
1475
|
+
/** The name of the data product subdomain. */
|
|
1476
|
+
name?: string;
|
|
1477
|
+
/** The identifier of the data product subdomain. */
|
|
1478
|
+
id?: string;
|
|
1479
|
+
/** The description of the data product subdomain. */
|
|
1480
|
+
description?: string;
|
|
1481
|
+
headers?: OutgoingHttpHeaders;
|
|
1482
|
+
}
|
|
1483
|
+
/** Parameters for the `getDomain` operation. */
|
|
1484
|
+
interface GetDomainParams {
|
|
1485
|
+
/** Domain id. */
|
|
1486
|
+
domainId: string;
|
|
1487
|
+
headers?: OutgoingHttpHeaders;
|
|
1488
|
+
}
|
|
1489
|
+
/** Parameters for the `deleteDomain` operation. */
|
|
1490
|
+
interface DeleteDomainParams {
|
|
1491
|
+
/** Domain id. */
|
|
1492
|
+
domainId: string;
|
|
1493
|
+
headers?: OutgoingHttpHeaders;
|
|
1494
|
+
}
|
|
1495
|
+
/** Parameters for the `updateDataProductDomain` operation. */
|
|
1496
|
+
interface UpdateDataProductDomainParams {
|
|
1497
|
+
/** Domain id. */
|
|
1498
|
+
domainId: string;
|
|
1499
|
+
/** Container ID of the data product catalog. */
|
|
1500
|
+
containerId: string;
|
|
1501
|
+
/** A set of patch operations as defined in RFC 6902. See http://jsonpatch.com/ for more information. */
|
|
1502
|
+
jsonPatchInstructions: JsonPatchOperation[];
|
|
1503
|
+
headers?: OutgoingHttpHeaders;
|
|
1504
|
+
}
|
|
1505
|
+
/** Parameters for the `getDataProductByDomain` operation. */
|
|
1506
|
+
interface GetDataProductByDomainParams {
|
|
1507
|
+
/** Domain id. */
|
|
1508
|
+
domainId: string;
|
|
1509
|
+
/** Container ID of the data product catalog. */
|
|
1510
|
+
containerId: string;
|
|
1511
|
+
headers?: OutgoingHttpHeaders;
|
|
1512
|
+
}
|
|
1513
|
+
/** Parameters for the `createS3Bucket` operation. */
|
|
1514
|
+
interface CreateS3BucketParams {
|
|
1515
|
+
/** Flag to specify whether the bucket is dedicated or shared. */
|
|
1516
|
+
isShared: boolean;
|
|
1517
|
+
headers?: OutgoingHttpHeaders;
|
|
1518
|
+
}
|
|
1519
|
+
/** Parameters for the `getS3BucketValidation` operation. */
|
|
1520
|
+
interface GetS3BucketValidationParams {
|
|
1521
|
+
/** Name of the bucket to validate. */
|
|
1522
|
+
bucketName: string;
|
|
1523
|
+
headers?: OutgoingHttpHeaders;
|
|
1524
|
+
}
|
|
1525
|
+
/** Parameters for the `getRevokeAccessProcessState` operation. */
|
|
1526
|
+
interface GetRevokeAccessProcessStateParams {
|
|
1527
|
+
/** Pass the data product release version id to retrieve job runs state for that specific DPV ID. */
|
|
1528
|
+
releaseId: string;
|
|
1529
|
+
/** Limit the number of tracking assets in the results. The maximum is 200. */
|
|
1530
|
+
limit?: number;
|
|
1531
|
+
/** Start token for pagination. */
|
|
1532
|
+
start?: string;
|
|
750
1533
|
headers?: OutgoingHttpHeaders;
|
|
751
1534
|
}
|
|
752
1535
|
/*************************
|
|
753
1536
|
* model interfaces
|
|
754
1537
|
************************/
|
|
1538
|
+
/**
|
|
1539
|
+
* Asset.
|
|
1540
|
+
*/
|
|
1541
|
+
interface Asset {
|
|
1542
|
+
metadata?: JsonObject;
|
|
1543
|
+
entity?: JsonObject;
|
|
1544
|
+
}
|
|
1545
|
+
/**
|
|
1546
|
+
* Access control object.
|
|
1547
|
+
*/
|
|
1548
|
+
interface AssetListAccessControl {
|
|
1549
|
+
/** The owner of the asset. */
|
|
1550
|
+
owner?: string;
|
|
1551
|
+
}
|
|
755
1552
|
/**
|
|
756
1553
|
* The asset represented in this part.
|
|
757
1554
|
*/
|
|
758
1555
|
interface AssetPartReference {
|
|
759
1556
|
/** The unique identifier of the asset. */
|
|
760
1557
|
id?: string;
|
|
1558
|
+
/** Asset name. */
|
|
1559
|
+
name?: string;
|
|
761
1560
|
/** Container reference. */
|
|
762
1561
|
container: ContainerReference;
|
|
763
1562
|
/** The type of the asset. */
|
|
@@ -769,19 +1568,44 @@ declare namespace DphV1 {
|
|
|
769
1568
|
interface AssetPrototype {
|
|
770
1569
|
/** The unique identifier of the asset. */
|
|
771
1570
|
id?: string;
|
|
1571
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
772
1572
|
container: ContainerIdentity;
|
|
773
1573
|
}
|
|
774
1574
|
/**
|
|
775
|
-
*
|
|
1575
|
+
* The reference schema for a asset in a container.
|
|
776
1576
|
*/
|
|
777
1577
|
interface AssetReference {
|
|
778
1578
|
/** The unique identifier of the asset. */
|
|
779
1579
|
id?: string;
|
|
1580
|
+
/** Asset name. */
|
|
1581
|
+
name?: string;
|
|
780
1582
|
/** Container reference. */
|
|
781
1583
|
container: ContainerReference;
|
|
782
1584
|
}
|
|
783
1585
|
/**
|
|
784
|
-
*
|
|
1586
|
+
* BucketResponse to hold the Bucket response data.
|
|
1587
|
+
*/
|
|
1588
|
+
interface BucketResponse {
|
|
1589
|
+
/** Name of the Bucket. */
|
|
1590
|
+
bucket_name?: string;
|
|
1591
|
+
/** Location of the Bucket stored. */
|
|
1592
|
+
bucket_location?: string;
|
|
1593
|
+
/** Role ARN. */
|
|
1594
|
+
role_arn?: string;
|
|
1595
|
+
/** Bucket Type. */
|
|
1596
|
+
bucket_type?: string;
|
|
1597
|
+
/** Is Shared Bucket. */
|
|
1598
|
+
shared?: boolean;
|
|
1599
|
+
}
|
|
1600
|
+
/**
|
|
1601
|
+
* BucketValidationResponse to hold the bucket validation data.
|
|
1602
|
+
*/
|
|
1603
|
+
interface BucketValidationResponse {
|
|
1604
|
+
/** Flag of bucket existence. */
|
|
1605
|
+
bucket_exists?: boolean;
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* The identity schema for a IBM knowledge catalog container (catalog/project/space).
|
|
785
1609
|
*/
|
|
786
1610
|
interface ContainerIdentity {
|
|
787
1611
|
/** Container identifier. */
|
|
@@ -805,6 +1629,244 @@ declare namespace DphV1 {
|
|
|
805
1629
|
}
|
|
806
1630
|
}
|
|
807
1631
|
}
|
|
1632
|
+
/**
|
|
1633
|
+
* Defines a data asset name and id.
|
|
1634
|
+
*/
|
|
1635
|
+
interface ContractAsset {
|
|
1636
|
+
/** ID of the data asset. */
|
|
1637
|
+
id?: string;
|
|
1638
|
+
/** Name of the data asset. */
|
|
1639
|
+
name?: string;
|
|
1640
|
+
}
|
|
1641
|
+
/**
|
|
1642
|
+
* Defines a quality rule for validating data assets.
|
|
1643
|
+
*/
|
|
1644
|
+
interface ContractQualityRule {
|
|
1645
|
+
/** The type of the quality rule: 'text', 'library', or 'sql'. */
|
|
1646
|
+
type: string;
|
|
1647
|
+
/** A descriptive explanation of the quality rule. */
|
|
1648
|
+
description?: string;
|
|
1649
|
+
/** The name or identifier of the library-based quality rule to be applied. */
|
|
1650
|
+
rule?: string;
|
|
1651
|
+
/** A text (non-parsed) block of code required for the third-party DQ engine to run. */
|
|
1652
|
+
implementation?: string;
|
|
1653
|
+
/** Required for custom DQ rule: name of the third-party engine being used. Common values include soda,
|
|
1654
|
+
* greatExpectations, montecarlo, etc.
|
|
1655
|
+
*/
|
|
1656
|
+
engine?: string;
|
|
1657
|
+
/** The threshold value that the quality check result must be less than. */
|
|
1658
|
+
must_be_less_than?: string;
|
|
1659
|
+
/** The threshold value that the quality check result must be less than or equal to. */
|
|
1660
|
+
must_be_less_or_equal_to?: string;
|
|
1661
|
+
/** The threshold value that the quality check result must be greater than. */
|
|
1662
|
+
must_be_greater_than?: string;
|
|
1663
|
+
/** The threshold value that the quality check result must be greater than or equal to. */
|
|
1664
|
+
must_be_greater_or_equal_to?: string;
|
|
1665
|
+
/** Inclusive range (min and max) for the quality check result. */
|
|
1666
|
+
must_be_between?: string[];
|
|
1667
|
+
/** Inclusive range (min and max) the quality check must not fall within. */
|
|
1668
|
+
must_not_be_between?: string[];
|
|
1669
|
+
/** The exact value(s) the quality check result must match. */
|
|
1670
|
+
must_be?: string;
|
|
1671
|
+
/** The exact value(s) the quality check result must not match. */
|
|
1672
|
+
must_not_be?: string;
|
|
1673
|
+
/** User-friendly name for the quality rule. */
|
|
1674
|
+
name?: string;
|
|
1675
|
+
/** Unit used for evaluating the quality rule (e.g., rows, records). */
|
|
1676
|
+
unit?: string;
|
|
1677
|
+
/** The SQL query to execute for validating quality in case of a 'sql' rule type. */
|
|
1678
|
+
query?: string;
|
|
1679
|
+
}
|
|
1680
|
+
/**
|
|
1681
|
+
* Schema definition of the data asset.
|
|
1682
|
+
*/
|
|
1683
|
+
interface ContractSchema {
|
|
1684
|
+
/** Id of the data asset whose schema information is stored. */
|
|
1685
|
+
asset_id: string;
|
|
1686
|
+
/** Connection Id of the data asset whose schema information is stored. */
|
|
1687
|
+
connection_id: string;
|
|
1688
|
+
/** Name of the schema or data asset part. */
|
|
1689
|
+
name?: string;
|
|
1690
|
+
/** Description of the schema. */
|
|
1691
|
+
description?: string;
|
|
1692
|
+
/** Connection path of the asset. */
|
|
1693
|
+
connection_path?: string;
|
|
1694
|
+
/** MIME type or physical type. */
|
|
1695
|
+
physical_type?: string;
|
|
1696
|
+
/** List of properties. */
|
|
1697
|
+
properties?: ContractSchemaProperty[];
|
|
1698
|
+
/** List of quality rules defined for the asset. */
|
|
1699
|
+
quality?: ContractQualityRule[];
|
|
1700
|
+
}
|
|
1701
|
+
/**
|
|
1702
|
+
* Defines a property inside the schema.
|
|
1703
|
+
*/
|
|
1704
|
+
interface ContractSchemaProperty {
|
|
1705
|
+
/** Property name. */
|
|
1706
|
+
name: string;
|
|
1707
|
+
/** Detailed type definition of a schema property. */
|
|
1708
|
+
type?: ContractSchemaPropertyType;
|
|
1709
|
+
/** List of quality rules defined for the column. */
|
|
1710
|
+
quality?: ContractQualityRule[];
|
|
1711
|
+
}
|
|
1712
|
+
/**
|
|
1713
|
+
* Detailed type definition of a schema property.
|
|
1714
|
+
*/
|
|
1715
|
+
interface ContractSchemaPropertyType {
|
|
1716
|
+
/** Type of the field. */
|
|
1717
|
+
type?: string;
|
|
1718
|
+
/** Length of the field as string. */
|
|
1719
|
+
length?: string;
|
|
1720
|
+
/** Scale of the field as string. */
|
|
1721
|
+
scale?: string;
|
|
1722
|
+
/** Is field nullable? true/false as string. */
|
|
1723
|
+
nullable?: string;
|
|
1724
|
+
/** Is field signed? true/false as string. */
|
|
1725
|
+
signed?: string;
|
|
1726
|
+
/** Native type of the field. */
|
|
1727
|
+
native_type?: string;
|
|
1728
|
+
}
|
|
1729
|
+
/**
|
|
1730
|
+
* Schema definition of a server configuration for the asset.
|
|
1731
|
+
*/
|
|
1732
|
+
interface ContractServer {
|
|
1733
|
+
/** Name of the server. */
|
|
1734
|
+
server: string;
|
|
1735
|
+
/** Defines a data asset name and id. */
|
|
1736
|
+
asset?: ContractAsset;
|
|
1737
|
+
/** ID of the data source associated with data asset. */
|
|
1738
|
+
connection_id?: string;
|
|
1739
|
+
/** Type of the server. */
|
|
1740
|
+
type?: string;
|
|
1741
|
+
/** Description of the server. */
|
|
1742
|
+
description?: string;
|
|
1743
|
+
/** Environment in which the server operates. */
|
|
1744
|
+
environment?: string;
|
|
1745
|
+
/** Account used by the server. */
|
|
1746
|
+
account?: string;
|
|
1747
|
+
/** Catalog name. */
|
|
1748
|
+
catalog?: string;
|
|
1749
|
+
/** Database name. */
|
|
1750
|
+
database?: string;
|
|
1751
|
+
/** Dataset name. */
|
|
1752
|
+
dataset?: string;
|
|
1753
|
+
/** Delimiter. */
|
|
1754
|
+
delimiter?: string;
|
|
1755
|
+
/** Server endpoint URL. */
|
|
1756
|
+
endpoint_url?: string;
|
|
1757
|
+
/** File format. */
|
|
1758
|
+
format?: string;
|
|
1759
|
+
/** Host name or IP address. */
|
|
1760
|
+
host?: string;
|
|
1761
|
+
/** Location URL. */
|
|
1762
|
+
location?: string;
|
|
1763
|
+
/** Relative or absolute path to the data. */
|
|
1764
|
+
path?: string;
|
|
1765
|
+
/** Port to the server. */
|
|
1766
|
+
port?: string;
|
|
1767
|
+
/** Project name. */
|
|
1768
|
+
project?: string;
|
|
1769
|
+
/** Cloud region. */
|
|
1770
|
+
region?: string;
|
|
1771
|
+
/** Region name. */
|
|
1772
|
+
region_name?: string;
|
|
1773
|
+
/** Schema name. */
|
|
1774
|
+
schema?: string;
|
|
1775
|
+
/** Service name. */
|
|
1776
|
+
service_name?: string;
|
|
1777
|
+
/** Staging directory. */
|
|
1778
|
+
staging_dir?: string;
|
|
1779
|
+
/** Data stream name. */
|
|
1780
|
+
stream?: string;
|
|
1781
|
+
/** Warehouse or cluster name. */
|
|
1782
|
+
warehouse?: string;
|
|
1783
|
+
/** List of roles for the server. */
|
|
1784
|
+
roles?: string[];
|
|
1785
|
+
/** List of custom properties for the server. */
|
|
1786
|
+
custom_properties?: ContractTemplateCustomProperty[];
|
|
1787
|
+
}
|
|
1788
|
+
/**
|
|
1789
|
+
* Represents a custom property within the contract.
|
|
1790
|
+
*/
|
|
1791
|
+
interface ContractTemplateCustomProperty {
|
|
1792
|
+
/** The name of the key. Names should be in camel case–the same as if they were permanent properties in the
|
|
1793
|
+
* contract.
|
|
1794
|
+
*/
|
|
1795
|
+
key: string;
|
|
1796
|
+
/** The value of the key. */
|
|
1797
|
+
value: string;
|
|
1798
|
+
}
|
|
1799
|
+
/**
|
|
1800
|
+
* Represents a user and their role in the contract.
|
|
1801
|
+
*/
|
|
1802
|
+
interface ContractTemplateOrganization {
|
|
1803
|
+
/** The user ID associated with the contract. */
|
|
1804
|
+
user_id: string;
|
|
1805
|
+
/** The role of the user in the contract. */
|
|
1806
|
+
role: string;
|
|
1807
|
+
}
|
|
1808
|
+
/**
|
|
1809
|
+
* Represents the SLA details of the contract.
|
|
1810
|
+
*/
|
|
1811
|
+
interface ContractTemplateSLA {
|
|
1812
|
+
/** The default SLA element. */
|
|
1813
|
+
default_element?: string;
|
|
1814
|
+
/** List of SLA properties and their values. */
|
|
1815
|
+
properties?: ContractTemplateSLAProperty[];
|
|
1816
|
+
}
|
|
1817
|
+
/**
|
|
1818
|
+
* Represents an SLA property and its value.
|
|
1819
|
+
*/
|
|
1820
|
+
interface ContractTemplateSLAProperty {
|
|
1821
|
+
/** The SLA property name. */
|
|
1822
|
+
property: string;
|
|
1823
|
+
/** The value associated with the SLA property. */
|
|
1824
|
+
value: string;
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* Represents a support and communication channel for the contract.
|
|
1828
|
+
*/
|
|
1829
|
+
interface ContractTemplateSupportAndCommunication {
|
|
1830
|
+
/** The communication channel. */
|
|
1831
|
+
channel: string;
|
|
1832
|
+
/** The URL associated with the communication channel. */
|
|
1833
|
+
url: string;
|
|
1834
|
+
}
|
|
1835
|
+
/**
|
|
1836
|
+
* Defines the complete structure of a contract terms.
|
|
1837
|
+
*/
|
|
1838
|
+
interface ContractTerms {
|
|
1839
|
+
/** The reference schema for a asset in a container. */
|
|
1840
|
+
asset?: AssetReference;
|
|
1841
|
+
/** ID of the contract terms. */
|
|
1842
|
+
id?: string;
|
|
1843
|
+
/** Collection of contract terms documents. */
|
|
1844
|
+
documents?: ContractTermsDocument[];
|
|
1845
|
+
/** An error message, if existing, relating to the contract terms. */
|
|
1846
|
+
error_msg?: string;
|
|
1847
|
+
/** Overview details of a data contract. */
|
|
1848
|
+
overview?: Overview;
|
|
1849
|
+
/** Description details of a data contract. */
|
|
1850
|
+
description?: Description;
|
|
1851
|
+
/** List of sub domains to be added within a domain. */
|
|
1852
|
+
organization?: ContractTemplateOrganization[];
|
|
1853
|
+
/** List of roles associated with the contract. */
|
|
1854
|
+
roles?: Roles[];
|
|
1855
|
+
/** Represents the pricing details of the contract. */
|
|
1856
|
+
price?: Pricing;
|
|
1857
|
+
/** Service Level Agreement details. */
|
|
1858
|
+
sla?: ContractTemplateSLA[];
|
|
1859
|
+
/** Support and communication details for the contract. */
|
|
1860
|
+
support_and_communication?: ContractTemplateSupportAndCommunication[];
|
|
1861
|
+
/** Custom properties that are not part of the standard contract. */
|
|
1862
|
+
custom_properties?: ContractTemplateCustomProperty[];
|
|
1863
|
+
/** Contains the contract test status and related metadata. */
|
|
1864
|
+
contract_test?: ContractTest;
|
|
1865
|
+
/** List of server definitions. */
|
|
1866
|
+
servers?: ContractServer[];
|
|
1867
|
+
/** Schema details of the data asset. */
|
|
1868
|
+
schema?: ContractSchema[];
|
|
1869
|
+
}
|
|
808
1870
|
/**
|
|
809
1871
|
* Standard contract terms document, which is used for get and list contract terms responses.
|
|
810
1872
|
*/
|
|
@@ -838,51 +1900,416 @@ declare namespace DphV1 {
|
|
|
838
1900
|
/** Id representing the corresponding attachment. */
|
|
839
1901
|
id?: string;
|
|
840
1902
|
}
|
|
1903
|
+
/**
|
|
1904
|
+
* List of links to sources that provide more details on the dataset.
|
|
1905
|
+
*/
|
|
1906
|
+
interface ContractTermsMoreInfo {
|
|
1907
|
+
/** Type of Source Link. */
|
|
1908
|
+
type: string;
|
|
1909
|
+
/** Link to source that provide more details on the dataset. */
|
|
1910
|
+
url: string;
|
|
1911
|
+
}
|
|
1912
|
+
/**
|
|
1913
|
+
* Contains the contract test status and related metadata.
|
|
1914
|
+
*/
|
|
1915
|
+
interface ContractTest {
|
|
1916
|
+
/** Status of the contract test (pass or fail). */
|
|
1917
|
+
status: ContractTest.Constants.Status | string;
|
|
1918
|
+
/** Timestamp of when the contract was last tested. */
|
|
1919
|
+
last_tested_time: string;
|
|
1920
|
+
/** Optional message or details about the contract test. */
|
|
1921
|
+
message?: string;
|
|
1922
|
+
}
|
|
1923
|
+
namespace ContractTest {
|
|
1924
|
+
namespace Constants {
|
|
1925
|
+
/** Status of the contract test (pass or fail). */
|
|
1926
|
+
enum Status {
|
|
1927
|
+
PASS = "pass",
|
|
1928
|
+
FAIL = "fail"
|
|
1929
|
+
}
|
|
1930
|
+
}
|
|
1931
|
+
}
|
|
1932
|
+
/**
|
|
1933
|
+
* Data members for visualization process.
|
|
1934
|
+
*/
|
|
1935
|
+
interface DataAssetRelationship {
|
|
1936
|
+
/** Data members for visualization. */
|
|
1937
|
+
visualization?: Visualization;
|
|
1938
|
+
/** The reference schema for a asset in a container. */
|
|
1939
|
+
asset: AssetReference;
|
|
1940
|
+
/** The reference schema for a asset in a container. */
|
|
1941
|
+
related_asset: AssetReference;
|
|
1942
|
+
/** Contains the code and details. */
|
|
1943
|
+
error?: ErrorMessage;
|
|
1944
|
+
}
|
|
1945
|
+
/**
|
|
1946
|
+
* Data relationships for the visualization process response.
|
|
1947
|
+
*/
|
|
1948
|
+
interface DataAssetVisualizationRes {
|
|
1949
|
+
/** Data asset Ids and their related asset Ids. */
|
|
1950
|
+
results?: DataAssetRelationship[];
|
|
1951
|
+
}
|
|
841
1952
|
/**
|
|
842
1953
|
* Data Product.
|
|
843
1954
|
*/
|
|
844
|
-
interface DataProduct {
|
|
1955
|
+
interface DataProduct {
|
|
1956
|
+
/** Data product identifier. */
|
|
1957
|
+
id: string;
|
|
1958
|
+
/** A data product draft version object. */
|
|
1959
|
+
release?: DataProductDraftVersionRelease;
|
|
1960
|
+
/** Container reference. */
|
|
1961
|
+
container: ContainerReference;
|
|
1962
|
+
/** Data product name. */
|
|
1963
|
+
name?: string;
|
|
1964
|
+
/** Summary of Data Product Version object. */
|
|
1965
|
+
latest_release?: DataProductVersionSummary;
|
|
1966
|
+
/** List of draft summaries of this data product. */
|
|
1967
|
+
drafts?: DataProductVersionSummary[];
|
|
1968
|
+
}
|
|
1969
|
+
/**
|
|
1970
|
+
* A collection of data product summaries.
|
|
1971
|
+
*/
|
|
1972
|
+
interface DataProductCollection {
|
|
1973
|
+
/** Set a limit on the number of results returned. */
|
|
1974
|
+
limit: number;
|
|
1975
|
+
/** First page in the collection. */
|
|
1976
|
+
first: FirstPage;
|
|
1977
|
+
/** Next page in the collection. */
|
|
1978
|
+
next?: NextPage;
|
|
1979
|
+
/** Indicates the total number of results returned. */
|
|
1980
|
+
total_results?: number;
|
|
1981
|
+
/** Collection of data product summaries. */
|
|
1982
|
+
data_products: DataProductSummary[];
|
|
1983
|
+
}
|
|
1984
|
+
/**
|
|
1985
|
+
* Defines the complete structure of a contract template.
|
|
1986
|
+
*/
|
|
1987
|
+
interface DataProductContractTemplate {
|
|
1988
|
+
/** Container reference. */
|
|
1989
|
+
container: ContainerReference;
|
|
1990
|
+
/** The identifier of the data product contract template. */
|
|
1991
|
+
id?: string;
|
|
1992
|
+
/** The identifier of the user who created the data product contract template. */
|
|
1993
|
+
creator_id?: string;
|
|
1994
|
+
/** The timestamp when the data product contract template was created. */
|
|
1995
|
+
created_at?: string;
|
|
1996
|
+
/** The name of the contract template. */
|
|
1997
|
+
name?: string;
|
|
1998
|
+
/** Contains the code and details. */
|
|
1999
|
+
error?: ErrorMessage;
|
|
2000
|
+
/** Defines the complete structure of a contract terms. */
|
|
2001
|
+
contract_terms?: ContractTerms;
|
|
2002
|
+
}
|
|
2003
|
+
/**
|
|
2004
|
+
* A collection of data product contract templates.
|
|
2005
|
+
*/
|
|
2006
|
+
interface DataProductContractTemplateCollection {
|
|
2007
|
+
/** Collection of data product contract templates. */
|
|
2008
|
+
contract_templates: DataProductContractTemplate[];
|
|
2009
|
+
}
|
|
2010
|
+
/**
|
|
2011
|
+
* A custom workflow definition to be used to create a workflow to approve a data product subscription.
|
|
2012
|
+
*/
|
|
2013
|
+
interface DataProductCustomWorkflowDefinition {
|
|
2014
|
+
/** ID of a workflow definition. */
|
|
2015
|
+
id?: string;
|
|
2016
|
+
}
|
|
2017
|
+
/**
|
|
2018
|
+
* The data product domain.
|
|
2019
|
+
*/
|
|
2020
|
+
interface DataProductDomain {
|
|
2021
|
+
/** Container reference. */
|
|
2022
|
+
container: ContainerReference;
|
|
2023
|
+
/** The id to trace the failed domain creations. */
|
|
2024
|
+
trace?: string;
|
|
2025
|
+
/** Set of errors on the sub domain creation. */
|
|
2026
|
+
errors?: ErrorModelResource[];
|
|
2027
|
+
/** The name of the data product domain. */
|
|
2028
|
+
name?: string;
|
|
2029
|
+
/** The description of the data product domain. */
|
|
2030
|
+
description?: string;
|
|
2031
|
+
/** The identifier of the data product domain. */
|
|
2032
|
+
id?: string;
|
|
2033
|
+
/** The identifier of the creator of the data product domain. */
|
|
2034
|
+
created_by?: string;
|
|
2035
|
+
/** Member roles of a corresponding asset. */
|
|
2036
|
+
member_roles?: MemberRolesSchema;
|
|
2037
|
+
/** Properties of the corresponding asset. */
|
|
2038
|
+
properties?: PropertiesSchema;
|
|
2039
|
+
/** List of sub domains to be added within a domain. */
|
|
2040
|
+
sub_domains?: InitializeSubDomain[];
|
|
2041
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
2042
|
+
sub_container?: ContainerIdentity;
|
|
2043
|
+
}
|
|
2044
|
+
/**
|
|
2045
|
+
* A collection of data product domains.
|
|
2046
|
+
*/
|
|
2047
|
+
interface DataProductDomainCollection {
|
|
2048
|
+
/** Collection of data product domains. */
|
|
2049
|
+
domains: DataProductDomain[];
|
|
2050
|
+
}
|
|
2051
|
+
/**
|
|
2052
|
+
* Data Product version draft.
|
|
2053
|
+
*/
|
|
2054
|
+
interface DataProductDraft {
|
|
2055
|
+
/** The data product version number. */
|
|
2056
|
+
version: string;
|
|
2057
|
+
/** The state of the data product version. */
|
|
2058
|
+
state: DataProductDraft.Constants.State | string;
|
|
2059
|
+
/** Data product reference. */
|
|
2060
|
+
data_product: DataProductDraftDataProduct;
|
|
2061
|
+
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
2062
|
+
* periods. Names are mutable and reusable.
|
|
2063
|
+
*/
|
|
2064
|
+
name: string;
|
|
2065
|
+
/** The description of the data product version. */
|
|
2066
|
+
description: string;
|
|
2067
|
+
/** Tags on the data product. */
|
|
2068
|
+
tags: string[];
|
|
2069
|
+
/** A list of use cases associated with the data product version. */
|
|
2070
|
+
use_cases?: UseCase[];
|
|
2071
|
+
/** Types of parts on the data product. */
|
|
2072
|
+
types: DataProductDraft.Constants.Types[] | string[];
|
|
2073
|
+
/** Contract terms binding various aspects of the data product. */
|
|
2074
|
+
contract_terms: ContractTerms[];
|
|
2075
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2076
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2077
|
+
* previous version of the data product.
|
|
2078
|
+
*/
|
|
2079
|
+
domain: Domain;
|
|
2080
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
2081
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
2082
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
2083
|
+
*/
|
|
2084
|
+
parts_out: DataProductPart[];
|
|
2085
|
+
/** The workflows associated with the data product version. */
|
|
2086
|
+
workflows?: DataProductWorkflows;
|
|
2087
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2088
|
+
dataview_enabled?: boolean;
|
|
2089
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2090
|
+
comments?: string;
|
|
2091
|
+
/** Access control object. */
|
|
2092
|
+
access_control?: AssetListAccessControl;
|
|
2093
|
+
/** Timestamp of last asset update. */
|
|
2094
|
+
last_updated_at?: string;
|
|
2095
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
2096
|
+
sub_container?: ContainerIdentity;
|
|
2097
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
2098
|
+
* the data product requires explicit approval before data is delivered.
|
|
2099
|
+
*/
|
|
2100
|
+
is_restricted: boolean;
|
|
2101
|
+
/** The identifier of the data product version. */
|
|
2102
|
+
id: string;
|
|
2103
|
+
/** The reference schema for a asset in a container. */
|
|
2104
|
+
asset: AssetReference;
|
|
2105
|
+
/** The user who published this data product version. */
|
|
2106
|
+
published_by?: string;
|
|
2107
|
+
/** The time when this data product version was published. */
|
|
2108
|
+
published_at?: string;
|
|
2109
|
+
/** The creator of this data product version. */
|
|
2110
|
+
created_by: string;
|
|
2111
|
+
/** The time when this data product version was created. */
|
|
2112
|
+
created_at: string;
|
|
2113
|
+
/** Metadata properties on data products. */
|
|
2114
|
+
properties?: JsonObject;
|
|
2115
|
+
/** Errors encountered during the visualization creation process. */
|
|
2116
|
+
visualization_errors?: DataAssetRelationship[];
|
|
2117
|
+
}
|
|
2118
|
+
namespace DataProductDraft {
|
|
2119
|
+
namespace Constants {
|
|
2120
|
+
/** The state of the data product version. */
|
|
2121
|
+
enum State {
|
|
2122
|
+
DRAFT = "draft",
|
|
2123
|
+
AVAILABLE = "available",
|
|
2124
|
+
RETIRED = "retired"
|
|
2125
|
+
}
|
|
2126
|
+
/** Types of parts on the data product. */
|
|
2127
|
+
enum Types {
|
|
2128
|
+
DATA = "data",
|
|
2129
|
+
CODE = "code"
|
|
2130
|
+
}
|
|
2131
|
+
}
|
|
2132
|
+
}
|
|
2133
|
+
/**
|
|
2134
|
+
* A collection of data product draft summaries.
|
|
2135
|
+
*/
|
|
2136
|
+
interface DataProductDraftCollection {
|
|
2137
|
+
/** Set a limit on the number of results returned. */
|
|
2138
|
+
limit: number;
|
|
2139
|
+
/** First page in the collection. */
|
|
2140
|
+
first: FirstPage;
|
|
2141
|
+
/** Next page in the collection. */
|
|
2142
|
+
next?: NextPage;
|
|
2143
|
+
/** Indicates the total number of results returned. */
|
|
2144
|
+
total_results?: number;
|
|
2145
|
+
/** Collection of data product drafts. */
|
|
2146
|
+
drafts: DataProductDraftSummary[];
|
|
2147
|
+
}
|
|
2148
|
+
/**
|
|
2149
|
+
* Data product reference.
|
|
2150
|
+
*/
|
|
2151
|
+
interface DataProductDraftDataProduct {
|
|
2152
|
+
/** Data product identifier. */
|
|
2153
|
+
id: string;
|
|
2154
|
+
/** A data product draft version object. */
|
|
2155
|
+
release?: DataProductDraftVersionRelease;
|
|
2156
|
+
/** Container reference. */
|
|
2157
|
+
container: ContainerReference;
|
|
2158
|
+
}
|
|
2159
|
+
/**
|
|
2160
|
+
* New data product version input properties.
|
|
2161
|
+
*/
|
|
2162
|
+
interface DataProductDraftPrototype {
|
|
2163
|
+
/** The data product version number. */
|
|
2164
|
+
version?: string;
|
|
2165
|
+
/** The state of the data product version. If not specified, the data product version will be created in `draft`
|
|
2166
|
+
* state.
|
|
2167
|
+
*/
|
|
2168
|
+
state?: DataProductDraftPrototype.Constants.State | string;
|
|
2169
|
+
/** Data product identifier. */
|
|
2170
|
+
data_product?: DataProductIdentity;
|
|
2171
|
+
/** The name that refers to the new data product version. If this is a new data product, this value must be
|
|
2172
|
+
* specified. If this is a new version of an existing data product, the name will default to the name of the
|
|
2173
|
+
* previous data product version. A name can contain letters, numbers, understores, dashes, spaces or periods. A
|
|
2174
|
+
* name must contain at least one non-space character.
|
|
2175
|
+
*/
|
|
2176
|
+
name?: string;
|
|
2177
|
+
/** Description of the data product version. If this is a new version of an existing data product, the
|
|
2178
|
+
* description will default to the description of the previous version of the data product.
|
|
2179
|
+
*/
|
|
2180
|
+
description?: string;
|
|
2181
|
+
/** Tags on the data product. */
|
|
2182
|
+
tags?: string[];
|
|
2183
|
+
/** A list of use cases associated with the data product version. */
|
|
2184
|
+
use_cases?: UseCase[];
|
|
2185
|
+
/** Types of parts on the data product. */
|
|
2186
|
+
types?: DataProductDraftPrototype.Constants.Types[] | string[];
|
|
2187
|
+
/** Contract terms binding various aspects of the data product. */
|
|
2188
|
+
contract_terms?: ContractTerms[];
|
|
2189
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2190
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2191
|
+
* previous version of the data product.
|
|
2192
|
+
*/
|
|
2193
|
+
domain?: Domain;
|
|
2194
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
2195
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
2196
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
2197
|
+
*/
|
|
2198
|
+
parts_out?: DataProductPart[];
|
|
2199
|
+
/** The workflows associated with the data product version. */
|
|
2200
|
+
workflows?: DataProductWorkflows;
|
|
2201
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2202
|
+
dataview_enabled?: boolean;
|
|
2203
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2204
|
+
comments?: string;
|
|
2205
|
+
/** Access control object. */
|
|
2206
|
+
access_control?: AssetListAccessControl;
|
|
2207
|
+
/** Timestamp of last asset update. */
|
|
2208
|
+
last_updated_at?: string;
|
|
2209
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
2210
|
+
sub_container?: ContainerIdentity;
|
|
2211
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
2212
|
+
* the data product requires explicit approval before data is delivered.
|
|
2213
|
+
*/
|
|
2214
|
+
is_restricted?: boolean;
|
|
2215
|
+
/** New asset input properties. */
|
|
2216
|
+
asset: AssetPrototype;
|
|
2217
|
+
}
|
|
2218
|
+
namespace DataProductDraftPrototype {
|
|
2219
|
+
namespace Constants {
|
|
2220
|
+
/** The state of the data product version. If not specified, the data product version will be created in `draft` state. */
|
|
2221
|
+
enum State {
|
|
2222
|
+
DRAFT = "draft",
|
|
2223
|
+
AVAILABLE = "available",
|
|
2224
|
+
RETIRED = "retired"
|
|
2225
|
+
}
|
|
2226
|
+
/** Types of parts on the data product. */
|
|
2227
|
+
enum Types {
|
|
2228
|
+
DATA = "data",
|
|
2229
|
+
CODE = "code"
|
|
2230
|
+
}
|
|
2231
|
+
}
|
|
2232
|
+
}
|
|
2233
|
+
/**
|
|
2234
|
+
* Summary of Data Product Version object.
|
|
2235
|
+
*/
|
|
2236
|
+
interface DataProductDraftSummary {
|
|
2237
|
+
/** The data product version number. */
|
|
2238
|
+
version: string;
|
|
2239
|
+
/** The state of the data product version. */
|
|
2240
|
+
state: DataProductDraftSummary.Constants.State | string;
|
|
2241
|
+
/** Data product reference. */
|
|
2242
|
+
data_product: DataProductDraftSummaryDataProduct;
|
|
2243
|
+
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
2244
|
+
* periods. Names are mutable and reusable.
|
|
2245
|
+
*/
|
|
2246
|
+
name: string;
|
|
2247
|
+
/** The description of the data product version. */
|
|
2248
|
+
description: string;
|
|
2249
|
+
/** Tags on the data product. */
|
|
2250
|
+
tags: string[];
|
|
2251
|
+
/** A list of use cases associated with the data product version. */
|
|
2252
|
+
use_cases?: UseCase[];
|
|
2253
|
+
/** Types of parts on the data product. */
|
|
2254
|
+
types: DataProductDraftSummary.Constants.Types[] | string[];
|
|
2255
|
+
/** Contract terms binding various aspects of the data product. */
|
|
2256
|
+
contract_terms: ContractTerms[];
|
|
2257
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2258
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2259
|
+
* previous version of the data product.
|
|
2260
|
+
*/
|
|
2261
|
+
domain: Domain;
|
|
2262
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
2263
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
2264
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
2265
|
+
*/
|
|
2266
|
+
parts_out: DataProductPart[];
|
|
2267
|
+
/** The workflows associated with the data product version. */
|
|
2268
|
+
workflows?: DataProductWorkflows;
|
|
2269
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2270
|
+
dataview_enabled?: boolean;
|
|
2271
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2272
|
+
comments?: string;
|
|
2273
|
+
/** Access control object. */
|
|
2274
|
+
access_control?: AssetListAccessControl;
|
|
2275
|
+
/** Timestamp of last asset update. */
|
|
2276
|
+
last_updated_at?: string;
|
|
2277
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
2278
|
+
sub_container?: ContainerIdentity;
|
|
2279
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
2280
|
+
* the data product requires explicit approval before data is delivered.
|
|
2281
|
+
*/
|
|
2282
|
+
is_restricted: boolean;
|
|
2283
|
+
/** The identifier of the data product version. */
|
|
2284
|
+
id: string;
|
|
2285
|
+
/** The reference schema for a asset in a container. */
|
|
2286
|
+
asset: AssetReference;
|
|
2287
|
+
}
|
|
2288
|
+
namespace DataProductDraftSummary {
|
|
2289
|
+
namespace Constants {
|
|
2290
|
+
/** The state of the data product version. */
|
|
2291
|
+
enum State {
|
|
2292
|
+
DRAFT = "draft",
|
|
2293
|
+
AVAILABLE = "available",
|
|
2294
|
+
RETIRED = "retired"
|
|
2295
|
+
}
|
|
2296
|
+
/** Types of parts on the data product. */
|
|
2297
|
+
enum Types {
|
|
2298
|
+
DATA = "data",
|
|
2299
|
+
CODE = "code"
|
|
2300
|
+
}
|
|
2301
|
+
}
|
|
2302
|
+
}
|
|
2303
|
+
/**
|
|
2304
|
+
* Data product reference.
|
|
2305
|
+
*/
|
|
2306
|
+
interface DataProductDraftSummaryDataProduct {
|
|
845
2307
|
/** Data product identifier. */
|
|
846
2308
|
id: string;
|
|
847
2309
|
/** A data product draft version object. */
|
|
848
2310
|
release?: DataProductDraftVersionRelease;
|
|
849
2311
|
/** Container reference. */
|
|
850
2312
|
container: ContainerReference;
|
|
851
|
-
/** Summary of Data Product Version object. */
|
|
852
|
-
latest_release?: DataProductVersionSummary;
|
|
853
|
-
/** List of draft summaries of this data product. */
|
|
854
|
-
drafts?: DataProductVersionSummary[];
|
|
855
|
-
}
|
|
856
|
-
/**
|
|
857
|
-
* DataProductContractTerms.
|
|
858
|
-
*/
|
|
859
|
-
interface DataProductContractTerms {
|
|
860
|
-
asset?: AssetReference;
|
|
861
|
-
/** ID of the contract terms. */
|
|
862
|
-
id?: string;
|
|
863
|
-
/** Collection of contract terms documents. */
|
|
864
|
-
documents?: ContractTermsDocument[];
|
|
865
|
-
error_msg?: string;
|
|
866
|
-
}
|
|
867
|
-
/**
|
|
868
|
-
* A custom workflow definition to be used to create a workflow to approve a data product subscription.
|
|
869
|
-
*/
|
|
870
|
-
interface DataProductCustomWorkflowDefinition {
|
|
871
|
-
/** ID of a workflow definition. */
|
|
872
|
-
id?: string;
|
|
873
|
-
}
|
|
874
|
-
/**
|
|
875
|
-
* A collection of data product draft summaries.
|
|
876
|
-
*/
|
|
877
|
-
interface DataProductDraftCollection {
|
|
878
|
-
/** Set a limit on the number of results returned. */
|
|
879
|
-
limit: number;
|
|
880
|
-
/** First page in the collection. */
|
|
881
|
-
first: FirstPage;
|
|
882
|
-
/** Next page in the collection. */
|
|
883
|
-
next?: NextPage;
|
|
884
|
-
/** Collection of data product drafts. */
|
|
885
|
-
drafts: DataProductVersionSummary[];
|
|
886
2313
|
}
|
|
887
2314
|
/**
|
|
888
2315
|
* A data product draft version object.
|
|
@@ -921,52 +2348,15 @@ declare namespace DphV1 {
|
|
|
921
2348
|
delivery_methods?: DeliveryMethod[];
|
|
922
2349
|
}
|
|
923
2350
|
/**
|
|
924
|
-
*
|
|
925
|
-
*/
|
|
926
|
-
interface DataProductReleaseCollection {
|
|
927
|
-
/** Set a limit on the number of results returned. */
|
|
928
|
-
limit: number;
|
|
929
|
-
/** First page in the collection. */
|
|
930
|
-
first: FirstPage;
|
|
931
|
-
/** Next page in the collection. */
|
|
932
|
-
next?: NextPage;
|
|
933
|
-
/** Collection of data product releases. */
|
|
934
|
-
releases: DataProductVersionSummary[];
|
|
935
|
-
}
|
|
936
|
-
/**
|
|
937
|
-
* Data Product Summary.
|
|
938
|
-
*/
|
|
939
|
-
interface DataProductSummary {
|
|
940
|
-
/** Data product identifier. */
|
|
941
|
-
id: string;
|
|
942
|
-
/** A data product draft version object. */
|
|
943
|
-
release?: DataProductDraftVersionRelease;
|
|
944
|
-
/** Container reference. */
|
|
945
|
-
container: ContainerReference;
|
|
946
|
-
}
|
|
947
|
-
/**
|
|
948
|
-
* A collection of data product summaries.
|
|
949
|
-
*/
|
|
950
|
-
interface DataProductSummaryCollection {
|
|
951
|
-
/** Set a limit on the number of results returned. */
|
|
952
|
-
limit: number;
|
|
953
|
-
/** First page in the collection. */
|
|
954
|
-
first: FirstPage;
|
|
955
|
-
/** Next page in the collection. */
|
|
956
|
-
next?: NextPage;
|
|
957
|
-
/** Collection of data product summaries. */
|
|
958
|
-
data_products: DataProductSummary[];
|
|
959
|
-
}
|
|
960
|
-
/**
|
|
961
|
-
* Data Product version.
|
|
2351
|
+
* Data Product version release.
|
|
962
2352
|
*/
|
|
963
|
-
interface
|
|
2353
|
+
interface DataProductRelease {
|
|
964
2354
|
/** The data product version number. */
|
|
965
2355
|
version: string;
|
|
966
2356
|
/** The state of the data product version. */
|
|
967
|
-
state:
|
|
2357
|
+
state: DataProductRelease.Constants.State | string;
|
|
968
2358
|
/** Data product reference. */
|
|
969
|
-
data_product:
|
|
2359
|
+
data_product: DataProductReleaseDataProduct;
|
|
970
2360
|
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
971
2361
|
* periods. Names are mutable and reusable.
|
|
972
2362
|
*/
|
|
@@ -976,25 +2366,41 @@ declare namespace DphV1 {
|
|
|
976
2366
|
/** Tags on the data product. */
|
|
977
2367
|
tags: string[];
|
|
978
2368
|
/** A list of use cases associated with the data product version. */
|
|
979
|
-
use_cases
|
|
2369
|
+
use_cases?: UseCase[];
|
|
980
2370
|
/** Types of parts on the data product. */
|
|
981
|
-
types:
|
|
2371
|
+
types: DataProductRelease.Constants.Types[] | string[];
|
|
982
2372
|
/** Contract terms binding various aspects of the data product. */
|
|
983
|
-
contract_terms:
|
|
2373
|
+
contract_terms: ContractTerms[];
|
|
2374
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2375
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2376
|
+
* previous version of the data product.
|
|
2377
|
+
*/
|
|
2378
|
+
domain: Domain;
|
|
2379
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
2380
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
2381
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
2382
|
+
*/
|
|
2383
|
+
parts_out: DataProductPart[];
|
|
2384
|
+
/** The workflows associated with the data product version. */
|
|
2385
|
+
workflows?: DataProductWorkflows;
|
|
2386
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2387
|
+
dataview_enabled?: boolean;
|
|
2388
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2389
|
+
comments?: string;
|
|
2390
|
+
/** Access control object. */
|
|
2391
|
+
access_control?: AssetListAccessControl;
|
|
2392
|
+
/** Timestamp of last asset update. */
|
|
2393
|
+
last_updated_at?: string;
|
|
2394
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
2395
|
+
sub_container?: ContainerIdentity;
|
|
984
2396
|
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
985
2397
|
* the data product requires explicit approval before data is delivered.
|
|
986
2398
|
*/
|
|
987
2399
|
is_restricted: boolean;
|
|
988
2400
|
/** The identifier of the data product version. */
|
|
989
2401
|
id: string;
|
|
2402
|
+
/** The reference schema for a asset in a container. */
|
|
990
2403
|
asset: AssetReference;
|
|
991
|
-
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
992
|
-
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
993
|
-
* previous version of the data product.
|
|
994
|
-
*/
|
|
995
|
-
domain: Domain;
|
|
996
|
-
/** Outgoing parts of a data product used to deliver the data product to consumers. */
|
|
997
|
-
parts_out: DataProductPart[];
|
|
998
2404
|
/** The user who published this data product version. */
|
|
999
2405
|
published_by?: string;
|
|
1000
2406
|
/** The time when this data product version was published. */
|
|
@@ -1003,12 +2409,12 @@ declare namespace DphV1 {
|
|
|
1003
2409
|
created_by: string;
|
|
1004
2410
|
/** The time when this data product version was created. */
|
|
1005
2411
|
created_at: string;
|
|
1006
|
-
/** The workflows associated with the data product version. */
|
|
1007
|
-
workflows?: DataProductWorkflows;
|
|
1008
2412
|
/** Metadata properties on data products. */
|
|
1009
2413
|
properties?: JsonObject;
|
|
2414
|
+
/** Errors encountered during the visualization creation process. */
|
|
2415
|
+
visualization_errors?: DataAssetRelationship[];
|
|
1010
2416
|
}
|
|
1011
|
-
namespace
|
|
2417
|
+
namespace DataProductRelease {
|
|
1012
2418
|
namespace Constants {
|
|
1013
2419
|
/** The state of the data product version. */
|
|
1014
2420
|
enum State {
|
|
@@ -1023,10 +2429,25 @@ declare namespace DphV1 {
|
|
|
1023
2429
|
}
|
|
1024
2430
|
}
|
|
1025
2431
|
}
|
|
2432
|
+
/**
|
|
2433
|
+
* A collection of data product release summaries.
|
|
2434
|
+
*/
|
|
2435
|
+
interface DataProductReleaseCollection {
|
|
2436
|
+
/** Set a limit on the number of results returned. */
|
|
2437
|
+
limit: number;
|
|
2438
|
+
/** First page in the collection. */
|
|
2439
|
+
first: FirstPage;
|
|
2440
|
+
/** Next page in the collection. */
|
|
2441
|
+
next?: NextPage;
|
|
2442
|
+
/** Indicates the total number of results returned. */
|
|
2443
|
+
total_results?: number;
|
|
2444
|
+
/** Collection of data product releases. */
|
|
2445
|
+
releases: DataProductReleaseSummary[];
|
|
2446
|
+
}
|
|
1026
2447
|
/**
|
|
1027
2448
|
* Data product reference.
|
|
1028
2449
|
*/
|
|
1029
|
-
interface
|
|
2450
|
+
interface DataProductReleaseDataProduct {
|
|
1030
2451
|
/** Data product identifier. */
|
|
1031
2452
|
id: string;
|
|
1032
2453
|
/** A data product draft version object. */
|
|
@@ -1035,41 +2456,29 @@ declare namespace DphV1 {
|
|
|
1035
2456
|
container: ContainerReference;
|
|
1036
2457
|
}
|
|
1037
2458
|
/**
|
|
1038
|
-
*
|
|
2459
|
+
* Summary of Data Product Version object.
|
|
1039
2460
|
*/
|
|
1040
|
-
interface
|
|
2461
|
+
interface DataProductReleaseSummary {
|
|
1041
2462
|
/** The data product version number. */
|
|
1042
|
-
version
|
|
1043
|
-
/** The state of the data product version.
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
/**
|
|
1048
|
-
|
|
1049
|
-
/** The name that refers to the new data product version. If this is a new data product, this value must be
|
|
1050
|
-
* specified. If this is a new version of an existing data product, the name will default to the name of the
|
|
1051
|
-
* previous data product version. A name can contain letters, numbers, understores, dashes, spaces or periods. A
|
|
1052
|
-
* name must contain at least one non-space character.
|
|
1053
|
-
*/
|
|
1054
|
-
name?: string;
|
|
1055
|
-
/** Description of the data product version. If this is a new version of an existing data product, the
|
|
1056
|
-
* description will default to the description of the previous version of the data product.
|
|
2463
|
+
version: string;
|
|
2464
|
+
/** The state of the data product version. */
|
|
2465
|
+
state: DataProductReleaseSummary.Constants.State | string;
|
|
2466
|
+
/** Data product reference. */
|
|
2467
|
+
data_product: DataProductReleaseSummaryDataProduct;
|
|
2468
|
+
/** The name of the data product version. A name can contain letters, numbers, understores, dashes, spaces or
|
|
2469
|
+
* periods. Names are mutable and reusable.
|
|
1057
2470
|
*/
|
|
1058
|
-
|
|
2471
|
+
name: string;
|
|
2472
|
+
/** The description of the data product version. */
|
|
2473
|
+
description: string;
|
|
1059
2474
|
/** Tags on the data product. */
|
|
1060
2475
|
tags?: string[];
|
|
1061
2476
|
/** A list of use cases associated with the data product version. */
|
|
1062
2477
|
use_cases?: UseCase[];
|
|
1063
2478
|
/** Types of parts on the data product. */
|
|
1064
|
-
types
|
|
2479
|
+
types: DataProductReleaseSummary.Constants.Types[] | string[];
|
|
1065
2480
|
/** Contract terms binding various aspects of the data product. */
|
|
1066
|
-
contract_terms
|
|
1067
|
-
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1068
|
-
* the data product requires explicit approval before data is delivered.
|
|
1069
|
-
*/
|
|
1070
|
-
is_restricted?: boolean;
|
|
1071
|
-
/** New asset input properties. */
|
|
1072
|
-
asset: AssetPrototype;
|
|
2481
|
+
contract_terms: ContractTerms[];
|
|
1073
2482
|
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
1074
2483
|
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
1075
2484
|
* previous version of the data product.
|
|
@@ -1082,10 +2491,28 @@ declare namespace DphV1 {
|
|
|
1082
2491
|
parts_out?: DataProductPart[];
|
|
1083
2492
|
/** The workflows associated with the data product version. */
|
|
1084
2493
|
workflows?: DataProductWorkflows;
|
|
2494
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2495
|
+
dataview_enabled?: boolean;
|
|
2496
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2497
|
+
comments?: string;
|
|
2498
|
+
/** Access control object. */
|
|
2499
|
+
access_control?: AssetListAccessControl;
|
|
2500
|
+
/** Timestamp of last asset update. */
|
|
2501
|
+
last_updated_at?: string;
|
|
2502
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
2503
|
+
sub_container?: ContainerIdentity;
|
|
2504
|
+
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
2505
|
+
* the data product requires explicit approval before data is delivered.
|
|
2506
|
+
*/
|
|
2507
|
+
is_restricted: boolean;
|
|
2508
|
+
/** The identifier of the data product version. */
|
|
2509
|
+
id: string;
|
|
2510
|
+
/** The reference schema for a asset in a container. */
|
|
2511
|
+
asset: AssetReference;
|
|
1085
2512
|
}
|
|
1086
|
-
namespace
|
|
2513
|
+
namespace DataProductReleaseSummary {
|
|
1087
2514
|
namespace Constants {
|
|
1088
|
-
/** The state of the data product version.
|
|
2515
|
+
/** The state of the data product version. */
|
|
1089
2516
|
enum State {
|
|
1090
2517
|
DRAFT = "draft",
|
|
1091
2518
|
AVAILABLE = "available",
|
|
@@ -1098,6 +2525,45 @@ declare namespace DphV1 {
|
|
|
1098
2525
|
}
|
|
1099
2526
|
}
|
|
1100
2527
|
}
|
|
2528
|
+
/**
|
|
2529
|
+
* Data product reference.
|
|
2530
|
+
*/
|
|
2531
|
+
interface DataProductReleaseSummaryDataProduct {
|
|
2532
|
+
/** Data product identifier. */
|
|
2533
|
+
id: string;
|
|
2534
|
+
/** A data product draft version object. */
|
|
2535
|
+
release?: DataProductDraftVersionRelease;
|
|
2536
|
+
/** Container reference. */
|
|
2537
|
+
container: ContainerReference;
|
|
2538
|
+
}
|
|
2539
|
+
/**
|
|
2540
|
+
* Data Product Summary.
|
|
2541
|
+
*/
|
|
2542
|
+
interface DataProductSummary {
|
|
2543
|
+
/** Data product identifier. */
|
|
2544
|
+
id: string;
|
|
2545
|
+
/** A data product draft version object. */
|
|
2546
|
+
release?: DataProductDraftVersionRelease;
|
|
2547
|
+
/** Container reference. */
|
|
2548
|
+
container: ContainerReference;
|
|
2549
|
+
/** Data product name. */
|
|
2550
|
+
name?: string;
|
|
2551
|
+
}
|
|
2552
|
+
/**
|
|
2553
|
+
* A collection of data product version summaries.
|
|
2554
|
+
*/
|
|
2555
|
+
interface DataProductVersionCollection {
|
|
2556
|
+
/** Set a limit on the number of results returned. */
|
|
2557
|
+
limit: number;
|
|
2558
|
+
/** First page in the collection. */
|
|
2559
|
+
first: FirstPage;
|
|
2560
|
+
/** Next page in the collection. */
|
|
2561
|
+
next?: NextPage;
|
|
2562
|
+
/** Indicates the total number of results returned. */
|
|
2563
|
+
total_results?: number;
|
|
2564
|
+
/** Collection of data product versions. */
|
|
2565
|
+
data_product_versions: DataProductVersionSummary[];
|
|
2566
|
+
}
|
|
1101
2567
|
/**
|
|
1102
2568
|
* Summary of Data Product Version object.
|
|
1103
2569
|
*/
|
|
@@ -1115,19 +2581,42 @@ declare namespace DphV1 {
|
|
|
1115
2581
|
/** The description of the data product version. */
|
|
1116
2582
|
description: string;
|
|
1117
2583
|
/** Tags on the data product. */
|
|
1118
|
-
tags
|
|
2584
|
+
tags?: string[];
|
|
1119
2585
|
/** A list of use cases associated with the data product version. */
|
|
1120
|
-
use_cases
|
|
2586
|
+
use_cases?: UseCase[];
|
|
1121
2587
|
/** Types of parts on the data product. */
|
|
1122
2588
|
types: DataProductVersionSummary.Constants.Types[] | string[];
|
|
1123
2589
|
/** Contract terms binding various aspects of the data product. */
|
|
1124
|
-
contract_terms:
|
|
2590
|
+
contract_terms: ContractTerms[];
|
|
2591
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2592
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2593
|
+
* previous version of the data product.
|
|
2594
|
+
*/
|
|
2595
|
+
domain?: Domain;
|
|
2596
|
+
/** The outgoing parts of this data product version to be delivered to consumers. If this is the first version
|
|
2597
|
+
* of a data product, this field defaults to an empty list. If this is a new version of an existing data product,
|
|
2598
|
+
* the data product parts will default to the parts list from the previous version of the data product.
|
|
2599
|
+
*/
|
|
2600
|
+
parts_out?: DataProductPart[];
|
|
2601
|
+
/** The workflows associated with the data product version. */
|
|
2602
|
+
workflows?: DataProductWorkflows;
|
|
2603
|
+
/** Indicates whether the dataView has enabled for data product. */
|
|
2604
|
+
dataview_enabled?: boolean;
|
|
2605
|
+
/** Comments by a producer that are provided either at the time of data product version creation or retiring. */
|
|
2606
|
+
comments?: string;
|
|
2607
|
+
/** Access control object. */
|
|
2608
|
+
access_control?: AssetListAccessControl;
|
|
2609
|
+
/** Timestamp of last asset update. */
|
|
2610
|
+
last_updated_at?: string;
|
|
2611
|
+
/** The identity schema for a IBM knowledge catalog container (catalog/project/space). */
|
|
2612
|
+
sub_container?: ContainerIdentity;
|
|
1125
2613
|
/** Indicates whether the data product is restricted or not. A restricted data product indicates that orders of
|
|
1126
2614
|
* the data product requires explicit approval before data is delivered.
|
|
1127
2615
|
*/
|
|
1128
2616
|
is_restricted: boolean;
|
|
1129
2617
|
/** The identifier of the data product version. */
|
|
1130
2618
|
id: string;
|
|
2619
|
+
/** The reference schema for a asset in a container. */
|
|
1131
2620
|
asset: AssetReference;
|
|
1132
2621
|
}
|
|
1133
2622
|
namespace DataProductVersionSummary {
|
|
@@ -1171,6 +2660,30 @@ declare namespace DphV1 {
|
|
|
1171
2660
|
id: string;
|
|
1172
2661
|
/** Container reference. */
|
|
1173
2662
|
container: ContainerReference;
|
|
2663
|
+
/** The propertiess of the delivery method. */
|
|
2664
|
+
getproperties?: DeliveryMethodPropertiesModel;
|
|
2665
|
+
}
|
|
2666
|
+
/**
|
|
2667
|
+
* The propertiess of the delivery method.
|
|
2668
|
+
*/
|
|
2669
|
+
interface DeliveryMethodPropertiesModel {
|
|
2670
|
+
/** Parameters for delivery that are set by a data product producer. */
|
|
2671
|
+
producer_input?: ProducerInputModel;
|
|
2672
|
+
}
|
|
2673
|
+
/**
|
|
2674
|
+
* Description details of a data contract.
|
|
2675
|
+
*/
|
|
2676
|
+
interface Description {
|
|
2677
|
+
/** Intended purpose for the provided data. */
|
|
2678
|
+
purpose?: string;
|
|
2679
|
+
/** Technical, compliance, and legal limitations for data use. */
|
|
2680
|
+
limitations?: string;
|
|
2681
|
+
/** Recommended usage of the data. */
|
|
2682
|
+
usage?: string;
|
|
2683
|
+
/** List of links to sources that provide more details on the dataset. */
|
|
2684
|
+
more_info?: ContractTermsMoreInfo[];
|
|
2685
|
+
/** Custom properties that are not part of the standard. */
|
|
2686
|
+
custom_properties?: string;
|
|
1174
2687
|
}
|
|
1175
2688
|
/**
|
|
1176
2689
|
* Domain that the data product version belongs to. If this is the first version of a data product, this field is
|
|
@@ -1185,16 +2698,70 @@ declare namespace DphV1 {
|
|
|
1185
2698
|
/** Container reference. */
|
|
1186
2699
|
container?: ContainerReference;
|
|
1187
2700
|
}
|
|
2701
|
+
/**
|
|
2702
|
+
* Engine details as defined by the data product producer.
|
|
2703
|
+
*/
|
|
2704
|
+
interface EngineDetailsModel {
|
|
2705
|
+
/** The name of the engine defined by the data product producer. */
|
|
2706
|
+
display_name?: string;
|
|
2707
|
+
/** The id of the engine defined by the data product producer. */
|
|
2708
|
+
engine_id?: string;
|
|
2709
|
+
/** The port of the engine defined by the data product producer. */
|
|
2710
|
+
engine_port?: string;
|
|
2711
|
+
/** The host of the engine defined by the data product producer. */
|
|
2712
|
+
engine_host?: string;
|
|
2713
|
+
/** The type of the engine (eg: Presto/Spark). */
|
|
2714
|
+
engine_type: EngineDetailsModel.Constants.EngineType | string;
|
|
2715
|
+
/** The list of associated catalogs. */
|
|
2716
|
+
associated_catalogs?: string[];
|
|
2717
|
+
}
|
|
2718
|
+
namespace EngineDetailsModel {
|
|
2719
|
+
namespace Constants {
|
|
2720
|
+
/** The type of the engine (eg: Presto/Spark). */
|
|
2721
|
+
enum EngineType {
|
|
2722
|
+
SPARK = "spark",
|
|
2723
|
+
PRESTO = "presto"
|
|
2724
|
+
}
|
|
2725
|
+
}
|
|
2726
|
+
}
|
|
2727
|
+
/**
|
|
2728
|
+
* Detailed error information.
|
|
2729
|
+
*/
|
|
2730
|
+
interface ErrorExtraResource {
|
|
2731
|
+
/** Error id. */
|
|
2732
|
+
id?: string;
|
|
2733
|
+
/** Timestamp of the error. */
|
|
2734
|
+
timestamp?: string;
|
|
2735
|
+
/** Environment where the error occurred. */
|
|
2736
|
+
environment_name?: string;
|
|
2737
|
+
/** Http status code. */
|
|
2738
|
+
http_status?: number;
|
|
2739
|
+
/** Source cluster of the error. */
|
|
2740
|
+
source_cluster?: number;
|
|
2741
|
+
/** Source component of the error. */
|
|
2742
|
+
source_component?: number;
|
|
2743
|
+
/** Transaction id of the request. */
|
|
2744
|
+
transaction_id?: number;
|
|
2745
|
+
}
|
|
2746
|
+
/**
|
|
2747
|
+
* Contains the code and details.
|
|
2748
|
+
*/
|
|
2749
|
+
interface ErrorMessage {
|
|
2750
|
+
/** The error code. */
|
|
2751
|
+
code: string;
|
|
2752
|
+
/** The error details. */
|
|
2753
|
+
message: string;
|
|
2754
|
+
}
|
|
1188
2755
|
/**
|
|
1189
2756
|
* Detailed error information.
|
|
1190
2757
|
*/
|
|
1191
2758
|
interface ErrorModelResource {
|
|
1192
2759
|
/** Error code. */
|
|
1193
|
-
code
|
|
2760
|
+
code: ErrorModelResource.Constants.Code | string;
|
|
1194
2761
|
/** Error message. */
|
|
1195
2762
|
message?: string;
|
|
1196
|
-
/**
|
|
1197
|
-
extra?:
|
|
2763
|
+
/** Detailed error information. */
|
|
2764
|
+
extra?: ErrorExtraResource;
|
|
1198
2765
|
/** More info message. */
|
|
1199
2766
|
more_info?: string;
|
|
1200
2767
|
}
|
|
@@ -1231,7 +2798,8 @@ declare namespace DphV1 {
|
|
|
1231
2798
|
ENTITLEMENT_ENFORCEMENT = "entitlement_enforcement",
|
|
1232
2799
|
DELETED = "deleted",
|
|
1233
2800
|
NOT_IMPLEMENTED = "not_implemented",
|
|
1234
|
-
FEATURE_NOT_ENABLED = "feature_not_enabled"
|
|
2801
|
+
FEATURE_NOT_ENABLED = "feature_not_enabled",
|
|
2802
|
+
MISSING_ASSET_DETAILS = "missing_asset_details"
|
|
1235
2803
|
}
|
|
1236
2804
|
}
|
|
1237
2805
|
}
|
|
@@ -1251,7 +2819,7 @@ declare namespace DphV1 {
|
|
|
1251
2819
|
/** Link to monitor the status of the initialize operation. */
|
|
1252
2820
|
href?: string;
|
|
1253
2821
|
/** Status of the initialize operation. */
|
|
1254
|
-
status
|
|
2822
|
+
status: InitializeResource.Constants.Status | string;
|
|
1255
2823
|
/** The id to trace the failed initialization operation. */
|
|
1256
2824
|
trace?: string;
|
|
1257
2825
|
/** Set of errors on the latest initialization request. */
|
|
@@ -1276,6 +2844,17 @@ declare namespace DphV1 {
|
|
|
1276
2844
|
}
|
|
1277
2845
|
}
|
|
1278
2846
|
}
|
|
2847
|
+
/**
|
|
2848
|
+
* The subdomain for a data product domain.
|
|
2849
|
+
*/
|
|
2850
|
+
interface InitializeSubDomain {
|
|
2851
|
+
/** The name of the data product subdomain. */
|
|
2852
|
+
name?: string;
|
|
2853
|
+
/** The identifier of the data product subdomain. */
|
|
2854
|
+
id?: string;
|
|
2855
|
+
/** The description of the data product subdomain. */
|
|
2856
|
+
description?: string;
|
|
2857
|
+
}
|
|
1279
2858
|
/**
|
|
1280
2859
|
* List of options successfully initialized.
|
|
1281
2860
|
*/
|
|
@@ -1311,6 +2890,15 @@ declare namespace DphV1 {
|
|
|
1311
2890
|
}
|
|
1312
2891
|
}
|
|
1313
2892
|
}
|
|
2893
|
+
/**
|
|
2894
|
+
* Member roles of a corresponding asset.
|
|
2895
|
+
*/
|
|
2896
|
+
interface MemberRolesSchema {
|
|
2897
|
+
/** User id. */
|
|
2898
|
+
user_iam_id?: string;
|
|
2899
|
+
/** Roles of the given user. */
|
|
2900
|
+
roles?: string[];
|
|
2901
|
+
}
|
|
1314
2902
|
/**
|
|
1315
2903
|
* Next page in the collection.
|
|
1316
2904
|
*/
|
|
@@ -1320,6 +2908,53 @@ declare namespace DphV1 {
|
|
|
1320
2908
|
/** Start token for pagination to the next page in the collection. */
|
|
1321
2909
|
start: string;
|
|
1322
2910
|
}
|
|
2911
|
+
/**
|
|
2912
|
+
* Overview details of a data contract.
|
|
2913
|
+
*/
|
|
2914
|
+
interface Overview {
|
|
2915
|
+
/** The API version of the contract. */
|
|
2916
|
+
api_version?: string;
|
|
2917
|
+
/** The kind of contract. */
|
|
2918
|
+
kind?: string;
|
|
2919
|
+
/** The name of the contract. */
|
|
2920
|
+
name?: string;
|
|
2921
|
+
/** The version of the contract. */
|
|
2922
|
+
version: string;
|
|
2923
|
+
/** Domain that the data product version belongs to. If this is the first version of a data product, this field
|
|
2924
|
+
* is required. If this is a new version of an existing data product, the domain will default to the domain of the
|
|
2925
|
+
* previous version of the data product.
|
|
2926
|
+
*/
|
|
2927
|
+
domain: Domain;
|
|
2928
|
+
/** Additional information links about the contract. */
|
|
2929
|
+
more_info?: string;
|
|
2930
|
+
}
|
|
2931
|
+
/**
|
|
2932
|
+
* Represents the pricing details of the contract.
|
|
2933
|
+
*/
|
|
2934
|
+
interface Pricing {
|
|
2935
|
+
/** The amount for the contract pricing. */
|
|
2936
|
+
amount?: string;
|
|
2937
|
+
/** The currency for the pricing amount. */
|
|
2938
|
+
currency?: string;
|
|
2939
|
+
/** The unit associated with the pricing. */
|
|
2940
|
+
unit?: string;
|
|
2941
|
+
}
|
|
2942
|
+
/**
|
|
2943
|
+
* Parameters for delivery that are set by a data product producer.
|
|
2944
|
+
*/
|
|
2945
|
+
interface ProducerInputModel {
|
|
2946
|
+
/** Engine details as defined by the data product producer. */
|
|
2947
|
+
engine_details?: EngineDetailsModel;
|
|
2948
|
+
/** List of engines defined by the data product producer. */
|
|
2949
|
+
engines?: EngineDetailsModel[];
|
|
2950
|
+
}
|
|
2951
|
+
/**
|
|
2952
|
+
* Properties of the corresponding asset.
|
|
2953
|
+
*/
|
|
2954
|
+
interface PropertiesSchema {
|
|
2955
|
+
/** Value of the property object. */
|
|
2956
|
+
value?: string;
|
|
2957
|
+
}
|
|
1323
2958
|
/**
|
|
1324
2959
|
* Resource defining provided workflow definitions.
|
|
1325
2960
|
*/
|
|
@@ -1336,6 +2971,46 @@ declare namespace DphV1 {
|
|
|
1336
2971
|
/** Reference to a workflow definition. */
|
|
1337
2972
|
definition?: WorkflowDefinitionReference;
|
|
1338
2973
|
}
|
|
2974
|
+
/**
|
|
2975
|
+
* This class holds the response message from the revoke access operation.
|
|
2976
|
+
*/
|
|
2977
|
+
interface RevokeAccessResponse {
|
|
2978
|
+
/** Response message of revoke access. */
|
|
2979
|
+
message?: string;
|
|
2980
|
+
}
|
|
2981
|
+
/**
|
|
2982
|
+
* Revoke access states with pagination support.
|
|
2983
|
+
*/
|
|
2984
|
+
interface RevokeAccessStateResponse {
|
|
2985
|
+
/** Holds revoke access state. */
|
|
2986
|
+
results?: Asset[];
|
|
2987
|
+
/** Total number of rows available. */
|
|
2988
|
+
total_count?: number;
|
|
2989
|
+
/** Pagination information for the next page of results. */
|
|
2990
|
+
next?: SearchAssetPaginationInfo;
|
|
2991
|
+
}
|
|
2992
|
+
/**
|
|
2993
|
+
* Represents a role associated with the contract.
|
|
2994
|
+
*/
|
|
2995
|
+
interface Roles {
|
|
2996
|
+
/** The role associated with the contract. */
|
|
2997
|
+
role?: string;
|
|
2998
|
+
}
|
|
2999
|
+
/**
|
|
3000
|
+
* Pagination information for the next page of results.
|
|
3001
|
+
*/
|
|
3002
|
+
interface SearchAssetPaginationInfo {
|
|
3003
|
+
/** Search query for filtering results. */
|
|
3004
|
+
query?: string;
|
|
3005
|
+
/** Number of items per page. */
|
|
3006
|
+
limit?: number;
|
|
3007
|
+
/** Bookmark for pagination. */
|
|
3008
|
+
bookmark?: string;
|
|
3009
|
+
/** What to include in the results. */
|
|
3010
|
+
include?: string;
|
|
3011
|
+
/** Number of items to skip. */
|
|
3012
|
+
skip?: number;
|
|
3013
|
+
}
|
|
1339
3014
|
/**
|
|
1340
3015
|
* Service id credentials.
|
|
1341
3016
|
*/
|
|
@@ -1356,6 +3031,15 @@ declare namespace DphV1 {
|
|
|
1356
3031
|
/** Container reference. */
|
|
1357
3032
|
container?: ContainerReference;
|
|
1358
3033
|
}
|
|
3034
|
+
/**
|
|
3035
|
+
* Data members for visualization.
|
|
3036
|
+
*/
|
|
3037
|
+
interface Visualization {
|
|
3038
|
+
/** Visualization identifier. */
|
|
3039
|
+
id?: string;
|
|
3040
|
+
/** Visualization name. */
|
|
3041
|
+
name?: string;
|
|
3042
|
+
}
|
|
1359
3043
|
/**
|
|
1360
3044
|
* Reference to a workflow definition.
|
|
1361
3045
|
*/
|
|
@@ -1423,14 +3107,14 @@ declare namespace DphV1 {
|
|
|
1423
3107
|
hasNext(): boolean;
|
|
1424
3108
|
/**
|
|
1425
3109
|
* Returns the next page of results by invoking listDataProductDrafts().
|
|
1426
|
-
* @returns {Promise<DphV1.
|
|
3110
|
+
* @returns {Promise<DphV1.DataProductDraftSummary[]>}
|
|
1427
3111
|
*/
|
|
1428
|
-
getNext(): Promise<DphV1.
|
|
3112
|
+
getNext(): Promise<DphV1.DataProductDraftSummary[]>;
|
|
1429
3113
|
/**
|
|
1430
3114
|
* Returns all results by invoking listDataProductDrafts() repeatedly until all pages of results have been retrieved.
|
|
1431
|
-
* @returns {Promise<DphV1.
|
|
3115
|
+
* @returns {Promise<DphV1.DataProductDraftSummary[]>}
|
|
1432
3116
|
*/
|
|
1433
|
-
getAll(): Promise<DphV1.
|
|
3117
|
+
getAll(): Promise<DphV1.DataProductDraftSummary[]>;
|
|
1434
3118
|
}
|
|
1435
3119
|
/**
|
|
1436
3120
|
* DataProductReleasesPager can be used to simplify the use of listDataProductReleases().
|
|
@@ -1456,14 +3140,14 @@ declare namespace DphV1 {
|
|
|
1456
3140
|
hasNext(): boolean;
|
|
1457
3141
|
/**
|
|
1458
3142
|
* Returns the next page of results by invoking listDataProductReleases().
|
|
1459
|
-
* @returns {Promise<DphV1.
|
|
3143
|
+
* @returns {Promise<DphV1.DataProductReleaseSummary[]>}
|
|
1460
3144
|
*/
|
|
1461
|
-
getNext(): Promise<DphV1.
|
|
3145
|
+
getNext(): Promise<DphV1.DataProductReleaseSummary[]>;
|
|
1462
3146
|
/**
|
|
1463
3147
|
* Returns all results by invoking listDataProductReleases() repeatedly until all pages of results have been retrieved.
|
|
1464
|
-
* @returns {Promise<DphV1.
|
|
3148
|
+
* @returns {Promise<DphV1.DataProductReleaseSummary[]>}
|
|
1465
3149
|
*/
|
|
1466
|
-
getAll(): Promise<DphV1.
|
|
3150
|
+
getAll(): Promise<DphV1.DataProductReleaseSummary[]>;
|
|
1467
3151
|
}
|
|
1468
3152
|
}
|
|
1469
3153
|
export = DphV1;
|