{ "openapi": "3.0.1", "info": { "title": "DrillPlan AEA v1", "version": "v1", "x-product-id": "DrillPlan-AEA-API", "description": "```plain {% title=\"Client ID\" %}\nfwk-drillplan.slbservice.com\n ```\n" }, "paths": { "/aea/v1/agents": { "get": { "tags": [ "Aea" ], "parameters": [ { "name": "slb-partition-id", "in": "header", "description": "Slb partition id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentMeta" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentMeta" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgentMeta" } } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/aea/v1/results/{job_id}": { "get": { "tags": [ "Aea" ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "slb-partition-id", "in": "header", "description": "Slb partition id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AeaJobResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AeaJobResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AeaJobResultResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } }, "/aea/v1/results/jobs": { "post": { "tags": [ "Aea" ], "parameters": [ { "name": "slb-partition-id", "in": "header", "description": "Slb partition id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AeaJobRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AeaJobRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AeaJobRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AeaJobRequest" } } } }, "responses": { "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AeaJobResponseBase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AeaJobResponseBase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AeaJobResponseBase" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/aea/v1/results/jobs/{job_id}": { "get": { "tags": [ "Aea" ], "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "slb-partition-id", "in": "header", "description": "Slb partition id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AeaJobResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AeaJobResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AeaJobResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "type": "string" } }, "application/json": { "schema": { "type": "string" } }, "text/json": { "schema": { "type": "string" } } } } } } } }, "components": { "schemas": { "AeaCalculationStatus": { "enum": [ "New", "MissingInputs", "FetchingFailure", "InProgress", "Success", "Failed", "Timeout", "NotFound" ], "type": "string" }, "AeaCardResult": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "traffic_light": { "$ref": "#/components/schemas/TrafficLightEnum" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/NormalizedMessage" }, "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationResult" }, "nullable": true }, "applicable": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "AeaJobRequest": { "type": "object", "properties": { "plan_id": { "type": "string", "nullable": true }, "scope_id": { "type": "string", "nullable": true }, "agents": { "type": "array", "items": { "$ref": "#/components/schemas/RequestAgentIdentity" }, "nullable": true } }, "additionalProperties": false }, "AeaJobResponse": { "type": "object", "properties": { "calculations": { "type": "array", "items": { "$ref": "#/components/schemas/Calculation" }, "nullable": true }, "job_id": { "type": "string", "nullable": true }, "plan_id": { "type": "string", "nullable": true }, "scope_id": { "type": "string", "nullable": true }, "plan_version": { "type": "integer", "format": "int32" }, "finished": { "type": "boolean" } }, "additionalProperties": false }, "AeaJobResponseBase": { "type": "object", "properties": { "job_id": { "type": "string", "nullable": true }, "plan_id": { "type": "string", "nullable": true }, "scope_id": { "type": "string", "nullable": true }, "plan_version": { "type": "integer", "format": "int32" }, "finished": { "type": "boolean" } }, "additionalProperties": false }, "AeaJobResultResponse": { "type": "object", "properties": { "calculations": { "type": "array", "items": { "$ref": "#/components/schemas/AgentResult" }, "nullable": true }, "job_id": { "type": "string", "nullable": true }, "plan_id": { "type": "string", "nullable": true }, "scope_id": { "type": "string", "nullable": true }, "plan_version": { "type": "integer", "format": "int32" }, "finished": { "type": "boolean" } }, "additionalProperties": false }, "AgentIdentity-V3": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "agent_id": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AgentMeta": { "type": "object", "properties": { "agent": { "$ref": "#/components/schemas/AgentIdentity-V3" }, "result_placeholders": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationResultIdentity-V3" }, "nullable": true } }, "additionalProperties": false }, "AgentResult": { "type": "object", "properties": { "agent_id": { "type": "string", "nullable": true }, "calculation_id": { "type": "string", "nullable": true }, "scope_id": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/AeaCalculationStatus" }, "progress": { "type": "number", "format": "double", "nullable": true }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/AeaCardResult" }, "nullable": true } }, "additionalProperties": false }, "Calculation": { "type": "object", "properties": { "calculation_id": { "type": "string", "nullable": true }, "status": { "$ref": "#/components/schemas/AeaCalculationStatus" }, "scope_id": { "type": "string", "nullable": true }, "agent": { "$ref": "#/components/schemas/AgentIdentity-V3" } }, "additionalProperties": false }, "CalculationResult": { "type": "object", "properties": { "template": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationResult" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "min_value": { "type": "number", "format": "double", "nullable": true }, "max_value": { "type": "number", "format": "double", "nullable": true }, "url": { "type": "string", "nullable": true }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/Segment-V3" }, "nullable": true }, "index": { "$ref": "#/components/schemas/IndexSeries" }, "series": { "type": "array", "items": { "$ref": "#/components/schemas/DataSeries" }, "nullable": true }, "value_list": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationResult" }, "nullable": true }, "table_values": { "type": "array", "items": {}, "nullable": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnMeta" }, "nullable": true }, "key": { "type": "string", "nullable": true }, "value": { "type": "number", "format": "double", "nullable": true }, "uom": { "type": "string", "nullable": true }, "display_decimal_place": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ColumnMeta": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "uom": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DataSeries": { "type": "object", "properties": { "uom": { "type": "string", "nullable": true }, "legends": { "$ref": "#/components/schemas/ParameterizedString" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationResult" }, "nullable": true }, "key": { "type": "string", "nullable": true }, "series_group": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "measurement": { "type": "string", "nullable": true }, "display_decimal_place": { "type": "integer", "format": "int32", "nullable": true }, "values": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true } }, "additionalProperties": false }, "HealthCheckResponse": { "type": "object", "properties": { "service_name": { "type": "string", "nullable": true }, "service_version": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IndexSeries": { "type": "object", "properties": { "uom": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "measurement": { "type": "string", "nullable": true }, "display_decimal_place": { "type": "integer", "format": "int32", "nullable": true }, "values": { "type": "array", "items": { "type": "number", "format": "double" }, "nullable": true } }, "additionalProperties": false }, "MessageSeverity-V3": { "enum": [ "Info", "Warning", "Error", "Unknown" ], "type": "string" }, "NormalizedMessage": { "type": "object", "properties": { "severity": { "$ref": "#/components/schemas/MessageSeverity-V3" }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ParameterizedString": { "type": "object", "properties": { "template": { "type": "string", "nullable": true }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationResult" }, "nullable": true } }, "additionalProperties": false }, "RequestAgentIdentity": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "agent_id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Segment-V3": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "start": { "type": "number", "format": "double" }, "end": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TrafficLightEnum": { "enum": [ "Info", "Warning", "Error", "Unknown" ], "type": "string" }, "ValidationResultIdentity-V3": { "type": "object", "properties": { "category": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true }, "publish_value_results": { "type": "array", "items": { "$ref": "#/components/schemas/ValueResultIdentity-V3" }, "nullable": true } }, "additionalProperties": false }, "ValueResultIdentity-V3": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "result_type": { "$ref": "#/components/schemas/ValueResultType-V3" } }, "additionalProperties": false }, "ValueResultType-V3": { "enum": [ "Single", "Range", "ParameterizedString", "DataSeries", "Segments", "ValueGroup", "Link", "Table" ], "type": "string" } }, "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "User Token from SLB Authenticator Service" }, "appkey": { "type": "apiKey", "description": "AppKey/ConsumerKey from your App on Developer Portal", "name": "appkey", "in": "header" }, "sauth_service_token": { "type": "oauth2", "description": "Service from SAuth v2", "flows": { "clientCredentials": { "tokenUrl": "https://p4d.csi.cloud.slb-ds.com/v2/token", "scopes": { "fwk-drillplan.slbservice.com": "" } } } } } }, "security": [ { "bearer": [], "appkey": [] }, { "sauth_service_token": [], "appkey": [] } ], "servers": [ { "url": "https://eu-api.delfi.slb.com/drillplan/aea/v1", "description": "ProdEU" }, { "url": "https://api.delfi.slb.com/drillplan/aea/v1", "description": "ProdUS" } ] }