|
|
```
|
|
|
{
|
|
|
"swagger": "2.0",
|
|
|
"info": {
|
|
|
"version": "1.0.1.20",
|
|
|
"title": "Fetch API",
|
|
|
"description": "Endpoints to fetch & Search Data"
|
|
|
},
|
|
|
"host": "fetch-dot-evt-ddl-us-services.appspot.com",
|
|
|
"basePath": "/_ah/api",
|
|
|
"schemes": [
|
|
|
"https"
|
|
|
],
|
|
|
"consumes": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"produces": [
|
|
|
"application/json"
|
|
|
],
|
|
|
"paths": {
|
|
|
"/fetch/v1/lineage": {
|
|
|
"post": {
|
|
|
"operationId": "FetchGetEntityLineage",
|
|
|
"summary": "Get All Versions for WKE",
|
|
|
"description": "The API supports fetching all available versions for a WKE when WKE entityId and the WKE kind is provided.",
|
|
|
"parameters": [
|
|
|
{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/LineageRequest"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"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 Search API.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "tenant1"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "On behalf email or token is the token/email of the original user making the call. For now, only email is supported but eventually, primary usage will be token.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ResponseData"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [
|
|
|
{
|
|
|
"Bearer": [
|
|
|
|
|
|
]
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": [
|
|
|
|
|
|
]
|
|
|
},
|
|
|
{
|
|
|
"sauth_id_token": [
|
|
|
|
|
|
]
|
|
|
}
|
|
|
],
|
|
|
"tags": [
|
|
|
"enrichment_fetch_service"
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/fetch/v1/match": {
|
|
|
"post": {
|
|
|
"operationId": "FetchMatchData",
|
|
|
"summary": "Get Child Entities for WKE",
|
|
|
"description": "The API supports fetching child entities for a WKE when WKE Id and the child entity kind is provided.",
|
|
|
"parameters": [
|
|
|
{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SourceQueryDefinition"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"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 Search API.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "tenant1"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "On behalf email or token is the token/email of the original user making the call. For now, only email is supported but eventually, primary usage will be token.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ResponseData"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [
|
|
|
{
|
|
|
"Bearer": [
|
|
|
|
|
|
]
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": [
|
|
|
|
|
|
]
|
|
|
},
|
|
|
{
|
|
|
"sauth_id_token": [
|
|
|
|
|
|
]
|
|
|
}
|
|
|
],
|
|
|
"tags": [
|
|
|
"enrichment_fetch_service"
|
|
|
]
|
|
|
}
|
|
|
},
|
|
|
"/fetch/v1/search": {
|
|
|
"post": {
|
|
|
"operationId": "FetchSearchData",
|
|
|
"summary": "Search WKE Entities",
|
|
|
"description": "The API supports full text search on string fields of WKE, range queries on date and numeric, along with geo-spatial search.",
|
|
|
"parameters": [
|
|
|
{
|
|
|
"in": "body",
|
|
|
"name": "body",
|
|
|
"required": false,
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/SourceQueryDefinition"
|
|
|
}
|
|
|
},
|
|
|
{
|
|
|
"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 Search API.",
|
|
|
"required": true,
|
|
|
"type": "string",
|
|
|
"default": "tenant1"
|
|
|
},
|
|
|
{
|
|
|
"name": "Slb-On-Behalf-Of",
|
|
|
"in": "header",
|
|
|
"description": "On behalf email or token is the token/email of the original user making the call. For now, only email is supported but eventually, primary usage will be token.",
|
|
|
"required": false,
|
|
|
"type": "string"
|
|
|
}
|
|
|
],
|
|
|
"responses": {
|
|
|
"200": {
|
|
|
"description": "A successful response",
|
|
|
"schema": {
|
|
|
"$ref": "#/definitions/ResponseData"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"security": [
|
|
|
{
|
|
|
"Bearer": [
|
|
|
|
|
|
]
|
|
|
},
|
|
|
{
|
|
|
"google_id_token": [
|
|
|
|
|
|
]
|
|
|
},
|
|
|
{
|
|
|
"sauth_id_token": [
|
|
|
|
|
|
]
|
|
|
}
|
|
|
],
|
|
|
"tags": [
|
|
|
"enrichment_fetch_service"
|
|
|
]
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"securityDefinitions": {
|
|
|
"Bearer": {
|
|
|
"type": "apiKey",
|
|
|
"name": "Authorization",
|
|
|
"in": "header"
|
|
|
},
|
|
|
"sauth_id_token": {
|
|
|
"authorizationUrl": "https://opsauth-dot-cfsauth-preview.appspot.com/v1/auth",
|
|
|
"flow": "implicit",
|
|
|
"type": "oauth2",
|
|
|
"x-google-issuer": "sauth-preview.slb.com",
|
|
|
"x-google-jwks_uri": "https://opsauth-dot-cfsauth-preview.appspot.com/v1/certs",
|
|
|
"x-google-audiences": "entitlement-datalake.slbclient.com,dev-slbdev-devportal.slbapp.com,test-slbdev-devportal.slbapp.com,localhost3000-dtwdev.slbapp.com,fuse-evd-csp-slb-com-dtwdev.slbapp.com,fuse-evq-csp-slb-com-dtwstage.slbapp.com",
|
|
|
"scopes": {
|
|
|
|
|
|
}
|
|
|
},
|
|
|
"google_id_token": {
|
|
|
"authorizationUrl": "",
|
|
|
"flow": "implicit",
|
|
|
"type": "oauth2",
|
|
|
"x-google-issuer": "https://accounts.google.com",
|
|
|
"x-google-jwks_uri": "https://www.googleapis.com/oauth2/v3/certs",
|
|
|
"x-google-audiences": "245464679631-ktfdfpl147m1mjpbutl00b3cmffissgq.apps.googleusercontent.com",
|
|
|
"scopes": {
|
|
|
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"definitions": {
|
|
|
"SourceQueryDefinition": {
|
|
|
"properties": {
|
|
|
"cursor": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"ids": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"limit": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
},
|
|
|
"query": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"returnedFields": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"spatialFilter": {
|
|
|
"$ref": "#/definitions/SpatialFilter"
|
|
|
}
|
|
|
},
|
|
|
"example":{
|
|
|
"kind": "tenant1:wke:well:1.0.0",
|
|
|
"query" : "FLUID",
|
|
|
"limit" :100,
|
|
|
"spatialFilter": {
|
|
|
"byDistance": {
|
|
|
"distance": 1000,
|
|
|
"point": {
|
|
|
"latitude": 30.749784,
|
|
|
"longitude": -94.473723
|
|
|
}
|
|
|
},
|
|
|
"field": "Surface Location"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"_any": {
|
|
|
|
|
|
},
|
|
|
"Attribute": {
|
|
|
"properties": {
|
|
|
"auditTrail": {
|
|
|
"$ref": "#/definitions/JsonMap"
|
|
|
},
|
|
|
"datatype": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"format": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"name": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"value": {
|
|
|
"$ref": "#/definitions/_any"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Legal": {
|
|
|
"properties": {
|
|
|
"legaltags": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"otherRelevantDataCountries": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"status": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"ResponseData": {
|
|
|
"properties": {
|
|
|
"cursor": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"data": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/JsonMap"
|
|
|
}
|
|
|
},
|
|
|
"errors": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"ids": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"responseCode": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
},
|
|
|
"schema": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/AttributeSchema"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"SpatialFilter": {
|
|
|
"properties": {
|
|
|
"byDistance": {
|
|
|
"$ref": "#/definitions/ByDistance"
|
|
|
},
|
|
|
"field": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"queryByDistance": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Point": {
|
|
|
"properties": {
|
|
|
"latitude": {
|
|
|
"type": "number",
|
|
|
"format": "double"
|
|
|
},
|
|
|
"longitude": {
|
|
|
"type": "number",
|
|
|
"format": "double"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Acl": {
|
|
|
"properties": {
|
|
|
"owners": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"viewers": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"LinkChildEntitiesPayload": {
|
|
|
"properties": {
|
|
|
"childrenIds": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"namespace": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"JsonMap": {
|
|
|
|
|
|
},
|
|
|
"WKE": {
|
|
|
"properties": {
|
|
|
"acl": {
|
|
|
"$ref": "#/definitions/Acl"
|
|
|
},
|
|
|
"ancestry": {
|
|
|
"$ref": "#/definitions/Ancestry"
|
|
|
},
|
|
|
"attributes": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/Attribute"
|
|
|
}
|
|
|
},
|
|
|
"creationDate": {
|
|
|
"type": "string",
|
|
|
"format": "date-time"
|
|
|
},
|
|
|
"entityType": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"id": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"legal": {
|
|
|
"$ref": "#/definitions/Legal"
|
|
|
},
|
|
|
"parentId": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"ruleName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"source": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"version": {
|
|
|
"type": "integer",
|
|
|
"format": "int32"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"AttributeSchema": {
|
|
|
"properties": {
|
|
|
"attributeName": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"conversionRequired": {
|
|
|
"type": "boolean"
|
|
|
},
|
|
|
"datatype": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"format": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"latitude": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"longitude": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"mandatory": {
|
|
|
"type": "boolean"
|
|
|
},
|
|
|
"measurementType": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"namespace": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"type": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"unit": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"unitSystem": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"Ancestry": {
|
|
|
"properties": {
|
|
|
"parents": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"LineageRequest": {
|
|
|
"properties": {
|
|
|
"entityId": {
|
|
|
"type": "string"
|
|
|
},
|
|
|
"kind": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
},
|
|
|
"example":{
|
|
|
"kind" : "tenant1:wke:well:1.0.0",
|
|
|
"entityId" : "3cea3ce1-1fe9-44da-8534-207d0f3a42b8"
|
|
|
}
|
|
|
},
|
|
|
"ByDistance": {
|
|
|
"properties": {
|
|
|
"distance": {
|
|
|
"type": "number",
|
|
|
"format": "double"
|
|
|
},
|
|
|
"point": {
|
|
|
"$ref": "#/definitions/Point"
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"SaveWkePayload": {
|
|
|
"properties": {
|
|
|
"data": {
|
|
|
"type": "array",
|
|
|
"items": {
|
|
|
"$ref": "#/definitions/WKE"
|
|
|
}
|
|
|
},
|
|
|
"namespace": {
|
|
|
"type": "string"
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
},
|
|
|
"tags": [
|
|
|
{
|
|
|
"name": "enrichment_fetch_service"
|
|
|
}
|
|
|
]
|
|
|
} |
|
|
\ No newline at end of file |