|
|
# Data Catalog Service
|
|
|
|
|
|
|
|
|
<a name="overview"></a>
|
|
|
## Overview
|
|
|
These API's will provide an interface for basic configuration settings
|
|
|
|
|
|
|
|
|
### Version information
|
|
|
*Version* : 1.0.0
|
|
|
|
|
|
|
|
|
### URI scheme
|
|
|
*Host* : DATA_CATALOG_SERVICE_GOOGLE_ENDPOINT_NAME_VALUE
|
|
|
*BasePath* : /datacatalog/v1
|
|
|
*Schemes* : HTTPS
|
|
|
|
|
|
|
|
|
### Tags
|
|
|
|
|
|
* Dropfile template Configuration : Dropfile CRUD operation.
|
|
|
* Enrichment Configuration : Enrichment CRUD operation
|
|
|
* GIS Mapping Configuration : GIS mapping CRUD operation
|
|
|
* OCR Mapping Configuration : OCR mapping CRUD operation
|
|
|
* Source Entity Configuration : Source/Entity CRUD operation.
|
|
|
|
|
|
|
|
|
### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="paths"></a>
|
|
|
## Paths
|
|
|
|
|
|
<a name="create-ocr-mapping-file"></a>
|
|
|
### OCRMapping
|
|
|
```
|
|
|
POST /OCRMapping
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API maps source attributes to attributes of enriched document entity that is used by search functionality of document enriched metadata.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[DocumentMappingRequest](#documentmappingrequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* OCR Mapping Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"entity_map" : {
|
|
|
"storage:workshop:document:1.0.0" : [ {
|
|
|
"name" : "DocumentLakeId",
|
|
|
"sourceName" : "id",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DocumentLakeVersion",
|
|
|
"sourceName" : "version",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DatalakeKind",
|
|
|
"sourceName" : "kind",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DatalakeAcl",
|
|
|
"sourceName" : "acl",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DocumentLegal",
|
|
|
"sourceName" : "legal",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DatalakeUser",
|
|
|
"sourceName" : "user",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DocumentFilename",
|
|
|
"sourceName" : "fileName",
|
|
|
"sourceParentPath" : "data"
|
|
|
}, {
|
|
|
"name" : "DocumentBucketURL",
|
|
|
"sourceName" : "bucketURL",
|
|
|
"sourceParentPath" : "data"
|
|
|
}, {
|
|
|
"name" : "DocumentMimeType",
|
|
|
"sourceName" : "mimeType",
|
|
|
"sourceParentPath" : "data"
|
|
|
}, {
|
|
|
"name" : "DocumentDateCreated",
|
|
|
"sourceName" : "dateCreated",
|
|
|
"sourceParentPath" : "data"
|
|
|
} ],
|
|
|
"search:workshop:document:1.0.0" : [ {
|
|
|
"name" : "kind",
|
|
|
"sourceName" : "kind",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "id",
|
|
|
"sourceName" : "id",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DocumentLegal",
|
|
|
"sourceName" : "legal",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DatalakeAcl",
|
|
|
"sourceName" : "acl",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "Source",
|
|
|
"sourceName" : "namespace",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DatalakeStatus",
|
|
|
"sourceName" : "status",
|
|
|
"sourceParentPath" : "results::legal"
|
|
|
}, {
|
|
|
"name" : "DocumentLakeVersion",
|
|
|
"sourceName" : "version",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DocumentFilename",
|
|
|
"sourceName" : "fileName",
|
|
|
"sourceParentPath" : "results::data"
|
|
|
} ]
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-ocr-mapping-file"></a>
|
|
|
### OCRMapping
|
|
|
```
|
|
|
GET /OCRMapping/{source}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves OCR Mapping file from storage having source as input.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Path**|**source** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[DocumentMappingRequest](#documentmappingrequest)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* OCR Mapping Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP response
|
|
|
|
|
|
##### Response 200
|
|
|
```json
|
|
|
{
|
|
|
"entity_map" : {
|
|
|
"storage:workshop:document:1.0.0" : [ {
|
|
|
"name" : "DocumentLakeId",
|
|
|
"sourceName" : "id",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DocumentLakeVersion",
|
|
|
"sourceName" : "version",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DatalakeKind",
|
|
|
"sourceName" : "kind",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DatalakeAcl",
|
|
|
"sourceName" : "acl",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DocumentLegal",
|
|
|
"sourceName" : "legal",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DatalakeUser",
|
|
|
"sourceName" : "user",
|
|
|
"sourceParentPath" : ""
|
|
|
}, {
|
|
|
"name" : "DocumentFilename",
|
|
|
"sourceName" : "fileName",
|
|
|
"sourceParentPath" : "data"
|
|
|
}, {
|
|
|
"name" : "DocumentBucketURL",
|
|
|
"sourceName" : "bucketURL",
|
|
|
"sourceParentPath" : "data"
|
|
|
}, {
|
|
|
"name" : "DocumentMimeType",
|
|
|
"sourceName" : "mimeType",
|
|
|
"sourceParentPath" : "data"
|
|
|
}, {
|
|
|
"name" : "DocumentDateCreated",
|
|
|
"sourceName" : "dateCreated",
|
|
|
"sourceParentPath" : "data"
|
|
|
} ],
|
|
|
"search:workshop:document:1.0.0" : [ {
|
|
|
"name" : "kind",
|
|
|
"sourceName" : "kind",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "id",
|
|
|
"sourceName" : "id",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DocumentLegal",
|
|
|
"sourceName" : "legal",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DatalakeAcl",
|
|
|
"sourceName" : "acl",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "Source",
|
|
|
"sourceName" : "namespace",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DatalakeStatus",
|
|
|
"sourceName" : "status",
|
|
|
"sourceParentPath" : "results::legal"
|
|
|
}, {
|
|
|
"name" : "DocumentLakeVersion",
|
|
|
"sourceName" : "version",
|
|
|
"sourceParentPath" : "results"
|
|
|
}, {
|
|
|
"name" : "DocumentFilename",
|
|
|
"sourceName" : "fileName",
|
|
|
"sourceParentPath" : "results::data"
|
|
|
} ]
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="create-entity"></a>
|
|
|
### entity
|
|
|
```
|
|
|
POST /entity
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API registers/creates a new entity in datalake. Newly created source appears in Entity drop down in Dropfile widget and Entities tab in Data catalog screen in DM App.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[EntityRequest](#entityrequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[RestCallRequest](#restcallrequest)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Source Entity Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"displayName" : "completion",
|
|
|
"definition" : "A generic term used to describe the events and equipment necessary to bring a wellbore into production once drilling operations have been concluded, including but not limited to the assembly of downhole tubulars and equipment required to enable safe and efficient production from an oil or gas well. Completions can be expressed in context in a WITSML document.",
|
|
|
"status" : "Active",
|
|
|
"scope" : "Generic",
|
|
|
"comments" : "",
|
|
|
"entityType" : "completion"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-entity"></a>
|
|
|
### entity
|
|
|
```
|
|
|
GET /entity
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves entity from datalake having entity name as input.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Query**|**entityType** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SourceEntityAttributes](#sourceentityattributes)|
|
|
|
|**404**|Record Not Found|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Source Entity Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="create-raw-wke-gis-entity-schema"></a>
|
|
|
### entitySchema
|
|
|
```
|
|
|
POST /entitySchema
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API creates schema file for raw, WKE and GIS entities. This configuration has datatype mapping for every attribute for that entity. It is used by enrichment and GIS workflows. To create GIS entity schema, use schemaType as GIS. To create Raw/WKE entity schema, do not have schemaType in input payload.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[EntitySchemaRequest](#entityschemarequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"kind" : "common:avocet:completion:1.0.0",
|
|
|
"schema" : [ {
|
|
|
"attributeName" : "NAME",
|
|
|
"datatype" : "TEXT",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
}, {
|
|
|
"attributeName" : "API",
|
|
|
"datatype" : "TEXT",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
}, {
|
|
|
"attributeName" : "LATITUDE",
|
|
|
"datatype" : "NUMBER",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
}, {
|
|
|
"attributeName" : "LONGITUDE",
|
|
|
"datatype" : "NUMBER",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
}, {
|
|
|
"attributeName" : "UWI",
|
|
|
"datatype" : "TEXT",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
}, {
|
|
|
"attributeName" : "TYPE",
|
|
|
"datatype" : "TEXT",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
}, {
|
|
|
"attributeName" : "PRODUCT",
|
|
|
"datatype" : "TEXT",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
}, {
|
|
|
"attributeName" : "STATUS",
|
|
|
"datatype" : "TEXT",
|
|
|
"unit" : "",
|
|
|
"unitSystem" : "",
|
|
|
"measurementType" : "Dimensionless",
|
|
|
"conversionRequired" : false
|
|
|
} ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-raw-wke-gis-entity-schema"></a>
|
|
|
### entitySchema
|
|
|
```
|
|
|
GET /entitySchema/{kind}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves schema file for raw, WKE, and GIS entities from storage having kind as input. By default, it retrieves Raw/WKE schema. To retrieve GIS entity schema, enter schemaType as 'GIS'.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Path**|**kind** <br>*required*||string||
|
|
|
|**Query**|**schemaType** <br>*optional*||string|`"Raw/WKE"`|
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|< [Attribute](#attribute) > array|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="create-raw-wke-entity-view"></a>
|
|
|
### EntityView
|
|
|
```
|
|
|
POST /entityView
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API creates view file for the raw and wke entities. This configuration is used by Data Management App for displaying entity details in Grid View, Card View, Generic Summary Pane(widget).
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[EntityViewRequest](#entityviewrequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"kind" : "common:avocet:completion:1.0.0",
|
|
|
"view" : {
|
|
|
"uiMapping" : [ {
|
|
|
"ValueField" : "Score",
|
|
|
"DisplayField" : "Score",
|
|
|
"Grid" : {
|
|
|
"order" : 1
|
|
|
}
|
|
|
}, {
|
|
|
"ValueField" : "NAME",
|
|
|
"DisplayField" : "Well Name",
|
|
|
"Grid" : {
|
|
|
"order" : 2
|
|
|
},
|
|
|
"JSONHeader" : "true",
|
|
|
"FlyOut" : {
|
|
|
"order" : 1
|
|
|
},
|
|
|
"Tag" : [ "wellName" ]
|
|
|
}, {
|
|
|
"ValueField" : "PRODUCT",
|
|
|
"DisplayField" : "Product",
|
|
|
"Grid" : {
|
|
|
"order" : 3
|
|
|
},
|
|
|
"FlyOut" : {
|
|
|
"order" : 2
|
|
|
}
|
|
|
}, {
|
|
|
"ValueField" : "TYPE",
|
|
|
"DisplayField" : "Well Type",
|
|
|
"Grid" : {
|
|
|
"order" : 4
|
|
|
},
|
|
|
"FlyOut" : {
|
|
|
"order" : 3
|
|
|
}
|
|
|
}, {
|
|
|
"ValueField" : "STATUS",
|
|
|
"DisplayField" : "Current Status",
|
|
|
"Grid" : {
|
|
|
"order" : 5
|
|
|
},
|
|
|
"FlyOut" : {
|
|
|
"order" : 4
|
|
|
}
|
|
|
}, {
|
|
|
"ValueField" : "API",
|
|
|
"DisplayField" : "API",
|
|
|
"Grid" : {
|
|
|
"order" : 6
|
|
|
},
|
|
|
"FlyOut" : {
|
|
|
"order" : 5
|
|
|
}
|
|
|
}, {
|
|
|
"ValueField" : "UWI",
|
|
|
"DisplayField" : "UWI",
|
|
|
"Grid" : {
|
|
|
"order" : 7
|
|
|
},
|
|
|
"FlyOut" : {
|
|
|
"order" : 6
|
|
|
}
|
|
|
}, {
|
|
|
"ValueField" : "LATITUDE",
|
|
|
"DisplayField" : "Surface Location Latitude",
|
|
|
"Grid" : {
|
|
|
"order" : 8
|
|
|
},
|
|
|
"FlyOut" : {
|
|
|
"order" : 7
|
|
|
},
|
|
|
"Tag" : [ "latitude" ]
|
|
|
}, {
|
|
|
"ValueField" : "LONGITUDE",
|
|
|
"DisplayField" : "Surface Location Longitudes",
|
|
|
"Grid" : {
|
|
|
"order" : 9
|
|
|
},
|
|
|
"FlyOut" : {
|
|
|
"order" : 8
|
|
|
},
|
|
|
"Tag" : [ "longitude" ]
|
|
|
} ]
|
|
|
}
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-raw-wke-entity-view"></a>
|
|
|
### EntityView
|
|
|
```
|
|
|
POST /entityView/search
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves view file for raw and wke entities from storage having kind as input.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[EntityViewSearchRequest](#entityviewsearchrequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[EntityViewResponse](#entityviewresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"entityKindNames" : [ "tenant1:devSanityAutomation:wellbore:1.0.0", "tenant1:wke:devSanityAutomation-well:1.0.0" ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="create-gis-mapping-file"></a>
|
|
|
### GISMapping
|
|
|
```
|
|
|
POST /gisMapping
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API maps source attributes to GIS attributes of an entity. This mapping is used by GIS.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[GISMappingRequest](#gismappingrequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* GIS Mapping Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"kind" : "common:ihs:wellbore:1.0.0",
|
|
|
"mapping" : [ {
|
|
|
"id" : 1,
|
|
|
"gisAttributeName" : "Source",
|
|
|
"sourceAttributeName" : "IHS",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 2,
|
|
|
"gisAttributeName" : "Well Name",
|
|
|
"sourceAttributeName" : "Well Name",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 3,
|
|
|
"gisAttributeName" : "Field",
|
|
|
"sourceAttributeName" : "Field Name",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 4,
|
|
|
"gisAttributeName" : "Operator",
|
|
|
"sourceAttributeName" : "Operator Name",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 5,
|
|
|
"gisAttributeName" : "Spud Date",
|
|
|
"sourceAttributeName" : "Spud Date",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 6,
|
|
|
"gisAttributeName" : "Current Status",
|
|
|
"sourceAttributeName" : "Technical Status",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 7,
|
|
|
"gisAttributeName" : "Class",
|
|
|
"sourceAttributeName" : "Well Class",
|
|
|
"isActive" : true
|
|
|
} ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-gis-mapping-file"></a>
|
|
|
### GISMapping
|
|
|
```
|
|
|
GET /gisMapping/{kind}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API gets GIS mapping file from storage having kind as input
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Path**|**kind** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|< [GISMapping](#gismapping) > array|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* GIS Mapping Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="create-merge-definition-file"></a>
|
|
|
### mergeDefinition
|
|
|
```
|
|
|
POST /mergeDefinition
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API defines the priority of the sources for each attribute. This information is looked up at the time of merging to determine whether the value in the incoming source record should replace the existing value in the WKE.The priorities thus defined are referred to as the 'merge definition rule'. Each rule is created with a unique name, and this name is specified as one of the inputs to the enrichment job.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[MergeDefinitionRequest](#mergedefinitionrequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"name" : "bootcamp_cdowellborerule",
|
|
|
"seedSource" : "",
|
|
|
"priorityRankings" : [ {
|
|
|
"attribute" : "WellName",
|
|
|
"priorities" : [ "common:bootcamp_cdo:wellbore:1.0.0", "common:wke:well:1.0.0" ]
|
|
|
}, {
|
|
|
"attribute" : "SurfaceLocationLatitude",
|
|
|
"priorities" : [ "common:bootcamp_cdo:wellbore:1.0.0", "common:wke:well:1.0.0" ]
|
|
|
}, {
|
|
|
"attribute" : "SurfaceLocationLongitude",
|
|
|
"priorities" : [ "common:bootcamp_cdo:wellbore:1.0.0", "common:wke:well:1.0.0" ]
|
|
|
} ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-merge-definition-file"></a>
|
|
|
### mergeDefinition
|
|
|
```
|
|
|
GET /mergeDefinition/{name}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API gets merge definition file from storage having file name as input.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Path**|**name** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[MergeDefinitionRequest](#mergedefinitionrequest)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP response
|
|
|
|
|
|
##### Response 200
|
|
|
```json
|
|
|
{
|
|
|
"name" : "bootcamp_cdowellborerule",
|
|
|
"seedSource" : "",
|
|
|
"priorityRankings" : [ {
|
|
|
"attribute" : "WellName",
|
|
|
"priorities" : [ "common:bootcamp_cdo:wellbore:1.0.0", "common:wke:well:1.0.0" ]
|
|
|
}, {
|
|
|
"attribute" : "SurfaceLocationLatitude",
|
|
|
"priorities" : [ "common:bootcamp_cdo:wellbore:1.0.0", "common:wke:well:1.0.0" ]
|
|
|
}, {
|
|
|
"attribute" : "SurfaceLocationLongitude",
|
|
|
"priorities" : [ "common:bootcamp_cdo:wellbore:1.0.0", "common:wke:well:1.0.0" ]
|
|
|
} ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="create-merge-rule-template"></a>
|
|
|
### mergeTemplate
|
|
|
```
|
|
|
POST /mergeTemplate
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API generates template which is the main input for enrichment process. It denotes the sources that we are merging, the criteria to match the records in them and the merge definition rule name.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[MergeRuleTemplatesRequest](#mergeruletemplatesrequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"jobName" : "workshopJobWellbore",
|
|
|
"mergeRuleTemplateName" : "IntegratedPipeline",
|
|
|
"mergeDefinition" : "workshopwellborerule",
|
|
|
"sourceKind" : "common:workshop:wellbore:1.0.0",
|
|
|
"matchRules" : [ {
|
|
|
"sourceA" : "common:workshop:wellbore:1.0.0",
|
|
|
"sourceB" : "common:wke:well:1.0.0",
|
|
|
"attributeA" : "WellName",
|
|
|
"attributeB" : "WellName"
|
|
|
} ],
|
|
|
"target" : "Well"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-merge-rule-template"></a>
|
|
|
### mergeTemplate
|
|
|
```
|
|
|
GET /mergeTemplate/{sourceKind}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves merge rule template from datastore having template name as input
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Path**|**sourceKind** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[MergeRuleTemplatesRequest](#mergeruletemplatesrequest)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP response
|
|
|
|
|
|
##### Response 200
|
|
|
```json
|
|
|
{
|
|
|
"jobName" : "workshopJobWellbore",
|
|
|
"mergeRuleTemplateName" : "IntegratedPipeline",
|
|
|
"mergeDefinition" : "workshopwellborerule",
|
|
|
"sourceKind" : "common:workshop:wellbore:1.0.0",
|
|
|
"matchRules" : [ {
|
|
|
"sourceA" : "common:workshop:wellbore:1.0.0",
|
|
|
"sourceB" : "common:wke:well:1.0.0",
|
|
|
"attributeA" : "WellName",
|
|
|
"attributeB" : "WellName"
|
|
|
} ],
|
|
|
"target" : "Well"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="create-source"></a>
|
|
|
### source
|
|
|
```
|
|
|
POST /source
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API registers/creates a new source in datalake. Newly created source appears in Source drop down in Dropfile widget and Sources tab in Data catalog screen in DM App.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[SourceRequest](#sourcerequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Source Entity Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"displayName" : "North Dakota",
|
|
|
"definition" : "North Dakota Industrial Commission",
|
|
|
"status" : "Active",
|
|
|
"scope" : "Generic",
|
|
|
"comments" : "Public Dataset",
|
|
|
"namespace" : "ndic"
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-source"></a>
|
|
|
### source
|
|
|
```
|
|
|
GET /source
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves source from datalake having source name as input.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Query**|**namespace** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SourceEntityAttributes](#sourceentityattributes)|
|
|
|
|**404**|Record Not Found|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Source Entity Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="get-source-entity-view"></a>
|
|
|
### uiMetadata
|
|
|
```
|
|
|
GET /uiMetadata
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves Source-Entity view file from storage.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|< [SourceEntityView](#sourceentityview) > array|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="update-source-entity-view"></a>
|
|
|
### uiMetadata
|
|
|
```
|
|
|
PUT /uiMetadata
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API maps entities to its kind. Data Management app uses this generated configuration to list entities with their corresponding sources and is also used to locate the config files by Enrichment process. This is also used by GIS.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[SourceEntityView](#sourceentityview)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"key" : "Avocet",
|
|
|
"value" : "avocet",
|
|
|
"forUI" : true,
|
|
|
"entity" : [ {
|
|
|
"entityName" : "Completions",
|
|
|
"kindName" : "common:avocet:completion:1.0.0",
|
|
|
"forUI" : false
|
|
|
} ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="create-dropfile-widget-template"></a>
|
|
|
### Create Dropfile Widget Template
|
|
|
```
|
|
|
POST /widgetTemplate
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API creates a template that is used in Dropfile widget. This templates defines ingestorRoutine, enrichmentRoutine and other parameters based on source, entity and file type.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[IngestorTemplate](#ingestortemplate)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[TemplatesResponse](#templatesresponse)|
|
|
|
|**400**|Invalid format|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|**404**|Record Not Found|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Dropfile template Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"source" : "onewkShop",
|
|
|
"description" : "Well Summary",
|
|
|
"entityType" : "WellBore",
|
|
|
"fileType" : "csv",
|
|
|
"ingestorRoutines" : "[{\"CSVIngestor\":{\"datasetDescriptor\":\"common:wkshop:wellbore-dataset_descriptor-1.5\",\"overwriteSchema\":false}}]",
|
|
|
"template" : "Wellsummary",
|
|
|
"enrichmentRoutines" : "",
|
|
|
"indexRoutines" : ""
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-dropfile-widget-template"></a>
|
|
|
### Get Dropfile Widget Template
|
|
|
```
|
|
|
GET /widgetTemplate
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API lists all the templates that are used in Dropfile widget.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[TemplatesResponse](#templatesresponse)|
|
|
|
|**400**|Invalid format|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|**404**|Record Not Found|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Dropfile template Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="validate-dropfile-widget-template"></a>
|
|
|
### Validate Dropfile Widget Template
|
|
|
```
|
|
|
GET /widgetTemplate/validate
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API validates if the template name is available for registration.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Query**|**templateName** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|boolean|
|
|
|
|**400**|Invalid format|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|**404**|Record Not Found|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Dropfile template Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="delete-dropfile-widget-template"></a>
|
|
|
### Delete Dropfile Widget Template
|
|
|
```
|
|
|
DELETE /widgetTemplate/{templateName}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API deletes a template that is used in Dropfile widget.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Path**|**templateName** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**204**|A successful response|No Content|
|
|
|
|**400**|Invalid format|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|**404**|Record Not Found|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Dropfile template Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
<a name="create-source-schema-for-well-known-entity"></a>
|
|
|
### wke source schema
|
|
|
```
|
|
|
POST /wkeSchema
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API creates a mapping between the raw source attributes and the well known attributes. It lists the attributes of the source and describes what the equivalent WKE attribute is, which is needed to merge two sources.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Body**|**body** <br>*optional*||[WkeSchemaRequest](#wkeschemarequest)||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|[SuccessResponse](#successresponse)|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
#### Example HTTP request
|
|
|
|
|
|
##### Request body
|
|
|
```json
|
|
|
{
|
|
|
"kind" : "common:tokyo:wellbore:1.0.0",
|
|
|
"wkeName" : "well",
|
|
|
"schema" : [ {
|
|
|
"id" : 1,
|
|
|
"wkaAttributeName" : "WellName",
|
|
|
"sourceAttributeName" : "Well_Name",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 2,
|
|
|
"wkaAttributeName" : "SurfaceLocationLatitude",
|
|
|
"sourceAttributeName" : "Latitude",
|
|
|
"isActive" : true
|
|
|
}, {
|
|
|
"id" : 3,
|
|
|
"wkaAttributeName" : "SurfaceLocationLongitude",
|
|
|
"sourceAttributeName" : "Longitude",
|
|
|
"isActive" : true
|
|
|
} ]
|
|
|
}
|
|
|
```
|
|
|
|
|
|
|
|
|
<a name="get-source-schema-for-well-known-entity"></a>
|
|
|
### wke source schema
|
|
|
```
|
|
|
GET /wkeSchema/{wkeName}/{kind}
|
|
|
```
|
|
|
|
|
|
|
|
|
#### Description
|
|
|
This API retrieves the source schema for wke from storage having wke name and kind as input.
|
|
|
|
|
|
|
|
|
#### Parameters
|
|
|
|
|
|
|Type|Name|Description|Schema|Default|
|
|
|
|---|---|---|---|---|
|
|
|
|**Header**|**Slb-Account-Id** <br>*optional*|Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-Data-Partition-Id** <br>*required*|SLB Data Partition Id is required when SLB Account Id is not given. This is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.|string|`"common"`|
|
|
|
|**Header**|**Slb-On-Behalf-Of** <br>*optional*|Token (Google ID or SAuth) representing the user whose request is sent on behalf of.|string||
|
|
|
|**Path**|**kind** <br>*required*||string||
|
|
|
|**Path**|**wkeName** <br>*required*||string||
|
|
|
|
|
|
|
|
|
#### Responses
|
|
|
|
|
|
|HTTP Code|Description|Schema|
|
|
|
|---|---|---|
|
|
|
|**200**|A successful response|< [WkaAttribute](#wkaattribute) > array|
|
|
|
|**400**|Business validation failed|[ErrorResponseFormat](#errorresponseformat)|
|
|
|
|
|
|
|
|
|
#### Consumes
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Produces
|
|
|
|
|
|
* `application/json`
|
|
|
|
|
|
|
|
|
#### Tags
|
|
|
|
|
|
* Enrichment Configuration
|
|
|
|
|
|
|
|
|
#### Security
|
|
|
|
|
|
|Type|Name|
|
|
|
|---|---|
|
|
|
|**oauth2**|**[sauth_id_token](#sauth_id_token)**|
|
|
|
|**oauth2**|**[google_id_token](#google_id_token)**|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="definitions"></a>
|
|
|
## Definitions
|
|
|
|
|
|
<a name="associatedobject"></a>
|
|
|
### AssociatedObject
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**childAttribute** <br>*optional*|string|
|
|
|
|**entityName** <br>*optional*|string|
|
|
|
|**folder** <br>*optional*|string|
|
|
|
|**kindName** <br>*optional*|string|
|
|
|
|**parentAttribute** <br>*optional*|string|
|
|
|
|**query** <br>*optional*|string|
|
|
|
|**value** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="attribute"></a>
|
|
|
### Attribute
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**attributeName** <br>*optional*|string|
|
|
|
|**conversionRequired** <br>*optional*|boolean|
|
|
|
|**datatype** <br>*optional*|string|
|
|
|
|**format** <br>*optional*|string|
|
|
|
|**latitude** <br>*optional*|string|
|
|
|
|**longitude** <br>*optional*|string|
|
|
|
|**measurementType** <br>*optional*|string|
|
|
|
|**namespace** <br>*optional*|string|
|
|
|
|**type** <br>*optional*|string|
|
|
|
|**unit** <br>*optional*|string|
|
|
|
|**unitSystem** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="documentmappingrequest"></a>
|
|
|
### DocumentMappingRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**entity_map** <br>*optional*|< string, < [EntityMap](#entitymap) > array > map|
|
|
|
|
|
|
|
|
|
<a name="entity"></a>
|
|
|
### Entity
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**entityName** <br>*optional*|string|
|
|
|
|**folder** <br>*optional*|string|
|
|
|
|**forUI** <br>*optional*|boolean|
|
|
|
|**kindName** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="entitymap"></a>
|
|
|
### EntityMap
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**name** <br>*optional*|string|
|
|
|
|**sourceName** <br>*optional*|string|
|
|
|
|**sourceParentPath** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="entityrequest"></a>
|
|
|
### EntityRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**comments** <br>*optional*|string|
|
|
|
|**created** <br>*optional*|string|
|
|
|
|**createdBy** <br>*optional*|string|
|
|
|
|**definition** <br>*optional*|string|
|
|
|
|**displayName** <br>*optional*|string|
|
|
|
|**entityType** <br>*optional*|string|
|
|
|
|**lastUpdated** <br>*optional*|string|
|
|
|
|**lastUpdatedBy** <br>*optional*|string|
|
|
|
|**scope** <br>*optional*|string|
|
|
|
|**status** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="entityschemarequest"></a>
|
|
|
### EntitySchemaRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**kind** <br>*optional*|string|
|
|
|
|**schema** <br>*optional*|< [Attribute](#attribute) > array|
|
|
|
|**schemaType** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="entityviewrequest"></a>
|
|
|
### EntityViewRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**kind** <br>*optional*|string|
|
|
|
|**view** <br>*optional*|[Mapping](#mapping)|
|
|
|
|
|
|
|
|
|
<a name="entityviewresponse"></a>
|
|
|
### EntityViewResponse
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**entityViewData** <br>*optional*|< [EntityViewRequest](#entityviewrequest) > array|
|
|
|
|**error** <br>*optional*|< [ErrorModel](#errormodel) > array|
|
|
|
|
|
|
|
|
|
<a name="entityviewsearchrequest"></a>
|
|
|
### EntityViewSearchRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**entityKindNames** <br>*optional*|< string > array|
|
|
|
|
|
|
|
|
|
<a name="error"></a>
|
|
|
### Error
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**domain** <br>*optional*|string|
|
|
|
|**message** <br>*optional*|string|
|
|
|
|**reason** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="errormodel"></a>
|
|
|
### ErrorModel
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**code** <br>*optional*|integer (int32)|
|
|
|
|**errors** <br>*optional*|< [Error](#error) > array|
|
|
|
|**message** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="errorresponseformat"></a>
|
|
|
### ErrorResponseFormat
|
|
|
An error that occurs during normal application logic
|
|
|
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**error** <br>*optional*|[ErrorModel](#errormodel)|
|
|
|
|
|
|
|
|
|
<a name="gismapping"></a>
|
|
|
### GISMapping
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**gisAttributeName** <br>*optional*|string|
|
|
|
|**id** <br>*optional*|integer (int32)|
|
|
|
|**isActive** <br>*optional*|boolean|
|
|
|
|**sourceAttributeName** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="gismappingrequest"></a>
|
|
|
### GISMappingRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**kind** <br>*optional*|string|
|
|
|
|**mapping** <br>*optional*|< [GISMapping](#gismapping) > array|
|
|
|
|
|
|
|
|
|
<a name="ingestortemplate"></a>
|
|
|
### IngestorTemplate
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**description** <br>*optional*|string|
|
|
|
|**enrichmentRoutines** <br>*optional*|string|
|
|
|
|**entityType** <br>*optional*|string|
|
|
|
|**fileType** <br>*optional*|string|
|
|
|
|**indexRoutines** <br>*optional*|string|
|
|
|
|**ingestorRoutines** <br>*optional*|string|
|
|
|
|**source** <br>*optional*|string|
|
|
|
|**template** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="mapping"></a>
|
|
|
### Mapping
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**associatedObject** <br>*optional*|< [AssociatedObject](#associatedobject) > array|
|
|
|
|**parents** <br>*optional*|< [Parent](#parent) > array|
|
|
|
|**uiMapping** <br>*optional*|< [UIMapping](#uimapping) > array|
|
|
|
|
|
|
|
|
|
<a name="matchrule"></a>
|
|
|
### MatchRule
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**attributeA** <br>*optional*|string|
|
|
|
|**attributeB** <br>*optional*|string|
|
|
|
|**sourceA** <br>*optional*|string|
|
|
|
|**sourceB** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="mergedefinitionrequest"></a>
|
|
|
### MergeDefinitionRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**name** <br>*optional*|string|
|
|
|
|**priorityRankings** <br>*optional*|< [PriorityRanking](#priorityranking) > array|
|
|
|
|**seedSource** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="mergeruletemplatesrequest"></a>
|
|
|
### MergeRuleTemplatesRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**jobName** <br>*optional*|string|
|
|
|
|**matchRules** <br>*optional*|< [MatchRule](#matchrule) > array|
|
|
|
|**mergeDefinition** <br>*optional*|string|
|
|
|
|**mergeRuleTemplateName** <br>*optional*|string|
|
|
|
|**sourceKind** <br>*optional*|string|
|
|
|
|**target** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="parent"></a>
|
|
|
### Parent
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**attributeName** <br>*optional*|string|
|
|
|
|**folder** <br>*optional*|string|
|
|
|
|**kindName** <br>*optional*|string|
|
|
|
|**parentAttributeName** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="priorityranking"></a>
|
|
|
### PriorityRanking
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**attribute** <br>*optional*|string|
|
|
|
|**priorities** <br>*optional*|< string > array|
|
|
|
|
|
|
|
|
|
<a name="restcallrequest"></a>
|
|
|
### RestCallRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**authorization** <br>*optional*|string|
|
|
|
|**method** <br>*optional*|enum (GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE)|
|
|
|
|**payload** <br>*optional*|string|
|
|
|
|**serviceUrl** <br>*optional*|string|
|
|
|
|**slbAccountId** <br>*optional*|string|
|
|
|
|**slbCorrelationId** <br>*optional*|string|
|
|
|
|**slbOnBehalfOf** <br>*optional*|string|
|
|
|
|**tenantInfo** <br>*optional*|[TenantInfo](#tenantinfo)|
|
|
|
|
|
|
|
|
|
<a name="sourceentityattributes"></a>
|
|
|
### SourceEntityAttributes
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**comments** <br>*optional*|string|
|
|
|
|**created** <br>*optional*|string|
|
|
|
|**createdBy** <br>*optional*|string|
|
|
|
|**definition** <br>*optional*|string|
|
|
|
|**displayName** <br>*optional*|string|
|
|
|
|**lastUpdated** <br>*optional*|string|
|
|
|
|**lastUpdatedBy** <br>*optional*|string|
|
|
|
|**scope** <br>*optional*|string|
|
|
|
|**status** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="sourceentityview"></a>
|
|
|
### SourceEntityView
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**entity** <br>*optional*|< [Entity](#entity) > array|
|
|
|
|**forUI** <br>*optional*|boolean|
|
|
|
|**key** <br>*optional*|string|
|
|
|
|**value** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="sourcerequest"></a>
|
|
|
### SourceRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**comments** <br>*optional*|string|
|
|
|
|**created** <br>*optional*|string|
|
|
|
|**createdBy** <br>*optional*|string|
|
|
|
|**definition** <br>*optional*|string|
|
|
|
|**displayName** <br>*optional*|string|
|
|
|
|**lastUpdated** <br>*optional*|string|
|
|
|
|**lastUpdatedBy** <br>*optional*|string|
|
|
|
|**namespace** <br>*optional*|string|
|
|
|
|**scope** <br>*optional*|string|
|
|
|
|**status** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="successresponse"></a>
|
|
|
### SuccessResponse
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**message** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="templatesresponse"></a>
|
|
|
### TemplatesResponse
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**templates** <br>*optional*|< [IngestorTemplate](#ingestortemplate) > array|
|
|
|
|
|
|
|
|
|
<a name="tenantinfo"></a>
|
|
|
### TenantInfo
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**complianceRuleSet** <br>*optional*|string|
|
|
|
|**crmAccountIds** <br>*optional*|< string > array|
|
|
|
|**dataPartitionId** <br>*optional*|string|
|
|
|
|**id** <br>*optional*|integer (int64)|
|
|
|
|**name** <br>*optional*|string|
|
|
|
|**projectId** <br>*optional*|string|
|
|
|
|**serviceAccount** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="uimapping"></a>
|
|
|
### UIMapping
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**Card** <br>*optional*|< string, integer (int32) > map|
|
|
|
|**DisplayField** <br>*optional*|string|
|
|
|
|**FeaturedAttribute** <br>*optional*|boolean|
|
|
|
|**FlyOut** <br>*optional*|< string, object > map|
|
|
|
|**Grid** <br>*optional*|< string, integer (int32) > map|
|
|
|
|**JSONHeader** <br>*optional*|string|
|
|
|
|**Lineage** <br>*optional*|< string, integer (int32) > map|
|
|
|
|**Tag** <br>*optional*|< string > array|
|
|
|
|**ValueField** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="wkaattribute"></a>
|
|
|
### WkaAttribute
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**id** <br>*optional*|integer (int32)|
|
|
|
|**isActive** <br>*optional*|boolean|
|
|
|
|**sourceAttributeName** <br>*optional*|string|
|
|
|
|**sourceDatatype** <br>*optional*|string|
|
|
|
|**sourceFormat** <br>*optional*|string|
|
|
|
|**wkaAttributeName** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
<a name="wkeschemarequest"></a>
|
|
|
### WkeSchemaRequest
|
|
|
|
|
|
|Name|Schema|
|
|
|
|---|---|
|
|
|
|**kind** <br>*optional*|string|
|
|
|
|**schema** <br>*optional*|< [WkaAttribute](#wkaattribute) > array|
|
|
|
|**wkeName** <br>*optional*|string|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a name="securityscheme"></a>
|
|
|
## Security
|
|
|
|
|
|
<a name="google_id_token"></a>
|
|
|
### google_id_token
|
|
|
*Type* : oauth2
|
|
|
*Flow* : implicit
|
|
|
*Token URL* : OAUTH_AUTHORIZATION_URL_VALUE
|
|
|
|
|
|
|
|
|
<a name="sauth_id_token"></a>
|
|
|
### sauth_id_token
|
|
|
*Type* : oauth2
|
|
|
*Flow* : implicit
|
|
|
*Token URL* : SAUTH_AUTHORIZATION_URL_VALUE
|
|
|
|
|
|
|
|
|
|