|
|
```
|
|
|
{
|
|
|
"swagger": "2.0",
|
|
|
"info": {
|
|
|
"description": "These API's will provide an interface for basic configuration settings",
|
|
|
"version": "1.0.0",
|
|
|
"title": "Data Catalog Service"
|
|
|
},
|
|
|
"host": "DATA_CATALOG_SERVICE_GOOGLE_ENDPOINT_NAME_VALUE",
|
|
|
"basePath": "/datacatalog/v1",
|
|
|
"tags": [{
|
|
|
"name": "Source Entity Configuration",
|
|
|
"description": "Source/Entity CRUD operation."
|
|
|
},
|
|
|
{
|
|
|
"name": "Dropfile template Configuration",
|
|
|
"description": "Dropfile CRUD operation."
|
|
|
},
|
|
|
{
|
|
|
"name": "Enrichment Configuration",
|
|
|
"description": "Enrichment CRUD operation"
|
|
|
},
|
|
|
{
|
|
|
"name": "OCR Mapping Configuration",
|
|
|
"description": "OCR mapping CRUD operation"
|
|
|
},
|
|
|
{
|
|
|
"name": "GIS Mapping Configuration",
|
|
|
"description": "GIS mapping CRUD operation"
|
|
|
}
|
|
|
],
|
|
|
"schemes": [
|
|
|
"https"
|
|
|
],
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
],
|
|
|
"paths": {
|
|
|
"/OCRMapping/{source}": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"OCR Mapping Configuration"
|
|
|
],
|
|
|
"summary": "OCRMapping",
|
|
|
"description": "This API retrieves OCR Mapping file from storage having source as input.",
|
|
|
"operationId": "Get OCR Mapping File",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "source",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/DocumentMappingRequest"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/OCRMapping": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"OCR Mapping Configuration"
|
|
|
],
|
|
|
"summary": "OCRMapping",
|
|
|
"description": "This API maps source attributes to attributes of enriched document entity that is used by search functionality of document enriched metadata.",
|
|
|
"operationId": "Create OCR Mapping File",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/DocumentMappingRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/entity": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Source Entity Configuration"
|
|
|
],
|
|
|
"summary": "entity",
|
|
|
"description": "This API retrieves entity from datalake having entity name as input.",
|
|
|
"operationId": "Get Entity",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "entityType",
|
|
|
"in": "query",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SourceEntityAttributes"
|
|
|
}
|
|
|
},
|
|
|
"404": {
|
|
|
"description": "Record Not Found",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
},
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Source Entity Configuration"
|
|
|
],
|
|
|
"summary": "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.",
|
|
|
"operationId": "Create Entity",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/EntityRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/RestCallRequest"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/entitySchema": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "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.",
|
|
|
"operationId": "Create Raw/WKE/GIS Entity Schema",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/EntitySchemaRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/entitySchema/{kind}": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "entitySchema",
|
|
|
"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'.",
|
|
|
"operationId": "Get Raw/WKE/GIS Entity Schema",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "kind",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "schemaType",
|
|
|
"in": "query",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "Raw/WKE"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/Attribute"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/entityView/search": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "EntityView",
|
|
|
"description": "This API retrieves view file for raw and wke entities from storage having kind as input.",
|
|
|
"operationId": "Get Raw/WKE Entity View",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/EntityViewSearchRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/EntityViewResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/entityView": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "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).",
|
|
|
"operationId": "Create Raw/WKE Entity View",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/EntityViewRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/gisMapping": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"GIS Mapping Configuration"
|
|
|
],
|
|
|
"summary": "GISMapping",
|
|
|
"description": "This API maps source attributes to GIS attributes of an entity. This mapping is used by GIS.",
|
|
|
"operationId": "Create GIS Mapping File",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/GISMappingRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/gisMapping/{kind}": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"GIS Mapping Configuration"
|
|
|
],
|
|
|
"summary": "GISMapping",
|
|
|
"description": "This API gets GIS mapping file from storage having kind as input",
|
|
|
"operationId": "Get GIS Mapping file",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "kind",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/GISMapping"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/widgetTemplate": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Dropfile template Configuration"
|
|
|
],
|
|
|
"summary": "Get Dropfile Widget Template",
|
|
|
"description": "This API lists all the templates that are used in Dropfile widget.",
|
|
|
"operationId": "Get Dropfile Widget Template",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/TemplatesResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Invalid format",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
},
|
|
|
"404": {
|
|
|
"description": "Record Not Found",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
},
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Dropfile template Configuration"
|
|
|
],
|
|
|
"summary": "Create Dropfile Widget Template",
|
|
|
"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.",
|
|
|
"operationId": "Create Dropfile Widget Template",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/IngestorTemplate"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/TemplatesResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Invalid format",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
},
|
|
|
"404": {
|
|
|
"description": "Record Not Found",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/widgetTemplate/validate": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Dropfile template Configuration"
|
|
|
],
|
|
|
"summary": "Validate Dropfile Widget Template",
|
|
|
"description": "This API validates if the template name is available for registration.",
|
|
|
"operationId": "Validate Dropfile Widget Template",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "templateName",
|
|
|
"in": "query",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"type": "boolean"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Invalid format",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
},
|
|
|
"404": {
|
|
|
"description": "Record Not Found",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/widgetTemplate/{templateName}": {
|
|
|
"delete": {
|
|
|
"tags": [
|
|
|
"Dropfile template Configuration"
|
|
|
],
|
|
|
"summary": "Delete Dropfile Widget Template",
|
|
|
"description": "This API deletes a template that is used in Dropfile widget.",
|
|
|
"operationId": "Delete Dropfile Widget Template",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "templateName",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"204": {
|
|
|
"description": "A successful response"
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Invalid format",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
},
|
|
|
"404": {
|
|
|
"description": "Record Not Found",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/mergeDefinition/{name}": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "mergeDefinition",
|
|
|
"description": "This API gets merge definition file from storage having file name as input.",
|
|
|
"operationId": "Get Merge Definition file",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "name",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/MergeDefinitionRequest"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/mergeDefinition": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "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.",
|
|
|
"operationId": "Create Merge Definition File",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/MergeDefinitionRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/mergeTemplate/{sourceKind}": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "mergeTemplate",
|
|
|
"description": "This API retrieves merge rule template from datastore having template name as input",
|
|
|
"operationId": "Get Merge Rule Template",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "sourceKind",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/MergeRuleTemplatesRequest"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/mergeTemplate": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "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.",
|
|
|
"operationId": "Create Merge Rule Template",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/MergeRuleTemplatesRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/source": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Source Entity Configuration"
|
|
|
],
|
|
|
"summary": "source",
|
|
|
"description": "This API retrieves source from datalake having source name as input. ",
|
|
|
"operationId": "Get Source",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "namespace",
|
|
|
"in": "query",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SourceEntityAttributes"
|
|
|
}
|
|
|
},
|
|
|
"404": {
|
|
|
"description": "Record Not Found",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
},
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Source Entity Configuration"
|
|
|
],
|
|
|
"summary": "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.",
|
|
|
"operationId": "Create Source",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SourceRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/uiMetadata": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "uiMetadata",
|
|
|
"description": "This API retrieves Source-Entity view file from storage.",
|
|
|
"operationId": "Get Source-Entity view",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/SourceEntityView"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
},
|
|
|
"put": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "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.",
|
|
|
"operationId": "Update Source-Entity view",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SourceEntityView"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/wkeSchema/{wkeName}/{kind}": {
|
|
|
"get": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "wke source schema",
|
|
|
"description": "This API retrieves the source schema for wke from storage having wke name and kind as input.",
|
|
|
"operationId": "Get Source Schema for Well Known Entity",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"name": "wkeName",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "kind",
|
|
|
"in": "path",
|
|
|
"required": true,
|
|
|
"type": "string"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/WkaAttribute"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/wkeSchema": {
|
|
|
"post": {
|
|
|
"tags": [
|
|
|
"Enrichment Configuration"
|
|
|
],
|
|
|
"summary": "wke source schema",
|
|
|
"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.",
|
|
|
"operationId": "Create Source Schema for Well Known Entity",
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"parameters": [{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/WkeSchemaRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Account-Id",
|
|
|
"in": "header",
|
|
|
"description": "Account ID is the active DELFI account (SLB account or customer's account) which the users choose to use with the Ingestion API.",
|
|
|
"required": false,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-Data-Partition-Id",
|
|
|
"in": "header",
|
|
|
"description": "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.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "common"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "Token (Google ID or SAuth) representing the user whose request is sent on behalf of.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SuccessResponse"
|
|
|
}
|
|
|
},
|
|
|
"400": {
|
|
|
"description": "Business validation failed",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ErrorResponseFormat"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [{
|
|
|
"sauth_id_token": []
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": []
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"securityDefinitions": {
|
|
|
"google_id_token": {
|
|
|
"type": "oauth2",
|
|
|
"authorizationUrl": "OAUTH_AUTHORIZATION_URL_VALUE",
|
|
|
"flow": "implicit",
|
|
|
"x-google-issuer": "OAUTH_ISSUER_VALUE",
|
|
|
"x-google-jwks_uri": "OAUTH_AUTHORIZATION_JWKS_URI_VALUE",
|
|
|
"x-google-audiences": "AUTOMATION_CLIENT_ID_VALUE"
|
|
|
},
|
|
|
"sauth_id_token": {
|
|
|
"type": "oauth2",
|
|
|
"authorizationUrl": "SAUTH_AUTHORIZATION_URL_VALUE",
|
|
|
"flow": "implicit",
|
|
|
"x-google-issuer": "SAUTH_ISSUER_VALUE",
|
|
|
"x-google-jwks_uri": "SAUTH_AUTHORIZATION_JWKS_URI_VALUE",
|
|
|
"x-google-audiences": "*"
|
|
|
}
|
|
|
},
|
|
|
"definitions": {
|
|
|
"DocumentMappingRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"entity_map": {
|
|
|
"type": "object",
|
|
|
"additionalProperties": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/EntityMap"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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"
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"EntityMap": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"name": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"sourceName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"sourceParentPath": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Error": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"message": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"reason": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"domain": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"ErrorModel": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"errors": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/Error"
|
|
|
}
|
|
|
},
|
|
|
"code": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
},
|
|
|
"message": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"ErrorResponseFormat": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"error": {
|
|
|
"$ref": "#/definitions/ErrorModel"
|
|
|
}
|
|
|
},
|
|
|
"description": "An error that occurs during normal application logic"
|
|
|
},
|
|
|
"SuccessResponse": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"message": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"RestCallRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"authorization": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"slbAccountId": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"slbOnBehalfOf": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"slbCorrelationId": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"serviceUrl": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"payload": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"method": {
|
|
|
"type": "string",
|
|
|
"enum": [
|
|
|
"GET",
|
|
|
"HEAD",
|
|
|
"POST",
|
|
|
"PUT",
|
|
|
"PATCH",
|
|
|
"DELETE",
|
|
|
"OPTIONS",
|
|
|
"TRACE"
|
|
|
]
|
|
|
},
|
|
|
"tenantInfo": {
|
|
|
"$ref": "#/definitions/TenantInfo"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"TenantInfo": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"id": {
|
|
|
"type": "integer",
|
|
|
"format": "int64"
|
|
|
},
|
|
|
"name": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"projectId": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"serviceAccount": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"complianceRuleSet": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"dataPartitionId": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"crmAccountIds": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"EntityRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"created": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"createdBy": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"lastUpdated": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"lastUpdatedBy": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"displayName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"definition": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"status": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"scope": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"comments": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"entityType": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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"
|
|
|
}
|
|
|
},
|
|
|
"SourceEntityAttributes": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"created": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"createdBy": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"lastUpdated": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"lastUpdatedBy": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"displayName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"definition": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"status": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"scope": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"comments": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Attribute": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"attributeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"datatype": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"type": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"latitude": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"longitude": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"format": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"unit": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"unitSystem": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"namespace": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"measurementType": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"conversionRequired": {
|
|
|
"type": "boolean"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"EntitySchemaRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"schemaType": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"schema": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/Attribute"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"AssociatedObject": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"entityName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"kindName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"folder": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"query": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"value": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"parentAttribute": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"childAttribute": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"EntityViewRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"view": {
|
|
|
"$ref": "#/definitions/Mapping"
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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"
|
|
|
]
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"EntityViewResponse": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"entityViewData": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/EntityViewRequest"
|
|
|
}
|
|
|
},
|
|
|
"error": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/ErrorModel"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Mapping": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"associatedObject": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/AssociatedObject"
|
|
|
}
|
|
|
},
|
|
|
"parents": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/Parent"
|
|
|
}
|
|
|
},
|
|
|
"uiMapping": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/UIMapping"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Parent": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"kindName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"folder": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"parentAttributeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"attributeName": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"UIMapping": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"ValueField": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"DisplayField": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"Grid": {
|
|
|
"type": "object",
|
|
|
"additionalProperties": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
}
|
|
|
},
|
|
|
"JSONHeader": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"FlyOut": {
|
|
|
"type": "object",
|
|
|
"additionalProperties": {
|
|
|
"type": "object"
|
|
|
}
|
|
|
},
|
|
|
"Tag": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"Card": {
|
|
|
"type": "object",
|
|
|
"additionalProperties": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
}
|
|
|
},
|
|
|
"FeaturedAttribute": {
|
|
|
"type": "boolean"
|
|
|
},
|
|
|
"Lineage": {
|
|
|
"type": "object",
|
|
|
"additionalProperties": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"EntityViewSearchRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"entityKindNames": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"entityKindNames": [
|
|
|
"tenant1:devSanityAutomation:wellbore:1.0.0",
|
|
|
"tenant1:wke:devSanityAutomation-well:1.0.0"
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"GISMapping": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"id": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
},
|
|
|
"gisAttributeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"sourceAttributeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"isActive": {
|
|
|
"type": "boolean"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"GISMappingRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"mapping": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/GISMapping"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"IngestorTemplate": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"source": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"description": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"entityType": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"fileType": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"ingestorRoutines": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"template": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"enrichmentRoutines": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"indexRoutines": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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": ""
|
|
|
}
|
|
|
},
|
|
|
"TemplatesResponse": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"templates": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/IngestorTemplate"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"MergeDefinitionRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"name": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"seedSource": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"priorityRankings": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/PriorityRanking"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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"
|
|
|
]
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"PriorityRanking": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"attribute": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"priorities": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"MatchRule": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"sourceA": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"sourceB": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"attributeA": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"attributeB": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"MergeRuleTemplatesRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"jobName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"mergeRuleTemplateName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"mergeDefinition": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"sourceKind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"matchRules": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/MatchRule"
|
|
|
}
|
|
|
},
|
|
|
"target": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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"
|
|
|
}
|
|
|
},
|
|
|
"SourceRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"created": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"createdBy": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"lastUpdated": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"lastUpdatedBy": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"displayName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"definition": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"status": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"scope": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"comments": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"namespace": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"displayName": "North Dakota",
|
|
|
"definition": "North Dakota Industrial Commission",
|
|
|
"status": "Active",
|
|
|
"scope": "Generic",
|
|
|
"comments": "Public Dataset",
|
|
|
"namespace": "ndic"
|
|
|
}
|
|
|
},
|
|
|
"Entity": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"entityName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"kindName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"folder": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"forUI": {
|
|
|
"type": "boolean"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"SourceEntityView": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"key": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"value": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"forUI": {
|
|
|
"type": "boolean"
|
|
|
},
|
|
|
"entity": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/Entity"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"key": "Avocet",
|
|
|
"value": "avocet",
|
|
|
"forUI": true,
|
|
|
"entity": [{
|
|
|
"entityName": "Completions",
|
|
|
"kindName": "common:avocet:completion:1.0.0",
|
|
|
"forUI": false
|
|
|
}]
|
|
|
}
|
|
|
},
|
|
|
"WkaAttribute": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"id": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
},
|
|
|
"wkaAttributeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"sourceAttributeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"isActive": {
|
|
|
"type": "boolean"
|
|
|
},
|
|
|
"sourceDatatype": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"sourceFormat": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"WkeSchemaRequest": {
|
|
|
"type": "object",
|
|
|
"properties": {
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"wkeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"schema": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/WkaAttribute"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"example": {
|
|
|
"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
|
|
|
}
|
|
|
]
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"x-google-endpoints": [{
|
|
|
"name": "DATA_CATALOG_SERVICE_GOOGLE_ENDPOINT_NAME_VALUE",
|
|
|
"target": "DATA_CATALOG_SERVICE_GOOGLE_ENDPOINT_IP_VALUE"
|
|
|
}]
|
|
|
|
|
|
} |
|
|
\ No newline at end of file |