{ "swagger": "2.0", "info": { "title": "WellboreApplicationFacade API", "description": "API for Wellbore data", "version": "1.0" }, "tags": [ { "name": "FacadeServiceV1" } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/api/v1/jobs": { "get": { "summary": "Fetches all jobs", "operationId": "FacadeServiceV1_GetJobs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetJobsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "jobStatus", "description": "Filter by status of the job\n\n - ActiveJobs: Default value if not provided, Jobs that are still active (unreleased and last drilled on their rig)\n - AllJobs: All jobs\n - EndedJobs: Jobs that have finished or ended\n - UnendedJobs: Jobs that have not ended. Includes active jobs and unverified ended jobs.", "in": "query", "required": false, "type": "string", "enum": [ "ActiveJobs", "AllJobs", "EndedJobs", "UnendedJobs" ], "default": "ActiveJobs" }, { "name": "startDateMin", "description": "Filter by jobs that have a start date on or after this value. The format is based on the local time.\r\n\r\nExample: 2021-07-06 5:13:48 PM", "in": "query", "required": false, "type": "string" }, { "name": "startDateMax", "description": "Filter by jobs that have a start date on or before this value. The format is based on the local time.\r\n\r\nExample: 2021-07-06 5:13:48 PM", "in": "query", "required": false, "type": "string" }, { "name": "endDateMin", "description": "Filter by jobs that have a end date on or after this value. The format is based on the local time.\r\n\r\nExample: 2021-07-06 5:13:48 PM", "in": "query", "required": false, "type": "string" }, { "name": "endDateMax", "description": "Filter by jobs that have a end date on or before this value. The format is based on the local time.\r\n\r\nExample: 2021-07-06 5:13:48 PM", "in": "query", "required": false, "type": "string" }, { "name": "includeCapabilities", "description": "Include capabilities", "in": "query", "required": false, "type": "boolean", "default": "false" }, { "name": "sort", "description": "Order by clause applied on the results.\r\n\r\n Example: id asc; startDate desc; name descending; type ascending", "in": "query", "required": false, "type": "string", "default": "id asc" }, { "name": "take", "description": "Number of results to return", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "50" }, { "name": "skip", "description": "Number of results to skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "0" }, { "name": "total", "description": "If true include the total number of records", "in": "query", "required": false, "type": "boolean", "default": "false" }, { "name": "attributeUnits", "description": "Select units of job properties by attribute Id.\r\n\r\nExample: {\"HoleDepth\":\"Depth.Meter.0\"}", "in": "query", "required": false, "type": "string" } ], "tags": [ "Jobs" ] } }, "/api/v1/jobs/capabilities": { "get": { "summary": "Fetches the capabilities of the jobs endpoint", "operationId": "FacadeServiceV1_GetJobsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetJobsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Jobs" ] } }, "/api/v1/jobs/{jobId}": { "get": { "summary": "Fetches a job by its id", "operationId": "FacadeServiceV1_GetJobById", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/JobV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "attributeUnits", "description": "Select units of job properties by attribute Id.\r\n\r\nExample: {\"HoleDepth\":\"Depth.Meter.0\"}", "in": "query", "required": false, "type": "string" } ], "tags": [ "Jobs" ] } }, "/api/v1/jobs/{jobId}/alarm-configurations": { "get": { "summary": "Fetches alarm change log for a single job", "description": "Accept-Type:\r\n* application/json: Single response of alarm event models\r\n*", "operationId": "FacadeServiceV1_GetAlarmConfigurations", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetAlarmConfigurationsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "broadcastTimeFrom", "description": "Filter by alarm configurations that have a updated time on or after this value. The format is based on the local time.\r\n\r\nExample: 2021-06-14T16:19:00.990Z", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "broadcastTimeTo", "description": "Filter by alarm configurations that have a updated time on or before this value. The format is based on the local time.\r\n\r\nExample: 2021-06-14T17:19:00.990Z", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "take", "description": "Number of results to return", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "50" }, { "name": "skip", "description": "Number of results to skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "0" }, { "name": "total", "description": "If true include the total number of records", "in": "query", "required": false, "type": "boolean", "default": "false" } ], "tags": [ "AlarmConfigurations" ] } }, "/api/v1/jobs/{jobId}/alarm-configurations/capabilities": { "get": { "summary": "Fetches the capabilities for the alarm configurations specified by the Job ID.", "operationId": "FacadeServiceV1_GetAlarmConfigurationsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetAlarmConfigurationsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "AlarmConfigurations" ] } }, "/api/v1/jobs/{jobId}/alarm-events": { "get": { "summary": "Fetches alarm events for a single job", "description": "Accept-Type:\r\n* application/json: Single response of alarm event models\r\n*", "operationId": "FacadeServiceV1_GetAlarmEvents", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetAlarmEventsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "broadcastTimeFrom", "description": "Filter by alarms that have a broadcast time on or after this value. The format is based on the local time.\r\n\r\nExample: 2021-06-14T16:19:00.990Z", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "broadcastTimeTo", "description": "Filter by alarms that have a broadcast time on or before this value. The format is based on the local time.\r\n\r\nExample: 2021-06-14T17:19:00.990Z", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "take", "description": "Number of results to return", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "50" }, { "name": "skip", "description": "Number of results to skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "0" }, { "name": "total", "description": "If true include the total number of records", "in": "query", "required": false, "type": "boolean", "default": "false" } ], "tags": [ "AlarmEvents" ] } }, "/api/v1/jobs/{jobId}/alarm-events/capabilities": { "get": { "summary": "Fetches the alarms events capabilities for a single job", "operationId": "FacadeServiceV1_GetAlarmsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetAlarmEventsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "AlarmEvents" ] } }, "/api/v1/jobs/{jobId}/assets/mud-pumps": { "get": { "summary": "GetMudPumps gets all the mud pumps and properties for the specified Job ID", "operationId": "FacadeServiceV1_GetMudPumps", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetMudPumpsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" } ], "tags": [ "MudPumps" ] }, "delete": { "operationId": "FacadeServiceV1_DeleteMudPumps", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The meta was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": true, "type": "string" }, { "name": "mudPumpId", "in": "query", "required": true, "type": "string" } ], "tags": [ "MudPumps" ] }, "put": { "operationId": "FacadeServiceV1_CreateOrUpdateMudPumps", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "mudPumps": { "type": "array", "items": { "$ref": "#/definitions/MudPumpV1" } } }, "title": "Mud Pumps request" } } ], "tags": [ "MudPumps" ] } }, "/api/v1/jobs/{jobId}/assets/mud-pumps/capabilities": { "get": { "summary": "GetMudPumpsCapabilities fetches the capabilities for the mud pumps and properties specified by the Job ID.", "operationId": "FacadeServiceV1_GetMudPumpsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetMudPumpsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all mud pumps", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "MudPumps" ] } }, "/api/v1/jobs/{jobId}/assets/rigs": { "get": { "summary": "GetRigs gets all the Rigs for a specified jobId", "operationId": "FacadeServiceV1_GetRigs", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRigsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" } ], "tags": [ "Rigs" ] }, "delete": { "summary": "DeleteRigs deletes the Rigs for a specified jobId", "operationId": "FacadeServiceV1_DeleteRigs", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The meta was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": true, "type": "string" }, { "name": "rigId", "in": "query", "required": true, "type": "string" } ], "tags": [ "Rigs" ] }, "put": { "summary": "CreateRigs creates Rigs for a specified jobId", "operationId": "FacadeServiceV1_CreateOrUpdateRigs", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "rigs": { "type": "array", "items": { "$ref": "#/definitions/RigV1" } } }, "title": "Rigs request" } } ], "tags": [ "Rigs" ] } }, "/api/v1/jobs/{jobId}/assets/rigs/capabilities": { "get": { "summary": "GetRigsCapabilities fetches the capabilities for Rigs for a specified jobID", "operationId": "FacadeServiceV1_GetRigsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRigsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all rig", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Rigs" ] } }, "/api/v1/jobs/{jobId}/attributes": { "get": { "summary": "Fetches the attributes for a single job", "operationId": "FacadeServiceV1_GetAttributes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetAttributesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated": { "get": { "summary": "Fetches the calculated attributes for a job", "operationId": "FacadeServiceV1_GetCalculatedAttributes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCalculatedAttributesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attributes" ] }, "put": { "summary": "Creates a new calculated attribute", "operationId": "FacadeServiceV1_CreateCalculatedAttribute", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CreateCalcualtedAttributeV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "configuration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CalculatedAttributeV1Configuration" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/capabilities": { "get": { "summary": "Fetches the calculated attributes capabilities for a job", "operationId": "FacadeServiceV1_GetCalculatedAttributesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCalculatedAttributesCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "includeChildCapabilities", "in": "query", "required": false, "type": "boolean" } ], "tags": [ "Calculated Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/constants": { "get": { "summary": "Fetches the calculated attribute constants for a job", "operationId": "FacadeServiceV1_GetCalculatedAttributeConstants", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCalculatedAttributeConstantsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attribute Constants" ] }, "put": { "summary": "Creates a new calculated attribute constant", "operationId": "FacadeServiceV1_CreateCalculatedAttributeConstant", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The calculated attribute constant was created successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "constant", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CalculatedAttributeConstantV1" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attribute Constants" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/constants/capabilities": { "get": { "summary": "Fetches the calculated attribute constants capabilities for a job", "operationId": "FacadeServiceV1_GetCalculatedAttributeConstantsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCalculatedAttributeConstantsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attribute Constants" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/constants/{name}": { "delete": { "summary": "Deletes a calculated attribute constant", "operationId": "FacadeServiceV1_DeleteCalculatedAttributeConstant", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The calculated attribute constant was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "storageLocation", "in": "query", "required": false, "type": "string", "enum": [ "Datacenter", "Edge" ], "default": "Datacenter" } ], "tags": [ "Calculated Attribute Constants" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/constants/{name}/capabilities": { "get": { "summary": "Fetches the calculated attribute constants capabilities for a job", "operationId": "FacadeServiceV1_GetCalculatedAttributeConstantByNameCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCalculatedAttributeConstantByNameCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "name", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attribute Constants" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/constants/{oldName}": { "put": { "summary": "Updates a calculated attribute constant", "operationId": "FacadeServiceV1_UpdateCalculatedAttributeConstant", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The calculated attribute constant was updated successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "oldName", "in": "path", "required": true, "type": "string" }, { "name": "constant", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CalculatedAttributeConstantV1" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attribute Constants" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/{id}": { "delete": { "summary": "Deletes a calculated attribute", "operationId": "FacadeServiceV1_DeleteCalculatedAttribute", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The calculated attribute was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "storageLocation", "in": "query", "required": false, "type": "string", "enum": [ "Datacenter", "Edge" ], "default": "Datacenter" } ], "tags": [ "Calculated Attributes" ] }, "put": { "summary": "Updates a calculated attribute", "operationId": "FacadeServiceV1_UpdateCalculatedAttribute", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The calculated attribute was updated successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "configuration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CalculatedAttributeV1Configuration" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "currentPassword", "description": "Required if the attribute is password protected.", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/calculated/{id}/capabilities": { "get": { "summary": "Fetches the calculated attributes capabilities for a job", "operationId": "FacadeServiceV1_GetCalculatedAttributeByIdCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCalculatedAttributeByIdCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Calculated Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/capabilities": { "get": { "summary": "Fetches the attributes capabilities for a single job", "operationId": "FacadeServiceV1_GetAttributesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetAttributesCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/roadmap": { "get": { "summary": "Fetches the roadmap attributes for a job", "operationId": "FacadeServiceV1_GetRoadmapAttributes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRoadmapAttributesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Roadmap Attributes" ] }, "put": { "summary": "Create a new Roadmap attribute", "operationId": "FacadeServiceV1_CreateRoadmapAttribute", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CreateRoadmapAttributeV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "configuration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RoadmapAttributeV1Configuration" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Roadmap Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/roadmap/capabilities": { "get": { "summary": "Fetches the roadmap attributes capabilities for a job", "operationId": "FacadeServiceV1_GetRoadmapAttributesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRoadmapAttributesCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "includeChildCapabilities", "in": "query", "required": false, "type": "boolean" } ], "tags": [ "Roadmap Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/roadmap/{id}": { "delete": { "summary": "Deletes a roadmap attribute", "operationId": "FacadeServiceV1_DeleteRoadmapAttribute", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The roadmap attribute was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "storageLocation", "in": "query", "required": false, "type": "string", "enum": [ "Datacenter", "Edge" ], "default": "Datacenter" } ], "tags": [ "Roadmap Attributes" ] }, "put": { "summary": "Updates a roadmap attribute", "operationId": "FacadeServiceV1_UpdateRoadmapAttribute", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The roadmap attribute was updated successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "configuration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/RoadmapAttributeV1Configuration" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Roadmap Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/roadmap/{id}/capabilities": { "get": { "summary": "Fetches the roadmap attributes capabilities for a job", "operationId": "FacadeServiceV1_GetRoadmapAttributeByIdCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRoadmapAttributeByIdCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Roadmap Attributes" ] } }, "/api/v1/jobs/{jobId}/attributes/roadmap/{id}/intervals": { "get": { "summary": "Fetches the intervals for a roadmap attribute", "operationId": "FacadeServiceV1_GetRoadmapAttributeIntervals", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRoadmapAttributeIntervalsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "storageLocation", "in": "query", "required": false, "type": "string", "enum": [ "Datacenter", "Edge" ], "default": "Datacenter" } ], "tags": [ "Roadmap Attributes" ] } }, "/api/v1/jobs/{jobId}/capabilities": { "get": { "summary": "Fetches the capabilities of a job", "operationId": "FacadeServiceV1_GetJobCapabilitiesById", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/JobCapabilities" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Jobs" ] } }, "/api/v1/jobs/{jobId}/configurations": { "get": { "summary": "Fetches all job configurations", "operationId": "FacadeServiceV1_GetConfigurations", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetConfigurationsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Configurations" ] } }, "/api/v1/jobs/{jobId}/configurations/capabilities": { "get": { "summary": "Fetches job configurations capabilities", "operationId": "FacadeServiceV1_GetConfigurationsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetConfigurationsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Configurations" ] } }, "/api/v1/jobs/{jobId}/configurations/{type}": { "get": { "summary": "Fetches job configuration by type", "operationId": "FacadeServiceV1_GetConfigurationByType", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetConfigurationByTypeV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "BaseOverlayConfig" ] }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Configurations" ] }, "put": { "summary": "Creates or Updates job configuration", "operationId": "FacadeServiceV1_CreateOrUpdateConfiguration", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "BaseOverlayConfig" ] }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateOrUpdateConfigurationRequestParameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Configurations" ] } }, "/api/v1/jobs/{jobId}/configurations/{type}/capabilities": { "get": { "summary": "Fetches job configuration capabilities by type", "operationId": "FacadeServiceV1_GetConfigurationCapabilitiesByType", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetConfigurationCapabilitiesByTypeV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "type", "in": "path", "required": true, "type": "string", "enum": [ "BaseOverlayConfig" ] }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Configurations" ] } }, "/api/v1/jobs/{jobId}/data/connections": { "post": { "summary": "Return the List of connections from the specified well", "operationId": "FacadeServiceV1_GetConnections", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetConnectionsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetConnectionsV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Kpis" ] } }, "/api/v1/jobs/{jobId}/data/connections/capabilities": { "get": { "summary": "Fetch the capabilities of the connections endpoint", "operationId": "FacadeServiceV1_GetConnectionsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ConnectionsCapabilitiesResponseV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Kpis" ] } }, "/api/v1/jobs/{jobId}/data/depth": { "post": { "summary": "Fetches historical depth data with request in BODY", "description": "Accept-Type:\r\n* application/json: Single response of historical data.\r\n* Note: Streamed response not supported.", "operationId": "FacadeServiceV1_GetDepthData", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetDepthDataV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetDepthDataV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "DepthBased" ] } }, "/api/v1/jobs/{jobId}/data/depth/capabilities": { "get": { "summary": "Fetches the capabilities for the GetDepthData endpoint", "operationId": "FacadeServiceV1_GetDepthDataCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetDepthDataCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "DepthBased" ] } }, "/api/v1/jobs/{jobId}/data/depth/formats": { "get": { "summary": "Return different format types available for depth export", "operationId": "FacadeServiceV1_GetDepthExportFormats", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetDepthExportFormatsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "DepthBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/depth/formats/capabilities": { "get": { "summary": "Return the capabilities of GetDepthExportFormatsCapabilities endpoint", "operationId": "FacadeServiceV1_GetDepthExportFormatsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetDepthExportFormatsCabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "DepthBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/depth/formats/delimited": { "post": { "summary": "Return depth data in a delimited file with request in BODY", "operationId": "FacadeServiceV1_GetDepthExportDelimited", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetDepthExportDelimitedV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "DepthBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/depth/formats/{format}": { "post": { "summary": "Return depth data in a file in the selected format with request in BODY", "operationId": "FacadeServiceV1_GetDepthExportFormat", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "format", "description": "Available Values: witsml, lasv2, lasv3", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetDepthExportFormatV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "DepthBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/depth/formats/{format}/capabilities": { "get": { "summary": "Return the capabilities of GetDepthExportFormatCapabilities endpoint", "operationId": "FacadeServiceV1_GetDepthExportFormatCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetDepthExportFormatCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "format", "description": "Available Values: witsml, lasv2, lasv3", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "DepthBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/formations": { "get": { "operationId": "FacadeServiceV1_GetFormations", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetFormationsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": {} }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" }, { "name": "depthUnitId", "in": "query", "required": true, "type": "string" }, { "name": "angleUnitId", "in": "query", "required": true, "type": "string" } ], "tags": [ "Formations" ] }, "delete": { "summary": "Deletes the formations for the specified formationId, and for all of the ids in the formationIds list", "operationId": "FacadeServiceV1_DeleteFormation", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": {} }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" }, { "name": "formationId", "in": "query", "required": false, "type": "string" }, { "name": "formationIds", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" } ], "tags": [ "Formations" ] }, "put": { "operationId": "FacadeServiceV1_CreateOrUpdateFormations", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": {} }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "depthUnitId": { "type": "string" }, "angleUnitId": { "type": "string" }, "formations": { "type": "array", "items": { "$ref": "#/definitions/FormationV1" } } }, "title": "CreateOrUpdateFormationsV1Request", "required": [ "depthUnitId", "angleUnitId", "formations" ] } } ], "tags": [ "Formations" ] } }, "/api/v1/jobs/{jobId}/data/formations/capabilities": { "get": { "operationId": "FacadeServiceV1_GetFormationsCapibilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetFormationsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Formations" ] } }, "/api/v1/jobs/{jobId}/data/import/third-party": { "post": { "summary": "Stores third party context data", "operationId": "FacadeServiceV1_PostDataThirdParty", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "format", "in": "query", "required": false, "type": "string", "enum": [ "Unknown", "WellView", "RigSense" ], "default": "Unknown" } ], "tags": [ "ImportData" ] } }, "/api/v1/jobs/{jobId}/data/mud-check": { "get": { "summary": "GetMudChecks gets the mud check for the specified Job ID", "operationId": "FacadeServiceV1_GetMudChecks", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetMudCheckV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" }, { "name": "mudCheckTimeRange.from", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "mudCheckTimeRange.to", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "take", "description": "Number of results to return", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "50" }, { "name": "skip", "description": "Number of results to skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "0" }, { "name": "total", "description": "If true include the total number of records", "in": "query", "required": false, "type": "boolean", "default": "false" }, { "name": "sort", "description": "Order by clause applied on the results.\r\n\r\n Example: id asc; mudCheckTime desc; type descending; type ascending", "in": "query", "required": false, "type": "string", "default": "mudCheckTime desc" } ], "tags": [ "MudCheck" ] }, "delete": { "summary": "DeleteMudChecks deletes the mud check for the specified Job ID", "operationId": "FacadeServiceV1_DeleteMudChecks", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The meta was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": true, "type": "string" }, { "name": "mudCheckId", "in": "query", "required": true, "type": "string" } ], "tags": [ "MudCheck" ] }, "put": { "operationId": "FacadeServiceV1_CreateOrUpdateMudChecks", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "mudChecks": { "type": "array", "items": { "$ref": "#/definitions/MudCheckV1" } } }, "title": "MudCheck request" } } ], "tags": [ "MudCheck" ] } }, "/api/v1/jobs/{jobId}/data/mud-check/capabilities": { "get": { "summary": "GetMudCheckCapabilities fetches the capabilities for the mud check specified by the Job ID.", "operationId": "FacadeServiceV1_GetMudCheckCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetMudCheckCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all mud check", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "MudCheck" ] } }, "/api/v1/jobs/{jobId}/data/notes": { "get": { "summary": "GetNotes gets all the notes for a job", "operationId": "FacadeServiceV1_GetNotes", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetNotesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "take", "description": "Number of results to return", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "50" }, { "name": "skip", "description": "Number of results to skip", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "0" }, { "name": "total", "description": "If true include the total number of notes", "in": "query", "required": false, "type": "boolean", "default": "false" } ], "tags": [ "Notes" ] }, "delete": { "summary": "DeleteNote deletes the notes for the specified Job ID", "operationId": "FacadeServiceV1_DeleteNote", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The note was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "noteId", "in": "query", "required": true, "type": "string" } ], "tags": [ "Notes" ] }, "post": { "summary": "CreateNote creates a note", "operationId": "FacadeServiceV1_CreateNote", "responses": { "200": { "description": "Reserved for future use", "schema": { "$ref": "#/definitions/CreateNoteV1Response" } }, "204": { "description": "The note was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "note", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateNoteV1" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Notes" ] }, "put": { "summary": "UpdateNote creates or updates a note", "operationId": "FacadeServiceV1_UpdateNote", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The note was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "note": { "$ref": "#/definitions/UpdateNoteV1" } }, "title": "Notes request", "required": [ "note" ] } } ], "tags": [ "Notes" ] } }, "/api/v1/jobs/{jobId}/data/notes/capabilities": { "get": { "summary": "Fetches the capabilities for the historical notes specified by the Job ID.", "operationId": "FacadeServiceV1_GetNotesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetNotesCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Notes" ] } }, "/api/v1/jobs/{jobId}/data/notes/changes": { "get": { "summary": "GetNotesChanges gets a stream real-time notes change(s) specified by the Job ID", "description": "Accept-Type:\r\n* text/event-stream: Streamed response of notes change(s)", "operationId": "FacadeServiceV1_GetNotesChanges", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/NoteChangeV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "406": { "description": "Only streams are supported. text/event-stream must be included in the Accept header.", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Notes" ] } }, "/api/v1/jobs/{jobId}/data/notes/changes/capabilities": { "get": { "summary": "Fetches the capabilities for the notes changes specified by the Job ID.", "operationId": "FacadeServiceV1_GetNotesChangesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetNotesChangesCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Notes" ] } }, "/api/v1/jobs/{jobId}/data/runs": { "get": { "summary": "Return all runs for a given job", "operationId": "FacadeServiceV1_GetRunsByJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRunsByJobV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "depthUnitId", "description": "Request depth units by unit id; valid only when source is Kpi.\r\n\r\nExample: \"Depth.Meter.0\"", "in": "query", "required": false, "type": "string" }, { "name": "source", "description": "The desired source for the runs data; if not provided or not Kpi, context data source will be used.", "in": "query", "required": false, "type": "string" }, { "name": "timeRange.from", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "timeRange.to", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "type", "in": "query", "required": false, "type": "string", "enum": [ "Unknown", "Casing", "Bha" ], "default": "Unknown" } ], "tags": [ "Runs" ] } }, "/api/v1/jobs/{jobId}/data/runs/bhas": { "get": { "summary": "GetBhas gets all the Bha assembly for the specified Job ID", "operationId": "FacadeServiceV1_GetBhas", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetBhasV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" } ], "tags": [ "Bhas" ] }, "delete": { "summary": "DeleteBhas deletes Bha assembly for the specified Job ID", "operationId": "FacadeServiceV1_DeleteBhas", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": true, "type": "string" }, { "name": "bhaId", "in": "query", "required": true, "type": "string" } ], "tags": [ "Bhas" ] }, "put": { "summary": "CreateBhas creates the Bha assembly for the specified Job ID", "operationId": "FacadeServiceV1_CreateOrUpdateBhas", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "bhas": { "type": "array", "items": { "$ref": "#/definitions/BhaV1" } } }, "title": "Bhas request" } } ], "tags": [ "Bhas" ] } }, "/api/v1/jobs/{jobId}/data/runs/bhas/capabilities": { "get": { "summary": "GetBhasCapabilities fetches the capabilities for the Bha specified by the Job ID.", "operationId": "FacadeServiceV1_GetBhasCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetBhasCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all bha items", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Bhas" ] } }, "/api/v1/jobs/{jobId}/data/runs/capabilities": { "get": { "summary": "Fetches the capabilities for the runs by the Job ID.", "operationId": "FacadeServiceV1_GetRunsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetRunsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all runs", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Runs" ] } }, "/api/v1/jobs/{jobId}/data/runs/casings": { "get": { "summary": "GetCasings gets all the Casing Strings for the specified Job ID", "operationId": "FacadeServiceV1_GetCasings", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCasingsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" } ], "tags": [ "Casings" ] }, "delete": { "summary": "DeletCasings deletes the Casing Strings for the specified Job ID", "operationId": "FacadeServiceV1_DeleteCasings", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The casings were deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": true, "type": "string" }, { "name": "casingId", "in": "query", "required": true, "type": "string" } ], "tags": [ "Casings" ] }, "put": { "summary": "CreateCasings the Casing Strings for the specified Job ID", "operationId": "FacadeServiceV1_CreateOrUpdateCasings", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "casings": { "type": "array", "items": { "$ref": "#/definitions/CasingV1" } } }, "title": "Casings request" } } ], "tags": [ "Casings" ] } }, "/api/v1/jobs/{jobId}/data/runs/casings/capabilities": { "get": { "summary": "GetCasingsCapabilities fetches the capabilities for the Casing Strings specified by the Job ID.", "operationId": "FacadeServiceV1_GetCasingsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCasingsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Casings" ] } }, "/api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}": { "get": { "summary": "GetEquivalentMudWeights retrieves swab/surge emw points.", "operationId": "FacadeServiceV1_GetEquivalentMudWeight", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetEquivalentMudWeightV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "runId", "in": "path", "required": true, "type": "string" }, { "name": "swabSurgeType", "in": "path", "required": true, "type": "string", "enum": [ "Swab", "Surge" ] }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SwabSurge" ] }, "put": { "summary": "CreateSwabSurgeData saves swab/surge data.", "operationId": "FacadeServiceV1_CreateSwabSurgeData", "responses": { "200": { "description": "A successful response.", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "runId", "in": "path", "required": true, "type": "string" }, { "name": "swabSurgeType", "in": "path", "required": true, "type": "string", "enum": [ "Swab", "Surge" ] }, { "name": "swabSurgeData", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateSwabSurgeDataBody" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SwabSurge" ] } }, "/api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}/capabilities": { "get": { "summary": "GetEquivalentMudWeightCapabilities retrieves capabilities for swab/surge emw.", "operationId": "FacadeServiceV1_GetEquivalentMudWeightCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetEquivalentMudWeightCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "runId", "in": "path", "required": true, "type": "string" }, { "name": "swabSurgeType", "in": "path", "required": true, "type": "string", "enum": [ "Swab", "Surge" ] }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SwabSurge" ] } }, "/api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}/trip-speed": { "post": { "summary": "GetTripSpeedModel retrieves generated swab/surge tripping model for equivalent mud weights", "operationId": "FacadeServiceV1_GetTripSpeedModel", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTripSpeedModelV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "runId", "in": "path", "required": true, "type": "string" }, { "name": "swabSurgeType", "in": "path", "required": true, "type": "string", "enum": [ "Swab", "Surge" ] }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTripSpeedModelV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SwabSurge" ] } }, "/api/v1/jobs/{jobId}/data/runs/{runId}/models/swab-surge/{swabSurgeType}/trip-speed/capabilities": { "get": { "summary": "GetTripSpeedModelCapabilities retrieves capabilities for swab/surge tripping speed model.", "operationId": "FacadeServiceV1_GetTripSpeedModelCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTripSpeedModelCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "runId", "in": "path", "required": true, "type": "string" }, { "name": "swabSurgeType", "in": "path", "required": true, "type": "string", "enum": [ "Swab", "Surge" ] }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SwabSurge" ] } }, "/api/v1/jobs/{jobId}/data/sections": { "get": { "summary": "Return all sections for a given job", "operationId": "FacadeServiceV1_GetSectionsByJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSectionsByJobV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "attributeUnits", "description": "Select units of attributes by attribute Id.\r\n\r\nExample: {\"HoleDepth\":\"Depth.Meter.0\"}", "in": "query", "required": false, "type": "string" } ], "tags": [ "Sections" ] } }, "/api/v1/jobs/{jobId}/data/sections/capabilities": { "get": { "summary": "Fetches the capabilities for the sections by the Job ID.", "operationId": "FacadeServiceV1_GetSectionsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSectionsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Sections" ] } }, "/api/v1/jobs/{jobId}/data/surveys": { "get": { "summary": "GetSurveys gets all the surveys filtered by the optional parameters approved, unapproved, fromDepth, endDepth", "operationId": "FacadeServiceV1_GetSurveys", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SurveyByJobV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for the survey", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "fromDepth", "description": "Minimum depth (MD) for returned surveys", "in": "query", "required": false, "type": "number", "format": "float" }, { "name": "toDepth", "description": "Maximum depth (MD) for returned surveys", "in": "query", "required": false, "type": "number", "format": "float" }, { "name": "status", "description": "Default: Approved; disregard Swagger default as it chooses 0th value.", "in": "query", "required": false, "type": "string", "enum": [ "Unapproved", "Approved", "All" ], "default": "Unapproved" }, { "name": "depthUnitId", "description": "Unit type for SurveyDepth, TrueVerticalDepth in response. Also used as the distance component in DoglegSeverity (angle is constantly set to degrees)", "in": "query", "required": false, "type": "string" }, { "name": "planeAngleUnitId", "description": "Unit type for Inclination and Azimuth in response\n\nstring segment_id = 8 [(grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = {\n description: \"If a segment ID is provided, the API will return surveys only from the specified segment and its parent segment(s). This is\"\n \" done by limiting the time range processed for survey retrieval to the start and end datetimes of the specified segment\"\n \" and its parent segment(s). Use the /api/v1/jobs/{jobID}/segments endpoint to get the segment IDs for the job.\"\n}];", "in": "query", "required": false, "type": "string" } ], "tags": [ "Surveys" ] }, "put": { "summary": "CreateSurveys creates Surveys for the specified Job ID", "operationId": "FacadeServiceV1_CreateSurveys", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - Required Survey fields (any of SurveyDepth, Inclination, Azimuth, Units) missing", "schema": {} }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateSurveysV1RequestParameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Surveys" ] } }, "/api/v1/jobs/{jobId}/data/surveys/capabilities": { "get": { "summary": "Fetches the capabilities for the historical surveys specified by the Job ID.", "operationId": "FacadeServiceV1_GetSurveysCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSurveysCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all surveys", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Surveys" ] } }, "/api/v1/jobs/{jobId}/data/surveys/current": { "get": { "summary": "GetCurrentSurvey gets the real-time survey specified by the Job ID, filtered by the optional parameters All, Approved, Unapproved..", "description": "Accept-Type:\r\n* text/event-stream: Streamed response of survey changes", "operationId": "FacadeServiceV1_GetCurrentSurvey", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SurveyV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for the survey", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "status", "description": "Default: Approved; disregard Swagger default as it chooses 0th value.", "in": "query", "required": false, "type": "string", "enum": [ "Unapproved", "Approved", "All" ], "default": "Unapproved" }, { "name": "depthUnitId", "description": "Unit type for SurveyDepth, TrueVerticalDepth in response. Also used as the distance component in DoglegSeverity (angle is constantly set to degrees)", "in": "query", "required": false, "type": "string" }, { "name": "planeAngleUnit", "description": "Unit type for Inclination and Azimuth in response", "in": "query", "required": false, "type": "string" } ], "tags": [ "Surveys" ] } }, "/api/v1/jobs/{jobId}/data/surveys/current/capabilities": { "get": { "summary": "Fetches the capabilities for the real-time survey specified by the Job ID.", "operationId": "FacadeServiceV1_GetCurrentSurveyCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCurrentSurveyCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for real-time survey", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Surveys" ] } }, "/api/v1/jobs/{jobId}/data/time": { "post": { "summary": "Return historical data with request in BODY", "description": "Accept-Type:\r\n* application/json: Single response of historical data\r\n* Note: Streamed response not supported.", "operationId": "FacadeServiceV1_GetHistoricalTimeData", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeDataV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTimeDataV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBased" ] } }, "/api/v1/jobs/{jobId}/data/time-offsets": { "get": { "summary": "Returns a list of DateTimeOffsets for the specified job", "operationId": "FacadeServiceV1_GetTimeOffsets", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeOffsetsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeOffsets" ] } }, "/api/v1/jobs/{jobId}/data/time-offsets/capabilities": { "get": { "summary": "Fetches the capabilities for the GetTimeOffsets endpoint", "operationId": "FacadeServiceV1_GetTimeOffsetsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeOffsetsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeOffsets" ] } }, "/api/v1/jobs/{jobId}/data/time/capabilities": { "get": { "summary": "Fetches the capabilities for the GetHistoricalTimeData endpoint", "operationId": "FacadeServiceV1_GetHistoricalTimeDataCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetHistoricalTimeDataCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBased" ] } }, "/api/v1/jobs/{jobId}/data/time/current": { "get": { "summary": "Return last known values with request in URI", "description": "Accept-Type:\r\n* text/event-stream: Streamed response of current value(s)\r\n * Note: non-differential current value(s) not currently supported\r\n* Note: Currently, this endpoint is implemented to work exclusively with streaming requests\r\n\r\nAttributes: [Can be either header or query parameter]\r\n example: \"HookLoad\",\"BitPosition\",\"HoleDepth\"\r\nUri:\r\n* format = \"[Attribute Name]:[Mode]:[Unit]\" *Note: mode and/or Unit can be omitted*\r\n* example: HookLoad:last, BitPosition,HoleDepth::Depth.Meter.Id\r\nWhen the number of Attributes is large, consider using the POST operation.\r\nNote: Currently differential = true , frequency = 1 and interval = 0 is only supported for edge and cloud.", "operationId": "FacadeServiceV1_GetCurrentTimeDataUri", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCurrentTimeDataV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "attributes", "in": "query", "required": false, "type": "array", "items": { "type": "string", "required": [ "attributes" ] }, "collectionFormat": "multi" }, { "name": "interval", "description": "Aggregation interval (in seconds).\r\n * Note: Only interval = 0 is currently supported; the latest value for the attributes requested will be returned with no aggregation.", "in": "query", "required": true, "type": "number", "format": "float" }, { "name": "frequency", "description": "How often to stream aggregated rows\r\n Note: Only 1 second frequency is currently supported", "in": "query", "required": false, "type": "number", "format": "float" }, { "name": "isDifferential", "description": "Note: not used for non-streamed current values. Only Is Differential = true is currently supported", "in": "query", "required": false, "type": "boolean", "default": "true" } ], "tags": [ "TimeBased" ] }, "post": { "summary": "Return last known values with request in BODY", "description": "Accept-Type:\r\n* text/event-stream: Streamed response of current value(s)\r\n * Note: currently differential = true , frequency = 1 and interval = 0 is only supported for cloud and edge\r\n* Note: Currently, this endpoint is implemented to work exclusively with streaming requests", "operationId": "FacadeServiceV1_GetCurrentTimeData", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCurrentTimeDataV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetCurrentTimeDataV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBased" ] } }, "/api/v1/jobs/{jobId}/data/time/current/capabilities": { "get": { "summary": "Fetches the capabilities for the GetCurrentTimeData endpoint", "operationId": "FacadeServiceV1_GetCurrentTimeDataCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetCurrentTimeDataCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBased" ] } }, "/api/v1/jobs/{jobId}/data/time/events": { "post": { "summary": "Retrieves a list of events over a time range", "operationId": "FacadeServiceV1_GetEvents", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeEventsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTimeEventsV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Events" ] } }, "/api/v1/jobs/{jobId}/data/time/events/capabilities": { "get": { "summary": "Fetches the capabilities of the GetEvents endpoint", "operationId": "FacadeServiceV1_GetEventsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeEventsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Events" ] } }, "/api/v1/jobs/{jobId}/data/time/formats": { "get": { "summary": "Return different format types available for time export", "operationId": "FacadeServiceV1_GetTimeExportFormats", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeExportFormatsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/time/formats/capabilities": { "get": { "summary": "Return the capabilities of GetTimeExportFormatsCapabilities endpoint", "operationId": "FacadeServiceV1_GetTimeExportFormatsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeExportFormatsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/time/formats/delimited": { "post": { "summary": "Return time data in a delimited file with request in BODY", "operationId": "FacadeServiceV1_GetTimeExportDelimited", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTimeExportDelimitedV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/time/formats/delimitedNoNullRows": { "post": { "summary": "Return time data in a delimited file with request in BODY and remove the rows that have empty values on all the attributes", "operationId": "FacadeServiceV1_GetTimeExportDelimitedNoNullRows", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTimeExportDelimitedV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/time/formats/{format}": { "post": { "summary": "Return time data in a file in the selected format with request in BODY", "operationId": "FacadeServiceV1_GetTimeExportFormat", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "format", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTimeExportFormatV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/time/formats/{format}/capabilities": { "get": { "summary": "Return the capabilities of GetTimeExportFormatCapabilities endpoint", "operationId": "FacadeServiceV1_GetTimeExportFormatCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeExportFormatCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "format", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeBasedExport" ] } }, "/api/v1/jobs/{jobId}/data/time/{attributeId}/time-summary": { "get": { "summary": "GetTimeSummary gets the time summary for the specified job and attribute IDs.", "description": "Accept-Type:\r\n* application/json: Single response of time summary \r\n* text/event-stream: Streamed response of time summaries", "operationId": "FacadeServiceV1_GetTimeSummary", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeSummaryV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "attributeId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "interval", "description": "The length of the time period to summarize in seconds.", "in": "query", "required": true, "type": "number", "format": "float" }, { "name": "toTime", "description": "End of the time period to summarize. When not set, the current time or job end is used.", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "threshold", "description": "The minimum value change, in seconds, required to send an update when streaming updates.", "in": "query", "required": false, "type": "number", "format": "float" }, { "name": "frequency", "description": "The frequency, in seconds, to check for value changes when streaming updates.", "in": "query", "required": false, "type": "number", "format": "float" } ], "tags": [ "TimeSummary" ] } }, "/api/v1/jobs/{jobId}/data/time/{attributeId}/time-summary/capabilities": { "get": { "summary": "GetTimeSummaryCapabilities gets the time summary for the specified job and attribute IDs.", "operationId": "FacadeServiceV1_GetTimeSummaryCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTimeSummaryCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "attributeId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TimeSummary" ] } }, "/api/v1/jobs/{jobId}/data/torque-drag": { "post": { "summary": "Return run data with request in BODY", "description": "Accept-Type:\r\n* application/json: Single response of run data\r\n*", "operationId": "FacadeServiceV1_GetTorqueDragRunDataByJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTorqueDragRunDataByJobV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTorqueDragRunDataByJobV1RequestParameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TorqueDrag" ] } }, "/api/v1/jobs/{jobId}/data/torque-drag/capabilities": { "get": { "summary": "Fetches the capabilities for the torque drag run data by the Job ID.", "operationId": "FacadeServiceV1_GetTorqueDragRunDataCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTorqueDragRunDataCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all run data", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TorqueDrag" ] } }, "/api/v1/jobs/{jobId}/models/pressure": { "get": { "operationId": "FacadeServiceV1_GetPressureModels", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetPressureModelsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": {} }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": false, "type": "string" }, { "name": "depthUnitId", "in": "query", "required": true, "type": "string" }, { "name": "pressureUnitId", "in": "query", "required": true, "type": "string" }, { "name": "densityUnitId", "in": "query", "required": true, "type": "string" } ], "tags": [ "PressureModels" ] }, "delete": { "operationId": "FacadeServiceV1_DeletePressureModel", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": {} }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "source", "in": "query", "required": true, "type": "string" }, { "name": "pressureModelId", "in": "query", "required": true, "type": "string" } ], "tags": [ "PressureModels" ] }, "put": { "operationId": "FacadeServiceV1_CreateOrUpdatePressureModels", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": {} }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "depthUnitId": { "type": "string" }, "pressureUnitId": { "type": "string" }, "densityUnitId": { "type": "string" }, "pressureModels": { "type": "array", "items": { "$ref": "#/definitions/PressureModelV1" } } }, "title": "CreateOrUpdatePressureModelsV1Request", "required": [ "depthUnitId", "pressureUnitId", "densityUnitId", "pressureModels" ] } } ], "tags": [ "PressureModels" ] } }, "/api/v1/jobs/{jobId}/models/pressure/capabilities": { "get": { "operationId": "FacadeServiceV1_GetPressureModelsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetPressureModelsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "PressureModels" ] } }, "/api/v1/jobs/{jobId}/models/surveys": { "get": { "summary": "GetSurveyModels gets all the survey models filtered by the optional parameters fromDepth, endDepth", "operationId": "FacadeServiceV1_GetSurveyModels", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/SurveyModelsByJobV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for the survey models", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "fromDepth", "description": "Minimum depth (MD) for returned survey models", "in": "query", "required": false, "type": "number", "format": "float" }, { "name": "toDepth", "description": "Maximum depth (MD) for returned survey models", "in": "query", "required": false, "type": "number", "format": "float" }, { "name": "depthUnitId", "description": "Unit type for SurveyDepth, TrueVerticalDepth in response. Also used as the distance component in DoglegSeverity (angle is constantly set to degrees)", "in": "query", "required": false, "type": "string" }, { "name": "planeAngleUnitId", "description": "Unit type for Inclination and Azimuth in response", "in": "query", "required": false, "type": "string" } ], "tags": [ "Surveys" ] } }, "/api/v1/jobs/{jobId}/models/surveys/capabilities": { "get": { "summary": "Fetches the capabilities for the historical surveys specified by the Job ID.", "operationId": "FacadeServiceV1_GetSurveyModelsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSurveyModelsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all surveys", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Surveys" ] } }, "/api/v1/jobs/{jobId}/models/torque-drag": { "post": { "summary": "Return torque and drag model with request in BODY", "description": "Accept-Type:\r\n* application/json: Single response of contextual models\r\n*", "operationId": "FacadeServiceV1_GetTorqueDragModelByJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTorqueDragModelsByJobV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetTorqueDragModelsByJobV1RequestParameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TorqueDrag" ] }, "put": { "summary": "CreateTorqueDragModels creates the Torque and Drag model for a specified run", "operationId": "FacadeServiceV1_CreateOrUpdateTorqueDragModelByJob", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateOrUpdateTorqueDragModelsByJobV1RequestParameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TorqueDrag" ] } }, "/api/v1/jobs/{jobId}/models/torque-drag/capabilities": { "get": { "summary": "Fetches the capabilities for the torque drag models by the Job ID.", "operationId": "FacadeServiceV1_GetTorqueDragModelsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTorqueDragModelsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "Id of the job for all models", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "TorqueDrag" ] } }, "/api/v1/jobs/{jobId}/reports": { "get": { "summary": "Fetches the list of report classifications with available reports for the given job", "operationId": "FacadeServiceV1_GetJobReportClassifications", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetReportClassificationsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Job Reports" ] } }, "/api/v1/jobs/{jobId}/reports/capabilities": { "get": { "summary": "Fetches the capabilities of reports endpoint", "operationId": "FacadeServiceV1_GetReportsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/JobReportsCapabililtiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Job Reports" ] } }, "/api/v1/jobs/{jobId}/reports/summary": { "get": { "summary": "Return the list of available well summary reports for the specified well", "operationId": "FacadeServiceV1_GetAvailableSummaryReports", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSummaryReportsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SummaryReports" ], "produces": [ "application/json", "application/x-protobuf" ] } }, "/api/v1/jobs/{jobId}/reports/summary/capabilities": { "get": { "summary": "Return the capabilities of well summary reports", "operationId": "FacadeServiceV1_GetAvailableSummaryReportsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportsSummaryGroupCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SummaryReports" ] } }, "/api/v1/jobs/{jobId}/reports/summary/{summaryReportId}/{fileFormatId}": { "get": { "summary": "Fetches the specified summary report", "operationId": "FacadeServiceV1_GetSummaryReport", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string", "default": "PDF" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "timeRange.from", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "timeRange.to", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "tags": [ "SummaryReports" ], "produces": [ "application/json", "application/x-protobuf" ] }, "post": { "summary": "Return the specified summary reports via file download", "operationId": "FacadeServiceV1_GetSummaryReportParameterized", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetSummaryReportV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "SummaryReports" ], "produces": [ "application/json", "application/x-protobuf" ] } }, "/api/v1/jobs/{jobId}/reports/summary/{summaryReportId}/{fileFormatId}/capabilities": { "get": { "summary": "Fetches the capabilities of summary reports format endpoint", "operationId": "FacadeServiceV1_GetSummaryReportFilesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportFilesCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string", "default": "PDF" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "timeRange.from", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "timeRange.to", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "tags": [ "SummaryReports" ] } }, "/api/v1/jobs/{jobId}/reports/{classification}": { "get": { "summary": "Fetches the list of report groups with available reports for the given job", "operationId": "FacadeServiceV1_GetReportGroups", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetReportGroupsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "classification", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Job Reports" ] } }, "/api/v1/jobs/{jobId}/reports/{classification}/capabilities": { "get": { "summary": "Fetches the capabilities of reports classification endpoint", "operationId": "FacadeServiceV1_GetJobReportsClassificationCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportsClassificationCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "classification", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Job Reports" ] } }, "/api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}": { "get": { "summary": "Fetches a list of all the available reports within the given report classification and group for the specified job.", "operationId": "FacadeServiceV1_GetAvailableReports", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetReportGroupV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "classification", "in": "path", "required": true, "type": "string" }, { "name": "reportGroupId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "timeRange.from", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "timeRange.to", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "tags": [ "Job Reports" ] } }, "/api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}/capabilities": { "get": { "summary": "Fetches the capabilities of reports group endpoint", "operationId": "FacadeServiceV1_GetReportsGroupCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportsGroupCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "classification", "in": "path", "required": true, "type": "string" }, { "name": "reportGroupId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "timeRange.from", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "timeRange.to", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "tags": [ "Job Reports" ] } }, "/api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}/{fileFormatId}": { "get": { "summary": "Fetches the specified reports via file download", "operationId": "FacadeServiceV1_GetReport", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "classification", "in": "path", "required": true, "type": "string" }, { "name": "reportGroupId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "reportSubTypeId", "in": "query", "required": false, "type": "string" }, { "name": "reportIds.ids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "reportDates.reportDates", "in": "query", "required": false, "type": "array", "items": { "type": "string", "format": "date-time" }, "collectionFormat": "multi" } ], "tags": [ "Job Reports" ], "produces": [ "application/json", "application/x-protobuf" ] }, "post": { "summary": "Return the specified reports via file download", "operationId": "FacadeServiceV1_GetReportParameterized", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "classification", "in": "path", "required": true, "type": "string" }, { "name": "reportGroupId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetReportV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Job Reports" ], "produces": [ "application/json", "application/x-protobuf" ] } }, "/api/v1/jobs/{jobId}/reports/{classification}/{reportGroupId}/{fileFormatId}/capabilities": { "get": { "summary": "Fetches the capabilities of reports format endpoint", "operationId": "FacadeServiceV1_GetReportFilesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportFilesCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "classification", "in": "path", "required": true, "type": "string" }, { "name": "reportGroupId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "reportSubTypeId", "in": "query", "required": false, "type": "string" }, { "name": "reportIds.ids", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi" }, { "name": "reportDates.reportDates", "in": "query", "required": false, "type": "array", "items": { "type": "string", "format": "date-time" }, "collectionFormat": "multi" } ], "tags": [ "Job Reports" ] } }, "/api/v1/jobs/{jobId}/segments": { "get": { "summary": "Return all segments for a given job", "operationId": "FacadeServiceV1_GetSegmentsByJob", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSegmentsByJobV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "syncStatus", "in": "query", "required": false, "type": "string", "enum": [ "Latest", "Unsynced", "Synced", "Both" ], "default": "Latest" }, { "name": "depthUnitId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Segments" ] }, "put": { "summary": "Create a segment", "operationId": "FacadeServiceV1_CreateSegment", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CreateSegmentV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "segmentConfiguration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SegmentConfigurationV1" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Segments" ] } }, "/api/v1/jobs/{jobId}/segments/capabilities": { "get": { "summary": "GetSegmentsCapabilities fetches the capabilities for the segments specified by the Job ID.", "operationId": "FacadeServiceV1_GetSegmentsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSegmentsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Segments" ] } }, "/api/v1/jobs/{jobId}/segments/{id}": { "get": { "summary": "GetSegmentByID gets the specific segment by id provided", "operationId": "FacadeServiceV1_GetSegmentById", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSegmentByIdV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "404": { "description": "Not Found - the user is requesting a segment id that does not exist or can't be found.", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "depthUnitId", "in": "query", "required": false, "type": "string" }, { "name": "syncStatus", "in": "query", "required": false, "type": "string", "enum": [ "Latest", "Unsynced", "Synced", "Both" ], "default": "Latest" } ], "tags": [ "Segments" ] }, "delete": { "summary": "DeleteSegmentById deletes a specific segment by id, if permissible", "operationId": "FacadeServiceV1_DeleteSegmentById", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The segment was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Segments" ] }, "put": { "summary": "UpdateSegmentById allows a user to update an existing segment for a specific job", "operationId": "FacadeServiceV1_UpdateSegmentById", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "404": { "description": "Not Found - the user is requesting an update to a segment id that does not exist or can't be found.", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "segmentConfiguration", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SegmentConfigurationV1" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Segments" ] } }, "/api/v1/jobs/{jobId}/segments/{id}/capabilities": { "get": { "summary": "GetSegmentCapabilities fetches the capabilities for the specific segment specified by the Segment ID and the Job ID.", "operationId": "FacadeServiceV1_GetSegmentCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSegmentCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Segments" ] } }, "/api/v1/jobs/{jobId}/uploadedFiles": { "get": { "summary": "Fetches the list of uploaded files properties for the specified Job ID.", "operationId": "FacadeServiceV1_GetUploadedFilesProperties", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetUploadedFilesPropertiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "UploadedFiles" ] }, "put": { "summary": "Upload a file for the specified Job ID. \nExpected form data: Description - Description of file being uploaded \nTimestamp - timestamp of file being uploaded\nDepth - Depth of file being uploaded\nUnitId - Unit of depth for uploaded file\nFullPath - Full path to be used for file being uploaded \nFile - Attached file will be uploaded and will share the above attributes", "operationId": "FacadeServiceV1_CreateUploadedFile", "responses": { "200": { "description": "Reserved for future use", "schema": { "$ref": "#/definitions/CreateUploadedFileV1Response" } }, "204": { "description": "The data was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "description": "From path", "in": "path", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "type": "object", "properties": { "correlationId": { "type": "string" }, "description": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time", "example": "2021-06-14T16:19:00.990Z" }, "depth": { "$ref": "#/definitions/DataValueV1", "description": "The unit of measure for the depth index returned,from_depth,to_depth \u0026 interval. for example: Depth.Meter.0 or Depth.Feet.1" }, "fullPath": { "type": "string" }, "file": { "type": "string", "format": "byte" } }, "title": "Upload file request message", "required": [ "file", "timestamp" ] } } ], "tags": [ "UploadedFiles" ] } }, "/api/v1/jobs/{jobId}/uploadedFiles/capabilities": { "get": { "summary": "Fetches the capabilities for the uploaded files specified by the Job Id.", "operationId": "FacadeServiceV1_GetUploadedFilesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetUploadedFilesCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "UploadedFiles" ] } }, "/api/v1/jobs/{jobId}/uploadedFiles/{id}": { "get": { "summary": "Download file by Job ID and ID.", "operationId": "FacadeServiceV1_GetUploadedFile", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "file","format": "byte" } }, "204": { "description": "The file was downloaded successfully", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "skipBytes", "in": "query", "required": false, "type": "integer", "format": "int32" }, { "name": "fetchBytes", "in": "query", "required": false, "type": "integer", "format": "int32" } ], "tags": [ "UploadedFiles" ] }, "delete": { "summary": "Delete the specified file for specified Job ID and File ID.", "operationId": "FacadeServiceV1_DeleteUploadedFile", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The uploaded file was deleted successfully and the response body has no content.", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "UploadedFiles" ] } }, "/api/v1/jobs/{jobId}/uploadedFiles/{id}/capabilities": { "get": { "summary": "Fetches the capabilities for the specific uploaded file specified by the File Id and the Job Id.", "operationId": "FacadeServiceV1_GetUploadedFileCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetUploadedFileCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "UploadedFiles" ] } }, "/api/v1/jobs/{jobId}/uploadedFiles/{id}/properties": { "get": { "summary": "Fetches the uploaded file properties for the specified Job ID and file ID.", "operationId": "FacadeServiceV1_GetUploadedFileProperties", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/UploadedFilePropertiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "UploadedFiles" ] } }, "/api/v1/jobs/{jobId}/uploadedFiles/{id}/properties/capabilities": { "get": { "summary": "Fetches the uploaded file property's capabilities for the specified Job ID and file ID.", "operationId": "FacadeServiceV1_GetUploadedFilePropertiesCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetUploadedFileCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string" }, { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "UploadedFiles" ] } }, "/api/v1/meta": { "get": { "summary": "Return a list of key/value pairs from meta data.", "operationId": "FacadeServiceV1_GetMeta", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetMetaV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "take", "description": "Maximum number of results to return.", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "50" }, { "name": "skip", "description": "Number of results to skip.", "in": "query", "required": false, "type": "integer", "format": "int32", "default": "0" }, { "name": "total", "in": "query", "required": false, "type": "boolean", "default": "false" } ], "tags": [ "Meta" ] } }, "/api/v1/meta/capabilities": { "get": { "summary": "Fetches the capabilities for the Meta endpoint", "operationId": "FacadeServiceV1_GetMetaCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetMetaCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Meta" ] } }, "/api/v1/meta/{key}": { "get": { "summary": "Reads meta data.", "operationId": "FacadeServiceV1_GetMetaByKey", "responses": { "200": { "description": "A successful response.", "schema": { "type": "string" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User is not authorized to access this meta", "schema": { "type": "string", "format": "string" } }, "404": { "description": "Not Found - the user is going to a resource that does not exist or can't be found (i.e. mistype api/v1/jebs instead of api/v1/jobs), it should also let the user know when a resource doesn't exist when they own the entire key space of what is being searched for (i.e. the meta endpoint should return a 404 when a key that hasn't been saved yet is requested).", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "key", "description": "The key to read meta data for.", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Meta" ] }, "delete": { "summary": "Deletes meta data. Deleting data for a key with no associated data silently does nothing.", "operationId": "FacadeServiceV1_DeleteMetaByKey", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The meta was deleted successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User is not authorized to access this meta", "schema": { "type": "string", "format": "string" } }, "404": { "description": "Not Found - the user is going to a resource that does not exist or can't be found (i.e. mistype api/v1/jebs instead of api/v1/jobs), it should also let the user know when a resource doesn't exist when they own the entire key space of what is being searched for (i.e. the meta endpoint should return a 404 when a key that hasn't been saved yet is requested).", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "key", "description": "The key to delete meta data from.", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Meta" ] }, "put": { "summary": "Stores meta data. Meta data is not interpreted and will be returned when calling read with the same key. Overrides any previous data stored by the\ngiven key.", "operationId": "FacadeServiceV1_PutMetaByKey", "responses": { "200": { "description": "Reserved for future use", "schema": { "type": "object", "properties": {} } }, "204": { "description": "The meta was stored successfully and the response body has no content", "schema": {} }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User is not authorized to access this meta", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "key", "description": "The key to store meta data to.", "in": "path", "required": true, "type": "string" }, { "name": "data", "description": "The meta data to store.", "in": "body", "required": true, "schema": { "type": "string" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Meta" ] } }, "/api/v1/meta/{key}/capabilities": { "get": { "summary": "Fetches the capabilities for the Meta endpoint", "operationId": "FacadeServiceV1_GetMetaByKeyCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetMetaCapabilitiesByKeyV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "key", "description": "The key to get specific meta capabilities.", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Meta" ] } }, "/api/v1/reports": { "get": { "summary": "Return available report classifications", "operationId": "FacadeServiceV1_GetReportClassifications", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetReportClassificationsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/capabilities": { "get": { "summary": "Fetches the capabilities of reports endpoint", "operationId": "FacadeServiceV1_GetMultiJobSummaryClassificationsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportsCapabililtiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/next": { "get": { "summary": "Return the next report", "operationId": "FacadeServiceV1_GetNextReport", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "nextReportKey", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ], "produces": [ "application/json", "application/x-protobuf" ] } }, "/api/v1/reports/next-deleted": { "get": { "summary": "Return the next deleted report", "operationId": "FacadeServiceV1_GetNextDeletedReport", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetNextDeletedReportV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "nextDeletedReportKey", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ], "produces": [ "application/json", "application/x-protobuf" ] } }, "/api/v1/reports/next-deleted/capabilities": { "get": { "summary": "Fetches the capabilities of the next deleted report endpoint", "operationId": "FacadeServiceV1_GetNextDeletedReportCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/NextDeletedReportCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/next/capabilities": { "get": { "summary": "Fetches the capabilities of the next report endpoint", "operationId": "FacadeServiceV1_GetNextReportCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/NextReportCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/summary": { "get": { "summary": "Return available reports for the given classification for Multi-Job Summary Reports", "operationId": "FacadeServiceV1_GetMultiJobSummaryAvailableReports", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetSummaryReportTypesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/summary/capabilities": { "get": { "summary": "Fetches the capabilities of reports classification endpoint", "operationId": "FacadeServiceV1_GetMultiJobSummaryAvailableReportsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportsSummaryGroupCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/summary/{summaryReportId}": { "get": { "summary": "Return available formats for the summary report", "operationId": "FacadeServiceV1_GetMultiJobSummaryReportInformation", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetReportFormatsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/summary/{summaryReportId}/capabilities": { "get": { "summary": "Fetches the capabilities of summary report id endpoint", "operationId": "FacadeServiceV1_GetMultiJobSummaryReportInformationCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportsFormatsCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/summary/{summaryReportId}/{fileFormatId}": { "get": { "summary": "Return a pdf or zip file with the summary report for all wells in the time range", "operationId": "FacadeServiceV1_GetMultiJobSummaryReport", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string", "default": "PDF" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" }, { "name": "timeRange.from", "in": "query", "required": false, "type": "string", "format": "date-time" }, { "name": "timeRange.to", "in": "query", "required": false, "type": "string", "format": "date-time" } ], "tags": [ "Reports" ] }, "post": { "summary": "Return a pdf or zip file with the summary report for all wells in the time range", "operationId": "FacadeServiceV1_GetMultiJobSummaryReportParametrized", "responses": { "200": { "description": "A successful response.", "schema": { "type": "file","format": "byte" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "403": { "description": "User does not have access to this resource", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GetSummaryReportV1Parameters" } }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/reports/summary/{summaryReportId}/{fileFormatId}/capabilities": { "get": { "summary": "Return capabilities for the multi job summary report endpoint", "operationId": "FacadeServiceV1_GetMultiJobSummaryReportCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/ReportFilesCapabilitiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "summaryReportId", "in": "path", "required": true, "type": "string" }, { "name": "fileFormatId", "in": "path", "required": true, "type": "string" }, { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Reports" ] } }, "/api/v1/tokens/token": { "get": { "summary": "GetToken authenticates a user and returns an authentication token.", "operationId": "FacadeServiceV1_GetToken", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetTokenV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "applicationId", "description": "GUID", "in": "query", "required": false, "type": "string" } ], "tags": [ "Tokens" ], "security": [ { "BasicAuth": [] } ] } }, "/api/v1/units/definitions": { "get": { "summary": "GetUnitDefinitions retrieves unit of measure definitions", "operationId": "FacadeServiceV1_GetUnitDefinitions", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetUnitDefinitionsV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Units" ] } }, "/api/v1/units/definitions/capabilities": { "get": { "summary": "GetUnitDefinitionsCapabilities retrieves capabilities for unit definitions", "operationId": "FacadeServiceV1_GetUnitDefinitionsCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/GetUnitDefinitionsCapabilitiesV1Response" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Units" ] } }, "/api/v1/users/current": { "get": { "summary": "Fetches the current user", "operationId": "FacadeServiceV1_GetCurrentUser", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/UserV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Users" ] } }, "/api/v1/users/current/capabilities": { "get": { "summary": "Fetches the capabilities of the current user endpoint", "operationId": "FacadeServiceV1_GetCurrentUserCapabilities", "responses": { "200": { "description": "A successful response.", "schema": { "$ref": "#/definitions/CurrentUserCapabililtiesV1" } }, "400": { "description": "Bad Request - the input for the request cannot be parsed (i.e. invalid JSON) or datatype requirements are not met (i.e. string passed to an int field), or the data passed in is functionally invalid (i.e. endTime before startTime)", "schema": { "type": "string", "format": "string" } }, "401": { "description": "Unauthorized", "schema": { "type": "string", "format": "string" } }, "500": { "description": "Internal", "schema": { "type": "string", "format": "string" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/rpcStatus" } } }, "parameters": [ { "name": "correlationId", "in": "query", "required": false, "type": "string" } ], "tags": [ "Users" ] } } }, "definitions": { "AggregationModeV1": { "type": "string", "enum": [ "Last", "Minimum", "Maximum", "Average", "First" ], "default": "Last", "description": "- Last: Last value within requested interval\n - Minimum: Minimum value within requested interval\n - Maximum: Maximum value within the requested interval\n - Average: Average value within the requested interval\n - First: First value within requested interval", "title": "AggregationModeV1" }, "AlarmConfigurationV1": { "type": "object", "properties": { "broadcastTime": { "type": "string", "format": "date-time", "example": "2021-06-14T16:19:00.990Z" }, "attributeIndex": { "type": "integer", "format": "int32" }, "lowLowThresholdValue": { "type": "number", "format": "float" }, "lowThresholdValue": { "type": "number", "format": "float" }, "highThresholdValue": { "type": "number", "format": "float" }, "highHighThresholdValue": { "type": "number", "format": "float" }, "lowLowThresholdEnabled": { "type": "boolean" }, "lowThresholdEnabled": { "type": "boolean" }, "highThresholdEnabled": { "type": "boolean" }, "highHighThresholdEnabled": { "type": "boolean" }, "hornStatus": { "type": "boolean" }, "alarmOwner": { "type": "string" } }, "required": [ "broadcastTime", "attribute" ] }, "AlarmEventV1": { "type": "object", "properties": { "type": { "$ref": "#/definitions/AlarmEventV1AlarmType" }, "broadcastTime": { "type": "string", "format": "date-time", "example": "2021-06-14T16:19:00.990Z" }, "attributeIndex": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "float" }, "alarmState": { "$ref": "#/definitions/AlarmEventV1AlarmState" }, "alarmThresholdValue": { "type": "number", "format": "float" }, "alarmThresholdType": { "$ref": "#/definitions/AlarmEventV1AlarmThresholdType" }, "hornStatus": { "type": "boolean" }, "hornSounded": { "type": "boolean" }, "alarmOwner": { "type": "string" } }, "required": [ "type", "broadcastTime", "attribute", "value", "alarmState", "alarmThresholdValue", "alarmThresholdType" ] }, "AlarmEventV1AlarmState": { "type": "string", "enum": [ "Unknown", "Entered", "Exited", "Acknowledged", "Disabled" ], "default": "Unknown" }, "AlarmEventV1AlarmThresholdType": { "type": "string", "enum": [ "None", "Low", "High", "LowLow", "HighHigh" ], "default": "None" }, "AlarmEventV1AlarmType": { "type": "string", "enum": [ "Attribute", "KMD" ], "default": "Attribute" }, "AttributeBaseV1": { "type": "object", "properties": { "id": { "type": "string", "title": "Attribute identifier" }, "name": { "type": "string", "title": "Attribute name" }, "unit": { "$ref": "#/definitions/UnitV1", "title": "Attribute unit" } }, "required": [ "id", "name", "unit" ] }, "AttributeDataRequestV1": { "type": "object", "properties": { "id": { "type": "string" }, "mode": { "$ref": "#/definitions/AggregationModeV1", "default": "Last" }, "unitId": { "type": "string", "description": "The unit of measure for the attribute. for example: Depth.Meter.0 or Depth.Feet.1 if it's a depth attribute" } }, "description": "Specifies the attribute name, the mode, Unit of the value to be returned.", "required": [ "id" ] }, "AttributeDataResponseV1": { "type": "object", "properties": { "id": { "type": "string" }, "mode": { "$ref": "#/definitions/AggregationModeV1", "default": "Last" }, "unit": { "$ref": "#/definitions/UnitV1", "description": "The unit of measure for the attribute." } }, "description": "Specifies the attribute name, the mode, Unit of the value to be returned.", "required": [ "id" ] }, "AttributeDataWithPrecisionRequestV1": { "type": "object", "properties": { "id": { "type": "string" }, "mode": { "$ref": "#/definitions/AggregationModeV1", "default": "Last" }, "unitId": { "type": "string", "description": "The unit of measure for the attribute. for example: Depth.Meter.0 or Depth.Feet.1 if it's a depth attribute" }, "precision": { "type": "integer", "format": "int32", "description": "The precision for the returned data value. Note: If not specified the Attribute's default precision is used." } }, "description": "Specifies the attribute name, the mode, Unit, precision of the value and to be returned.", "required": [ "id" ] }, "AttributeV1": { "type": "object", "properties": { "id": { "type": "string", "title": "Attribute identifier" }, "name": { "type": "string", "title": "Attribute name" }, "unit": { "$ref": "#/definitions/UnitV1", "title": "Attribute unit" }, "defaultPrecision": { "type": "integer", "format": "int32", "title": "Default display precision for the attribute" }, "isHistoryAvailable": { "type": "boolean", "title": "True if data can be saved for this attribute" }, "defaultLowerBound": { "type": "number", "format": "float", "title": "Default chart lower bound for the attribute" }, "defaultUpperBound": { "type": "number", "format": "float", "title": "Default chart upper bound for the attribute" }, "hasData": { "type": "boolean", "title": "True if there is data recorded for this attribute" }, "valueMap": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ValueMetaV1" }, "description": "Maps numeric codes to text. Optionally includes additional meta data." }, "type": { "type": "string", "title": "Attribute type" }, "description": { "type": "string", "title": "Attribute description" }, "categories": { "type": "array", "items": { "type": "string" }, "title": "Attribute categories" }, "alternateTargets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The attribute ID to track index value of this attribute when using a non-time index. E.g. depth target." }, "alias": { "type": "object", "example": { "witsml_mnemonic": "HOOKLOAD_MAX", "other_alias": "string" }, "additionalProperties": { "type": "string" }, "title": "Aliases" } }, "title": "AttributeV1", "required": [ "id", "name", "type", "unit" ] }, "AvailableReportFormatV1": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" } } }, "BhaComponentTypeV1": { "type": "string", "enum": [ "Other", "UnknownType", "BitCoreDiamond", "BitCorePdc", "BitDiamondFixedCut", "BitHoleOpener", "BitInsertRollerCone", "BitMillToothRollerCone", "BitPDCFixedCutter", "BitUnderReamer", "DrillCollar", "DrillPipe", "HeavyWeightDrillPipe", "Jar", "Kelly", "Motor", "Mwd", "BitGeneric", "CrossoverSub", "Reamer", "Stabilizer", "Sub", "Lwd", "RotarySteeringTool" ], "default": "Other", "title": "BhaComponentTypeV1" }, "BhaComponentV1": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "type": { "$ref": "#/definitions/BhaComponentTypeV1" }, "modifiedTime": { "type": "string", "format": "date-time" }, "number": { "type": "string" }, "length": { "$ref": "#/definitions/DataValueV1" }, "innerDiameter": { "$ref": "#/definitions/DataValueV1" }, "outerDiameter": { "$ref": "#/definitions/DataValueV1" }, "weightPerUnitLength": { "$ref": "#/definitions/DataValueV1" }, "maxTorque": { "$ref": "#/definitions/DataValueV1" }, "maxDiffPressure": { "$ref": "#/definitions/DataValueV1" }, "rpmToFlow": { "$ref": "#/definitions/DataValueV1" }, "grade": { "type": "string" }, "topThread": { "type": "string" }, "gauge": { "type": "string" }, "totalFlowArea": { "$ref": "#/definitions/DataValueV1" }, "lobes": { "type": "string" }, "stages": { "type": "number", "format": "double" }, "bendAngle": { "$ref": "#/definitions/DataValueV1" }, "bitToBend": { "$ref": "#/definitions/DataValueV1" }, "stabOuterDiameter": { "$ref": "#/definitions/DataValueV1" }, "stabLength": { "$ref": "#/definitions/DataValueV1" }, "stabToBit": { "$ref": "#/definitions/DataValueV1" }, "model": { "type": "string" }, "serialNumber": { "type": "string" }, "toolJointOuterDiameter": { "$ref": "#/definitions/DataValueV1" }, "toolJointInnerDiameter": { "$ref": "#/definitions/DataValueV1" }, "toolJointTotalLength": { "$ref": "#/definitions/DataValueV1" }, "pipeCapacityVolumePerLength": { "$ref": "#/definitions/DataValueV1" }, "pipeDisplacementVolumePerLength": { "$ref": "#/definitions/DataValueV1" } }, "title": "BhaComponentV1" }, "BhaV1": { "type": "object", "properties": { "id": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "number": { "type": "string" }, "startDepth": { "$ref": "#/definitions/DataValueV1" }, "endDepth": { "$ref": "#/definitions/DataValueV1" }, "nozzleTotalFlowArea": { "$ref": "#/definitions/DataValueV1" }, "isDraft": { "type": "boolean" }, "bhaComponents": { "type": "array", "items": { "$ref": "#/definitions/BhaComponentV1" } }, "source": { "type": "string" }, "description": { "type": "string" } }, "title": "BhaV1" }, "CalculatedAttributeConstantV1": { "type": "object", "properties": { "name": { "type": "string", "title": "Calculated attribute constant name" }, "value": { "type": "number", "format": "float", "title": "Calculated attribute constant value" }, "storageLocation": { "$ref": "#/definitions/StorageLocationV1", "title": "The location of the calculated attribute constant" } }, "required": [ "name", "unit", "expression_string" ] }, "CalculatedAttributeV1": { "type": "object", "properties": { "id": { "type": "string", "title": "Calculated attribute identifier" }, "name": { "type": "string", "title": "Calculated attribute name" }, "unit": { "$ref": "#/definitions/UnitV1", "title": "Calculated attribute unit" }, "expressionString": { "type": "string", "title": "The expression_string should reference attribute IDs (not attribute names). For example: \"attr_123 + attr_456\"" }, "nullConversionRule": { "$ref": "#/definitions/NullValueConversionV1", "title": "Null handling rules" }, "storageLocation": { "$ref": "#/definitions/StorageLocationV1", "title": "The location of the calculated attribute" }, "passwordProtected": { "type": "boolean", "title": "True if the calculated attribute is password protected" }, "defaultScaleRange": { "$ref": "#/definitions/DefaultScaleRangeV1", "title": "Default scale range" } }, "required": [ "id", "name", "unit", "expressionString" ] }, "CalculatedAttributeV1Configuration": { "type": "object", "properties": { "name": { "type": "string", "title": "Calculated attribute name" }, "unitId": { "type": "string", "title": "Calculated attribute unit id (or unit label)" }, "expressionString": { "type": "string", "title": "Calculated expression string" }, "nullConversionRule": { "$ref": "#/definitions/NullValueConversionV1", "title": "Null handling rules" }, "storageLocation": { "$ref": "#/definitions/StorageLocationV1", "title": "The location of the calculated attribute" }, "password": { "type": "string", "description": "Sets the password. Send an empty string to remove the password. Can leave null if not changing the password." }, "defaultScaleRange": { "$ref": "#/definitions/DefaultScaleRangeV1", "title": "Default scale range" } }, "required": [ "name", "unitId", "expressionString" ] }, "CapabilityV1": { "type": "string", "enum": [ "Supported", "NotPermitted", "NotSupported" ], "default": "Supported", "title": "CapabilityV1" }, "CasingComponentV1": { "type": "object", "properties": { "id": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" }, "innerDiameter": { "$ref": "#/definitions/DataValueV1" }, "outerDiameter": { "$ref": "#/definitions/DataValueV1" }, "weight": { "$ref": "#/definitions/DataValueV1" }, "length": { "$ref": "#/definitions/DataValueV1" }, "grade": { "type": "string" }, "description": { "type": "string" }, "type": { "$ref": "#/definitions/CasingComponentV1CasingComponentTypeV1" }, "number": { "type": "string" } } }, "CasingComponentV1CasingComponentTypeV1": { "type": "string", "enum": [ "Other", "AirLockSub", "Casing", "CasingShoe", "Crossover", "DrillPipe", "ExternalCasingPacker", "FloatCollar", "FloatShoe", "FlowControlValve", "HwDrillPipe", "LandingCollar", "Liner", "LinerHanger", "LinerTiebackReceptacle", "Marker", "PupJoint", "SlidingSleeve", "SlottedLiner", "StretchCorrection" ], "default": "Other" }, "CasingV1": { "type": "object", "properties": { "id": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" }, "runTime": { "type": "string", "format": "date-time" }, "bottomTime": { "type": "string", "format": "date-time" }, "nominalInnerDiameter": { "$ref": "#/definitions/DataValueV1" }, "nominalOuterDiameter": { "$ref": "#/definitions/DataValueV1" }, "shoeDepth": { "$ref": "#/definitions/DataValueV1" }, "isDraft": { "type": "boolean" }, "components": { "type": "array", "items": { "$ref": "#/definitions/CasingComponentV1" } }, "source": { "type": "string" }, "description": { "type": "string" } } }, "Configuration": { "type": "object", "properties": { "type": { "$ref": "#/definitions/ConfigurationType" }, "configuration": { "type": "string" } } }, "ConfigurationType": { "type": "string", "enum": [ "BaseOverlayConfig" ], "default": "BaseOverlayConfig" }, "ConnectionV1": { "type": "object", "properties": { "weightToWeightEvent": { "$ref": "#/definitions/TimestampRangeV1", "description": "Start time and end time for the period when the drill bit is not on bottom" }, "slipToSlipEvent": { "$ref": "#/definitions/TimestampRangeV1", "description": "Start time and end time for the in-slips event, if multiple events are found the outer limits of the events is given." }, "weightToWeight": { "type": "number", "format": "float", "description": "Weight to Weight time given in seconds, equal to the time delta in seconds between the start and end time of weight_to_weight_event" }, "weightToSlip": { "type": "number", "format": "float", "description": "Weight to Slips time given in seconds, equal to the time delta in seconds between the end time of weight_to_weight_event and the start time of the slip_to_slip_event" }, "slipToSlip": { "type": "number", "format": "float", "description": "Slip to Slip time given in seconds, equal to the time delta in seconds between the start and end time of slip_to_slip_event" }, "slipToWeight": { "type": "number", "format": "float", "description": "Slip to Weight time given in seconds, equal to the time delta in seconds between the end time of slip_to_slip_event and end time of weight_to_weight_event" }, "inSlipsBitPosition": { "type": "number", "format": "float", "description": "The Bit Positions at the start time of the slip_to_slip_event" }, "inSlipsHolePosition": { "type": "number", "format": "float", "description": "The Hole depth at the start time of the slip_to_slip_event" }, "connectionType": { "$ref": "#/definitions/ConnectionV1ConnectionTypeV1", "description": "The connection type, Drilling, Tripping. Where a drilling connection has weight events on each side of the slip-to-slip" }, "direction": { "$ref": "#/definitions/ConnectionV1DirectionV1", "description": "The direction of drill string travel during the connection as determined by comparing the in-slips to the out-slips Block Height" }, "runType": { "$ref": "#/definitions/ConnectionV1RunTypeV1", "description": "The run type, BHA, Casing or Unknown in which the connection occurred" }, "runNumber": { "type": "integer", "format": "int32", "description": "The run number in sequence starting at 1 including all run types" }, "runPhase": { "$ref": "#/definitions/RunPhaseV1", "description": "The phase of the run; Trip In, Trip Out, Drilling, or Short Trip" }, "inCasing": { "type": "boolean", "description": "If the in-slips Bit Position is inside of the last casing shoe from the run data" }, "shift": { "type": "string", "description": "The shift in which the connection occurred based on the input provided in the request" }, "operationType": { "$ref": "#/definitions/ConnectionV1OperationTypeV1", "description": "The operation type, MakeUp or LayDown. Where a MakeUp connections refers to joining drill pipes or tubulars" }, "sources": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Source information related to the connection" } } }, "ConnectionV1ConnectionTypeV1": { "type": "string", "enum": [ "UnknownConnectionType", "Drilling", "Tripping", "TripToDrill", "DrillToTrip" ], "default": "UnknownConnectionType" }, "ConnectionV1DirectionV1": { "type": "string", "enum": [ "UnknownDirection", "In", "Out" ], "default": "UnknownDirection" }, "ConnectionV1OperationTypeV1": { "type": "string", "enum": [ "UnknownOperationType", "NonBha", "MakeUp", "LayDown" ], "default": "UnknownOperationType" }, "ConnectionV1RunTypeV1": { "type": "string", "enum": [ "Unknown", "Casing", "Bha" ], "default": "Unknown" }, "ConnectionsCapabilitiesResponseV1": { "type": "object", "properties": { "getConnections": { "$ref": "#/definitions/CapabilityV1" }, "sources": { "type": "array", "items": { "type": "string" }, "description": "List of available sources" } } }, "CreateCalcualtedAttributeV1Response": { "type": "object", "properties": { "id": { "type": "string", "title": "Id of the created calculated attribute" } } }, "CreateNoteV1": { "type": "object", "properties": { "text": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "depth": { "type": "number", "format": "float" }, "type": { "$ref": "#/definitions/CreateNoteV1Type" }, "source": { "type": "string", "example": "Sentinel", "title": "Currently 'RT' \u0026 'Sentinel' are the only supported values for cloud. (Cloud default: 'RT')" } }, "required": [ "text", "timestamp", "type" ] }, "CreateNoteV1Response": { "type": "object", "properties": { "id": { "type": "string" } } }, "CreateNoteV1Type": { "type": "string", "enum": [ "None", "Time", "Depth" ], "default": "None" }, "CreateOrUpdateConfigurationRequestParameters": { "type": "object", "properties": { "configuration": { "type": "string" } } }, "CreateOrUpdateTorqueDragModelsByJobV1RequestParameters": { "type": "object", "properties": { "source": { "type": "string", "example": "Sentinel", "default": "\"Unknown\"" }, "runId": { "type": "string", "example": "100" }, "models": { "type": "array", "items": { "$ref": "#/definitions/TorqueDragModelPointV1" } } }, "required": [ "runId" ] }, "CreateRoadmapAttributeV1Response": { "type": "object", "properties": { "id": { "type": "string", "title": "Id of the created roadmap attribute" } } }, "CreateSegmentV1Response": { "type": "object", "properties": { "id": { "type": "string" } }, "description": "Create Segment response" }, "CreateSurveysV1RequestParameters": { "type": "object", "properties": { "source": { "type": "string" }, "replaceAll": { "type": "boolean", "title": "if true, will delete previous Surveys in the depth range that is submitted in payload; else, skip the deletion." }, "surveys": { "type": "array", "items": { "$ref": "#/definitions/SurveyV1" }, "title": "survey_depth, inclination, azimuth, with their units are required fields, and are the currently supported fields." } }, "required": [ "source", "surveys" ] }, "CreateSwabSurgeDataBody": { "type": "object", "properties": { "equivalentMudWeights": { "type": "array", "items": { "$ref": "#/definitions/GetEquivalentMudWeightV1Response" } } } }, "CreateUploadedFileV1Response": { "type": "object", "properties": { "id": { "type": "string" } } }, "CurrentUserCapabililtiesV1": { "type": "object", "properties": { "getCurrentUser": { "$ref": "#/definitions/CapabilityV1" } } }, "DataValueV1": { "type": "object", "properties": { "value": { "type": "number", "format": "float" }, "unit": { "$ref": "#/definitions/UnitV1" } } }, "DefaultScaleRangeV1": { "type": "object", "properties": { "from": { "type": "integer", "format": "int32", "default": "0" }, "to": { "type": "integer", "format": "int32", "default": "100" } } }, "DepthIndexType": { "type": "string", "enum": [ "MeasuredDepth", "Tvd" ], "default": "MeasuredDepth", "description": " - MeasuredDepth: Currently we support only MeasuredDepth,\n - Tvd: Tvd is not currently supported." }, "DepthRecordV1": { "type": "object", "properties": { "depth": { "type": "number", "format": "float" }, "values": { "type": "array", "items": { "$ref": "#/definitions/DepthValueV1" } }, "timestamp": { "type": "string", "format": "date-time" } }, "description": "Specifies depth data at a particular depth for all requested attributes.", "required": [ "depth", "values" ] }, "DepthValueV1": { "type": "object", "properties": { "index": { "type": "integer", "format": "int32", "title": "Indexed value of the requested attribute" }, "value": { "type": "number", "format": "float" }, "overrideTimeStamp": { "type": "string", "format": "date-time" } }, "description": "Note: The serialization of this record is compact in that field names are not returned.\r\n\r\n example(s):\r\n * [22, 4605.12]\r\n * [32, 33.765, \"2021-06-18T9:16:00-6:00\"]", "required": [ "index", "value" ] }, "DrillingPropertiesV1": { "type": "object", "properties": { "afe": { "type": "string" }, "api": { "type": "string" }, "totalDepth": { "type": "number", "format": "float" }, "totalDepthUnit": { "$ref": "#/definitions/UnitV1" } }, "description": "Drilling Properties will be return if job type is DRILLING" }, "EventDataV1": { "type": "object", "properties": { "eventRange": { "$ref": "#/definitions/TimestampRangeV1" }, "parameters": { "type": "array", "items": { "$ref": "#/definitions/TimeRecordV1" } }, "matchedFilteredValue": { "type": "number", "format": "float" } } }, "FileV1Response": { "type": "object", "description": "Is used as marker in the generated swagger which is used to fixup (i.e. replace) the successful response json for the get export data end-points prior to generating the client lib(s)" }, "FilterBetween": { "type": "object", "properties": { "range": { "$ref": "#/definitions/FloatRangeV1", "description": "Filters when the attribute equals any value between, or equal to the 'from' and 'to' values" } } }, "FilterDataV1": { "type": "object", "properties": { "attributeId": { "type": "string" }, "isIn": { "$ref": "#/definitions/FilterIsIn" }, "equals": { "$ref": "#/definitions/FilterEquals" }, "greaterThan": { "$ref": "#/definitions/FilterGreaterThan" }, "greaterThanEqual": { "$ref": "#/definitions/FilterGreaterThanEqual" }, "lessThan": { "$ref": "#/definitions/FilterLessThan" }, "lessThanEqual": { "$ref": "#/definitions/FilterLessThanEqual" }, "hasData": { "$ref": "#/definitions/FilterHasData" }, "between": { "$ref": "#/definitions/FilterBetween" }, "isNull": { "$ref": "#/definitions/FilterIsNull", "description": "Filters when the attribute is Null" }, "isNotIn": { "$ref": "#/definitions/FilterIsNotIn" }, "unit": { "$ref": "#/definitions/UnitV1" } } }, "FilterEquals": { "type": "object", "properties": { "value": { "type": "number", "format": "float" } } }, "FilterGreaterThan": { "type": "object", "properties": { "value": { "type": "number", "format": "float" } } }, "FilterGreaterThanEqual": { "type": "object", "properties": { "value": { "type": "number", "format": "float" } } }, "FilterHasData": { "type": "object" }, "FilterIsIn": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "number", "format": "float" }, "description": "Filters when the attribute equals any value in the list of values. When used for events creates a new event when the value changes if both values are in the value filter list" } } }, "FilterIsNotIn": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "number", "format": "float" }, "description": "Filters when the attribute does not equal any value in the list of values. When used for events creates a new event when the value changes if both values are noy in the value filter list" } } }, "FilterIsNull": { "type": "object" }, "FilterLessThan": { "type": "object", "properties": { "value": { "type": "number", "format": "float" } } }, "FilterLessThanEqual": { "type": "object", "properties": { "value": { "type": "number", "format": "float" } } }, "FilterRequestV1": { "type": "object", "properties": { "attributeId": { "type": "string" }, "isIn": { "$ref": "#/definitions/FilterIsIn" }, "equals": { "$ref": "#/definitions/FilterEquals" }, "greaterThan": { "$ref": "#/definitions/FilterGreaterThan" }, "greaterThanEqual": { "$ref": "#/definitions/FilterGreaterThanEqual" }, "lessThan": { "$ref": "#/definitions/FilterLessThan" }, "lessThanEqual": { "$ref": "#/definitions/FilterLessThanEqual" }, "hasData": { "$ref": "#/definitions/FilterHasData" }, "between": { "$ref": "#/definitions/FilterBetween" }, "isNull": { "$ref": "#/definitions/FilterIsNull", "description": "Filters when the attribute is Null" }, "isNotIn": { "$ref": "#/definitions/FilterIsNotIn" }, "unitId": { "type": "string" }, "coolDownTime": { "type": "integer", "format": "int32", "description": "This is a timespan field. The unit for this field is seconds with a permissible range between 0 and 600. Default value will be zero" } }, "description": "Filter is required. Multiple filters at a single request are not supported.", "required": [ "attributeId" ] }, "FloatRangeV1": { "type": "object", "properties": { "from": { "type": "number", "format": "float", "example": "123.45" }, "to": { "type": "number", "format": "float", "example": "123.45" } } }, "FormationV1": { "type": "object", "properties": { "id": { "type": "string", "description": "System assigned id for the data entry." }, "name": { "type": "string", "title": "Name of the formation" }, "description": { "type": "string", "description": "A short description of the formation." }, "comment": { "type": "string", "title": "User comments" }, "chronostratigraphic": { "type": "string", "description": "The geological classification of the formation." }, "sequenceNumber": { "type": "integer", "format": "int32", "description": "The order of the formation starting at 1." }, "source": { "type": "string", "description": "The the system that provided the data, if user entered the system is RigSense." }, "measuredDepthProg": { "type": "number", "format": "float", "description": "Prognosed or planned depth along the wellbore, reference kb." }, "trueVerticalDepthProg": { "type": "number", "format": "float", "description": "Prognosed or planned true vertical depth of the formation at the intersection with the wellbore, reference kb." }, "measuredDepthActual": { "type": "number", "format": "float", "description": "Actual depth along the wellbore, reference kb." }, "trueVerticalDepthActual": { "type": "number", "format": "float", "description": "Actual true vertical depth of the formation at the intersection with the wellbore, reference kb." }, "thicknessBed": { "type": "number", "format": "float", "title": "True vertical thickness of the formation" }, "thicknessApparent": { "type": "number", "format": "float", "title": "Apparent thickness of the formation along the wellbore path" }, "thicknessPerpen": { "type": "number", "format": "float", "title": "The formation thickness perpendicular to the wellbore path" }, "dipAngle": { "type": "number", "format": "float", "title": "The inclination dip angle of the formation" }, "dipDirection": { "type": "number", "format": "float", "title": "The azimuth of the dip angle" }, "modifiedTime": { "type": "string", "format": "date-time", "description": "The date and time the formation record was created or modified." } }, "title": "Formation model based on WITSML 1.4.1.1 Formation Marker with additions", "required": [ "name", "sequenceNumber" ] }, "FrictionValueV1": { "type": "object", "properties": { "frictionFactor": { "type": "number", "format": "float" }, "frictionData": { "$ref": "#/definitions/DataValueV1" } } }, "GeoLocation": { "type": "object", "properties": { "geoLocationLat": { "type": "number", "format": "float" }, "geoLocationLong": { "type": "number", "format": "float" } }, "required": [ "geoLocationLat", "geoLocationLong" ] }, "GetAlarmConfigurationsCapabilitiesV1Response": { "type": "object", "properties": { "listAlarmConfigurations": { "$ref": "#/definitions/CapabilityV1" } } }, "GetAlarmConfigurationsV1Response": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "title": "Total number of records" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeV1" }, "title": "List of Attributes with alarm configurations" }, "alarmConfigurations": { "type": "array", "items": { "$ref": "#/definitions/AlarmConfigurationV1" }, "title": "A list of alarm configurations returned" } } }, "GetAlarmEventsCapabilitiesV1Response": { "type": "object", "properties": { "listAlarmEvents": { "$ref": "#/definitions/CapabilityV1" } } }, "GetAlarmEventsV1Response": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "title": "Total number of records" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeV1" }, "title": "List of Attributes with alarm events" }, "alarmEvents": { "type": "array", "items": { "$ref": "#/definitions/AlarmEventV1" }, "title": "A list of alarm events returned" } } }, "GetAttributesCapabilitiesV1Response": { "type": "object", "properties": { "listAttributes": { "$ref": "#/definitions/CapabilityV1" }, "listCalculatedAttributes": { "$ref": "#/definitions/CapabilityV1" }, "listRoadmapAttributes": { "$ref": "#/definitions/CapabilityV1" } } }, "GetAttributesV1Response": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeV1" } } } }, "GetBhasCapabilitiesV1Response": { "type": "object", "properties": { "getBhas": { "$ref": "#/definitions/CapabilityV1" }, "hasData": { "type": "boolean" }, "createBhas": { "$ref": "#/definitions/CapabilityV1" }, "updateBhas": { "$ref": "#/definitions/CapabilityV1" }, "deleteBhas": { "$ref": "#/definitions/CapabilityV1" }, "getBhaStats": { "$ref": "#/definitions/CapabilityV1" } }, "title": "Capability of getting all bha items" }, "GetBhasV1Response": { "type": "object", "properties": { "bhas": { "type": "array", "items": { "$ref": "#/definitions/BhaV1" } }, "activeSource": { "type": "string" } } }, "GetCalculatedAttributeByIdCapabilitiesV1Response": { "type": "object", "properties": { "updateCalculatedAttribute": { "$ref": "#/definitions/CapabilityV1" }, "deleteCalculatedAttribute": { "$ref": "#/definitions/CapabilityV1" }, "accessToDatacenterStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "accessToEdgeStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "passwordProtection": { "$ref": "#/definitions/CapabilityV1" }, "setDefaultScaleRange": { "$ref": "#/definitions/CapabilityV1" } } }, "GetCalculatedAttributeConstantByNameCapabilitiesV1Response": { "type": "object", "properties": { "updateCalculatedAttributeConstant": { "$ref": "#/definitions/CapabilityV1" }, "deleteCalculatedAttributeConstant": { "$ref": "#/definitions/CapabilityV1" }, "accessToDatacenterStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "accessToEdgeStorageLocation": { "$ref": "#/definitions/CapabilityV1" } } }, "GetCalculatedAttributeConstantsCapabilitiesV1Response": { "type": "object", "properties": { "listCalculatedAttributeConstants": { "$ref": "#/definitions/CapabilityV1" }, "createCalculatedAttributeConstant": { "$ref": "#/definitions/CapabilityV1" }, "updateCalculatedAttributeConstant": { "$ref": "#/definitions/CapabilityV1" }, "deleteCalculatedAttributeConstant": { "$ref": "#/definitions/CapabilityV1" }, "accessToDatacenterStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "accessToEdgeStorageLocation": { "$ref": "#/definitions/CapabilityV1" } } }, "GetCalculatedAttributeConstantsV1Response": { "type": "object", "properties": { "calculatedAttributeConstants": { "type": "array", "items": { "$ref": "#/definitions/CalculatedAttributeConstantV1" } } } }, "GetCalculatedAttributesCapabilitiesV1Response": { "type": "object", "properties": { "listCalculatedAttributes": { "$ref": "#/definitions/CapabilityV1" }, "createCalculatedAttribute": { "$ref": "#/definitions/CapabilityV1" }, "updateCalculatedAttribute": { "$ref": "#/definitions/CapabilityV1" }, "deleteCalculatedAttribute": { "$ref": "#/definitions/CapabilityV1" }, "accessToDatacenterStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "accessToEdgeStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "attributesCapabilities": { "type": "object", "additionalProperties": { "$ref": "#/definitions/GetCalculatedAttributeByIdCapabilitiesV1Response" } } } }, "GetCalculatedAttributesV1Response": { "type": "object", "properties": { "calculatedAttributes": { "type": "array", "items": { "$ref": "#/definitions/CalculatedAttributeV1" } } } }, "GetCasingsCapabilitiesV1Response": { "type": "object", "properties": { "getCasings": { "$ref": "#/definitions/CapabilityV1" }, "hasData": { "type": "boolean" }, "createCasings": { "$ref": "#/definitions/CapabilityV1" }, "updateCasings": { "$ref": "#/definitions/CapabilityV1" }, "deleteCasings": { "$ref": "#/definitions/CapabilityV1" } } }, "GetCasingsV1Response": { "type": "object", "properties": { "casings": { "type": "array", "items": { "$ref": "#/definitions/CasingV1" } }, "activeSource": { "type": "string" } } }, "GetConfigurationByTypeV1Response": { "type": "object", "properties": { "configuration": { "type": "string" } } }, "GetConfigurationCapabilitiesByTypeV1Response": { "type": "object", "properties": { "getConfiguration": { "$ref": "#/definitions/CapabilityV1" }, "createConfiguration": { "$ref": "#/definitions/CapabilityV1" }, "updateConfiguration": { "$ref": "#/definitions/CapabilityV1" } } }, "GetConfigurationsCapabilitiesV1Response": { "type": "object", "properties": { "getConfiguration": { "$ref": "#/definitions/CapabilityV1" }, "createConfiguration": { "$ref": "#/definitions/CapabilityV1" } } }, "GetConfigurationsV1Response": { "type": "object", "properties": { "configurations": { "type": "array", "items": { "$ref": "#/definitions/Configuration" } } } }, "GetConnectionsV1Parameters": { "type": "object", "properties": { "timeRange": { "$ref": "#/definitions/TimestampRangeV1" }, "depthUnitId": { "type": "string", "title": "Request depth units by unit id.\r\n\r\nExample: \"Depth.Meter.0\"" }, "connectionType": { "$ref": "#/definitions/GetConnectionsV1ParametersConnectionTypeV1", "description": "Filter the returned connections to the provided type" }, "sourceId": { "type": "string", "description": "The data source used for the connection calculations" }, "includeRuns": { "type": "boolean", "description": "Add the run information to the connections, using the internal kpi runs" }, "shifts": { "type": "array", "items": { "$ref": "#/definitions/ShiftV1" }, "description": "Add the shift label for each connection based on the provided shift schedule" } } }, "GetConnectionsV1ParametersConnectionTypeV1": { "type": "string", "enum": [ "Unknown", "Drilling", "Tripping" ], "default": "Unknown" }, "GetConnectionsV1Response": { "type": "object", "properties": { "bitPositionUnits": { "$ref": "#/definitions/UnitV1", "description": "Units of the bit position" }, "holeDepthUnits": { "$ref": "#/definitions/UnitV1", "description": "Units of the hole depth" }, "connections": { "type": "array", "items": { "$ref": "#/definitions/ConnectionV1" } }, "activeSource": { "type": "string" } } }, "GetCurrentSurveyCapabilitiesV1Response": { "type": "object", "properties": { "getCurrentSurveyData": { "$ref": "#/definitions/CapabilityV1", "title": "Capability of getting real-time surveys" } } }, "GetCurrentSurveyV1RequestSurveyStatusRequestV1": { "type": "string", "enum": [ "Unapproved", "Approved", "All" ], "default": "Unapproved" }, "GetCurrentTimeDataCapabilitiesV1Response": { "type": "object", "properties": { "getCurrentTimeData": { "$ref": "#/definitions/CapabilityV1" }, "createCurrentTimeData": { "$ref": "#/definitions/CapabilityV1" } } }, "GetCurrentTimeDataV1Parameters": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataRequestV1" } }, "frequency": { "type": "number", "format": "float", "description": "How often to stream aggregated rows\r\n * Note: Only 1 second frequency is currently supported" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds).\r\n * IsDifferential = true Interval \u003e= 0\r\n * IsDifferential = false Interval \u003e 0" }, "isDifferential": { "type": "boolean", "default": "false", "description": "Note: not used for non-streamed current values." } }, "required": [ "attributes", "interval" ] }, "GetCurrentTimeDataV1Response": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataResponseV1" } }, "timeRecords": { "type": "array", "items": { "$ref": "#/definitions/TimeRecordV1" } }, "frequency": { "type": "number", "format": "float", "description": "How often to stream aggregated rows\r\n * Note: Only 1 second frequency is currently supported" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds).\r\n * Note: Only interval = 0 is currently supported; the latest value for the attributes requested will be returned with no aggregation." }, "isDifferential": { "type": "boolean", "description": "Note: not used for non-streamed current values." } }, "required": [ "attributes", "timeRecords", "frequency", "interval" ] }, "GetDepthDataCapabilitiesV1Response": { "type": "object", "properties": { "getDepthData": { "$ref": "#/definitions/CapabilityV1" }, "depthIndexByTvd": { "$ref": "#/definitions/CapabilityV1" }, "depthIndexByMesuredDepth": { "$ref": "#/definitions/CapabilityV1" } } }, "GetDepthDataV1Parameters": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataRequestV1" } }, "fromDepth": { "type": "number", "format": "float" }, "toDepth": { "type": "number", "format": "float" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds).\r\n * IsDifferential = true Interval \u003e= 0\r\n * IsDifferential = false Interval \u003e 0" }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "isDifferential": { "type": "boolean", "default": "false" }, "depthUnitId": { "type": "string", "description": "The unit of measure for the depth index returned,from_depth,to_depth \u0026 interval. for example: Depth.Meter.0 or Depth.Feet.1" }, "depthIndex": { "$ref": "#/definitions/DepthIndexType", "default": "MeasuredDepth" }, "segmentId": { "type": "string", "description": "If a segment ID is provided, the API will return depth data only from the specified segment and its parent segment(s). This is done by limiting the time range processed for depth data generation to the start and end datetimes of the specified segment and its parent segment(s). Use the /api/v1/jobs/{jobID}/segments endpoint to get the segment IDs for the job." } }, "description": "Specifies the requested range of the depth data to be returned\r\n * isDifferential is not currently supported.", "required": [ "attributes", "fromDepth", "toDepth", "interval" ] }, "GetDepthDataV1Response": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataResponseV1" }, "description": "List of requested attributes. " }, "depthRecords": { "type": "array", "items": { "$ref": "#/definitions/DepthRecordV1" }, "description": "List containing all the requested depth data." }, "fromDepth": { "type": "number", "format": "float" }, "toDepth": { "type": "number", "format": "float" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds).\r\n * IsDifferential = true Interval \u003e= 0\r\n * IsDifferential = false Interval \u003e 0" }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "isDifferential": { "type": "boolean" }, "depthUnit": { "$ref": "#/definitions/UnitV1" } }, "description": "Contains the requested range of the depth data to be returned\r\n * isDifferential is not currently supported.", "required": [ "attributes", "depthRecords", "fromDepth", "toDepth", "interval" ] }, "GetDepthExportDelimitedV1Parameters": { "type": "object", "properties": { "delimiter": { "type": "string", "default": "," }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataWithPrecisionRequestV1" } }, "fromDepth": { "type": "number", "format": "float" }, "toDepth": { "type": "number", "format": "float" }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in depth units)" }, "depthUnitId": { "type": "string", "description": "The unit of measure for the depth index returned,from_depth,to_depth \u0026 interval. for example: Depth.Meter.0 or Depth.Feet.1" }, "depthPrecision": { "type": "integer", "format": "int32", "description": "The precision for the returned depth index. Note: If not specified the Hole Depth Attribute default precision is used." }, "segmentId": { "type": "string", "description": "If a segment ID is provided, the API will return depth data only from the specified segment and its parent segment(s). This is done by limiting the time range processed for depth data generation to the start and end datetimes of the specified segment and its parent segment(s). Use the /api/v1/jobs/{jobID}/segments endpoint to get the segment IDs for the job." } }, "description": "Specifies the requested range of the depth data to be exported", "required": [ "attributes", "fromDepth", "toDepth", "interval" ] }, "GetDepthExportFormatCapabilitiesV1Response": { "type": "object", "properties": { "viewDepthData": { "$ref": "#/definitions/CapabilityV1" } } }, "GetDepthExportFormatV1Parameters": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataWithPrecisionRequestV1" } }, "fromDepth": { "type": "number", "format": "float" }, "toDepth": { "type": "number", "format": "float" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in depth units)." }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "depthUnitId": { "type": "string", "description": "The unit of measure for the depth index returned,from_depth,to_depth \u0026 interval. for example: Depth.Meter.0 or Depth.Feet.1" }, "depthPrecision": { "type": "integer", "format": "int32", "description": "The precision for the returned depth index. Note: If not specified the Hole Depth Attribute default precision is used." }, "segmentId": { "type": "string", "description": "If a segment ID is provided, the API will return depth data only from the specified segment and its parent segment(s). This is done by limiting the time range processed for depth data generation to the start and end datetimes of the specified segment and its parent segment(s). Use the /api/v1/jobs/{jobID}/segments endpoint to get the segment IDs for the job." } }, "description": "Specifies the requested range of the depth data to be exported", "required": [ "attributes", "fromDepth", "toDepth", "interval" ] }, "GetDepthExportFormatsCabilitiesV1Response": { "type": "object", "properties": { "listFormats": { "$ref": "#/definitions/CapabilityV1" } } }, "GetDepthExportFormatsV1Response": { "type": "object", "properties": { "formats": { "type": "array", "items": { "type": "string" } } } }, "GetEquivalentMudWeightCapabilitiesV1Response": { "type": "object", "properties": { "getEquivalentMudWeights": { "$ref": "#/definitions/CapabilityV1" }, "saveEquivalentMudWeights": { "$ref": "#/definitions/CapabilityV1" } } }, "GetEquivalentMudWeightV1Response": { "type": "object", "properties": { "equivalentMudWeightPoints": { "type": "array", "items": { "$ref": "#/definitions/DepthRecordV1" } }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeBaseV1" } } } }, "GetFormationsCapabilitiesV1Response": { "type": "object", "properties": { "getFormations": { "$ref": "#/definitions/CapabilityV1" }, "hasData": { "type": "boolean" }, "createFormations": { "$ref": "#/definitions/CapabilityV1" }, "updateFormations": { "$ref": "#/definitions/CapabilityV1" }, "deleteFormations": { "$ref": "#/definitions/CapabilityV1" } }, "title": "GetFormationsCapabilitiesV1Response" }, "GetFormationsV1Response": { "type": "object", "properties": { "depthUnits": { "$ref": "#/definitions/UnitV1" }, "angleUnits": { "$ref": "#/definitions/UnitV1" }, "formations": { "type": "array", "items": { "$ref": "#/definitions/FormationV1" } }, "activeSource": { "type": "string" } }, "title": "GetFormationsV1Response" }, "GetHistoricalTimeDataCapabilitiesV1Response": { "type": "object", "properties": { "getHistoricalTimeData": { "$ref": "#/definitions/CapabilityV1" } } }, "GetJobsCapabilitiesV1Response": { "type": "object", "properties": { "listJobs": { "$ref": "#/definitions/CapabilityV1" } } }, "GetJobsV1Response": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32", "title": "Total number of records" }, "jobs": { "type": "array", "items": { "$ref": "#/definitions/JobV1" }, "title": "A list of jobs returned" } } }, "GetMetaCapabilitiesByKeyV1Response": { "type": "object", "properties": { "updateMeta": { "$ref": "#/definitions/CapabilityV1" }, "deleteMeta": { "$ref": "#/definitions/CapabilityV1" }, "viewMeta": { "$ref": "#/definitions/CapabilityV1" } } }, "GetMetaCapabilitiesV1Response": { "type": "object", "properties": { "listMeta": { "$ref": "#/definitions/CapabilityV1" }, "createMeta": { "$ref": "#/definitions/CapabilityV1" } } }, "GetMetaV1Response": { "type": "object", "properties": { "metaData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "List of key/value pairs from meta data." }, "total": { "type": "integer", "format": "int32", "title": "Total records" } } }, "GetMudCheckCapabilitiesV1Response": { "type": "object", "properties": { "getMudChecks": { "$ref": "#/definitions/CapabilityV1" }, "hasData": { "type": "boolean" }, "createMudChecks": { "$ref": "#/definitions/CapabilityV1" }, "updateMudChecks": { "$ref": "#/definitions/CapabilityV1" }, "deleteMudChecks": { "$ref": "#/definitions/CapabilityV1" } }, "title": "MudCheck capabilities response" }, "GetMudCheckV1Response": { "type": "object", "properties": { "mudChecks": { "type": "array", "items": { "$ref": "#/definitions/MudCheckV1" } }, "total": { "type": "integer", "format": "int32" }, "activeSource": { "type": "string" } }, "title": "MudCheck response" }, "GetMudPumpsCapabilitiesV1Response": { "type": "object", "properties": { "getMudPumps": { "$ref": "#/definitions/CapabilityV1" }, "hasData": { "type": "boolean" }, "createMudPumps": { "$ref": "#/definitions/CapabilityV1" }, "updateMudPumps": { "$ref": "#/definitions/CapabilityV1" }, "deleteMudPumps": { "$ref": "#/definitions/CapabilityV1" } }, "title": "Mud pump capabilities response" }, "GetMudPumpsV1Response": { "type": "object", "properties": { "mudPumps": { "type": "array", "items": { "$ref": "#/definitions/MudPumpV1" } }, "activeSource": { "type": "string" } }, "title": "Mud pump response" }, "GetNextDeletedReportV1Response": { "type": "object", "properties": { "nextDeletedReportKey": { "type": "string" }, "reportId": { "type": "string" } } }, "GetNotesCapabilitiesV1Response": { "type": "object", "properties": { "viewNotes": { "$ref": "#/definitions/CapabilityV1" }, "createNotes": { "$ref": "#/definitions/CapabilityV1" }, "updateNotes": { "$ref": "#/definitions/CapabilityV1" }, "deleteNotes": { "$ref": "#/definitions/CapabilityV1" }, "addEventAdviceNotes": { "$ref": "#/definitions/CapabilityV1" } } }, "GetNotesChangesCapabilitiesV1Response": { "type": "object", "properties": { "viewNotesChanges": { "$ref": "#/definitions/CapabilityV1", "title": "Capability for viewing note changes" } } }, "GetNotesV1Response": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "depthUnit": { "$ref": "#/definitions/UnitV1" }, "notes": { "type": "array", "items": { "$ref": "#/definitions/NoteV1" } } }, "required": [ "notes", "depthUnit" ] }, "GetPressureModelsCapabilitiesV1Response": { "type": "object", "properties": { "getPressureModels": { "$ref": "#/definitions/CapabilityV1" }, "hasData": { "type": "boolean" }, "createPressureModels": { "$ref": "#/definitions/CapabilityV1" }, "updatePressureModels": { "$ref": "#/definitions/CapabilityV1" }, "deletePressureModels": { "$ref": "#/definitions/CapabilityV1" } }, "title": "DeletePressureModelsCapabilitiesV1Response" }, "GetPressureModelsV1Response": { "type": "object", "properties": { "depthUnits": { "$ref": "#/definitions/UnitV1" }, "pressureUnits": { "$ref": "#/definitions/UnitV1" }, "densityUnits": { "$ref": "#/definitions/UnitV1" }, "activeSource": { "type": "string" }, "pressureModels": { "type": "array", "items": { "$ref": "#/definitions/PressureModelV1" } } }, "title": "GetPressureModelsV1Response" }, "GetReportClassificationsV1Response": { "type": "object", "properties": { "reportClassifications": { "type": "array", "items": { "type": "string" } } } }, "GetReportFormatsV1Response": { "type": "object", "properties": { "availableFormats": { "type": "array", "items": { "$ref": "#/definitions/AvailableReportFormatV1" } } } }, "GetReportGroupV1Response": { "type": "object", "properties": { "id": { "type": "string" }, "availableReports": { "type": "array", "items": { "$ref": "#/definitions/ReportV1" } }, "availableFormats": { "type": "array", "items": { "$ref": "#/definitions/ReportFormatV1" } }, "availableSubReports": { "type": "array", "items": { "$ref": "#/definitions/SubReportV1" } }, "reportSource": { "type": "string" } } }, "GetReportGroupsV1Response": { "type": "object", "properties": { "reportGroups": { "type": "array", "items": { "$ref": "#/definitions/ReportGroupsV1" } } } }, "GetReportV1Parameters": { "type": "object", "properties": { "reportSubTypeId": { "type": "string" }, "reportIds": { "$ref": "#/definitions/ReportIdsV1" }, "reportDates": { "$ref": "#/definitions/ReportDatesV1" }, "pageCount": { "type": "integer", "format": "int32" } } }, "GetRigsCapabilitiesV1Response": { "type": "object", "properties": { "getRigs": { "$ref": "#/definitions/CapabilityV1" }, "hasData": { "type": "boolean" }, "createRigs": { "$ref": "#/definitions/CapabilityV1" }, "updateRigs": { "$ref": "#/definitions/CapabilityV1" }, "deleteRigs": { "$ref": "#/definitions/CapabilityV1" } }, "title": "Capability of getting the rig" }, "GetRigsV1Response": { "type": "object", "properties": { "rigs": { "type": "array", "items": { "$ref": "#/definitions/RigV1" }, "title": "Rig returned" }, "activeSource": { "type": "string" } } }, "GetRoadmapAttributeByIdCapabilitiesV1Response": { "type": "object", "properties": { "viewRoadmapAttributeIntervals": { "$ref": "#/definitions/CapabilityV1" }, "updateRoadmapAttribute": { "$ref": "#/definitions/CapabilityV1" }, "deleteRoadmapAttribute": { "$ref": "#/definitions/CapabilityV1" }, "accessToDatacenterStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "accessToEdgeStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "setDefaultScaleRange": { "$ref": "#/definitions/CapabilityV1" } } }, "GetRoadmapAttributeIntervalsV1Response": { "type": "object", "properties": { "roadmapAttributeIntervals": { "type": "array", "items": { "$ref": "#/definitions/RoadmapAttributeIntervalV1" } } } }, "GetRoadmapAttributesCapabilitiesV1Response": { "type": "object", "properties": { "viewRoadmapAttributes": { "$ref": "#/definitions/CapabilityV1" }, "viewRoadmapAttributeIntervals": { "$ref": "#/definitions/CapabilityV1" }, "createRoadmapAttribute": { "$ref": "#/definitions/CapabilityV1" }, "updateRoadmapAttribute": { "$ref": "#/definitions/CapabilityV1" }, "deleteRoadmapAttribute": { "$ref": "#/definitions/CapabilityV1" }, "accessToDatacenterStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "accessToEdgeStorageLocation": { "$ref": "#/definitions/CapabilityV1" }, "attributesCapabilities": { "type": "object", "additionalProperties": { "$ref": "#/definitions/GetRoadmapAttributeByIdCapabilitiesV1Response" } } } }, "GetRoadmapAttributesV1Response": { "type": "object", "properties": { "roadmapAttributes": { "type": "array", "items": { "$ref": "#/definitions/RoadmapAttributeV1" } } } }, "GetRunsByJobV1RequestRunTypeV1": { "type": "string", "enum": [ "Unknown", "Casing", "Bha" ], "default": "Unknown" }, "GetRunsByJobV1Response": { "type": "object", "properties": { "runs": { "type": "array", "items": { "$ref": "#/definitions/RunV1" } }, "activeSource": { "type": "string" }, "depthUnits": { "$ref": "#/definitions/UnitV1", "title": "Units for the depth values returned in the runs response." } } }, "GetRunsCapabilitiesV1Response": { "type": "object", "properties": { "getRuns": { "$ref": "#/definitions/CapabilityV1", "title": "Capability of getting all runs" } } }, "GetSectionsByJobV1Response": { "type": "object", "properties": { "holeDepthUnits": { "$ref": "#/definitions/UnitV1" }, "holeSizeUnits": { "$ref": "#/definitions/UnitV1" }, "sections": { "type": "array", "items": { "$ref": "#/definitions/SectionV1" } }, "activeSource": { "type": "string" } } }, "GetSectionsCapabilitiesV1Response": { "type": "object", "properties": { "getSections": { "$ref": "#/definitions/CapabilityV1" } } }, "GetSegmentByIdV1Response": { "type": "object", "properties": { "segment": { "$ref": "#/definitions/SegmentV1" } }, "description": "Response for Get Segment by Id Request " }, "GetSegmentCapabilitiesV1Response": { "type": "object", "properties": { "getSegment": { "$ref": "#/definitions/CapabilityV1" }, "updateSegment": { "$ref": "#/definitions/CapabilityV1" }, "deleteSegment": { "$ref": "#/definitions/CapabilityV1" } }, "description": "Individual Segment Capability Response" }, "GetSegmentsByJobV1Response": { "type": "object", "properties": { "segments": { "type": "array", "items": { "$ref": "#/definitions/SegmentV1" } } }, "description": "Response for Get All Segments Request " }, "GetSegmentsCapabilitiesV1Response": { "type": "object", "properties": { "getSegments": { "$ref": "#/definitions/CapabilityV1" }, "createSegment": { "$ref": "#/definitions/CapabilityV1" }, "updateSegment": { "$ref": "#/definitions/CapabilityV1" }, "deleteSegment": { "$ref": "#/definitions/CapabilityV1" } }, "description": "Get All Segments capabilities response" }, "GetSummaryReportTypesV1Response": { "type": "object", "properties": { "summaryReportTypes": { "type": "array", "items": { "$ref": "#/definitions/SummaryReportTypeV1" } } } }, "GetSummaryReportV1Parameters": { "type": "object", "properties": { "timeRange": { "$ref": "#/definitions/TimestampRangeV1", "description": "Only applicable to activity details reports" } } }, "GetSummaryReportsV1Response": { "type": "object", "properties": { "summaryReports": { "type": "array", "items": { "$ref": "#/definitions/SummaryReportV1" } } } }, "GetSurveyModelsCapabilitiesV1Response": { "type": "object", "properties": { "getSurveyModels": { "$ref": "#/definitions/CapabilityV1", "title": "Capability of getting all surveys" } } }, "GetSurveysCapabilitiesV1Response": { "type": "object", "properties": { "getSurveysData": { "$ref": "#/definitions/CapabilityV1", "title": "Capability of getting all surveys" }, "createSurveysData": { "$ref": "#/definitions/CapabilityV1" } } }, "GetSurveysV1RequestSurveyStatusRequestV1": { "type": "string", "enum": [ "Unapproved", "Approved", "All" ], "default": "Unapproved" }, "GetTimeDataV1Parameters": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataRequestV1" } }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds).\r\n * IsDifferential = true Interval \u003e= 0\r\n * IsDifferential = false Interval \u003e 0" }, "isDifferential": { "type": "boolean", "default": "false" } }, "description": "Specifies the requested range of the time data to be returned", "required": [ "attributes", "fromTime", "toTime", "interval" ] }, "GetTimeDataV1Response": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataResponseV1" }, "description": "List of returned attributes" }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds).\r\n * IsDifferential = true Interval \u003e= 0\r\n * IsDifferential = false Interval \u003e 0" }, "timeRecords": { "type": "array", "items": { "$ref": "#/definitions/TimeRecordV1" } }, "isDifferential": { "type": "boolean" } }, "description": "Contains the requested range of the time data to be returned", "required": [ "attributes", "fromTime", "toTime", "interval", "timeRecords" ] }, "GetTimeEventsCapabilitiesV1Response": { "type": "object", "properties": { "getEvents": { "$ref": "#/definitions/CapabilityV1" } } }, "GetTimeEventsV1Parameters": { "type": "object", "properties": { "outputAttributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataRequestV1" } }, "timeRange": { "$ref": "#/definitions/TimestampRangeV1" }, "filter": { "$ref": "#/definitions/FilterRequestV1" } }, "description": "Specifies the requested range of the time data to be returned, including the 'from' and 'to' time", "required": [ "filter", "timeRange" ] }, "GetTimeEventsV1Response": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataResponseV1" }, "description": "List of returned attributes" }, "filter": { "$ref": "#/definitions/FilterDataV1" }, "events": { "type": "array", "items": { "$ref": "#/definitions/EventDataV1" } } } }, "GetTimeExportDelimitedV1Parameters": { "type": "object", "properties": { "delimiter": { "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataWithPrecisionRequestV1" } }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds)" } }, "description": "Specifies the requested range of the time data to be returned", "required": [ "attributes", "fromTime", "toTime", "interval" ] }, "GetTimeExportFormatCapabilitiesV1Response": { "type": "object", "properties": { "viewTimeData": { "$ref": "#/definitions/CapabilityV1" } } }, "GetTimeExportFormatV1Parameters": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeDataWithPrecisionRequestV1" } }, "fromTime": { "type": "string", "format": "date-time" }, "toTime": { "type": "string", "format": "date-time" }, "interval": { "type": "number", "format": "float", "description": "Aggregation interval (in seconds)" } }, "description": "Specifies the requested range of the time data to be returned", "required": [ "attributes", "fromTime", "toTime", "interval" ] }, "GetTimeExportFormatsCapabilitiesV1Response": { "type": "object", "properties": { "listFormats": { "$ref": "#/definitions/CapabilityV1" } } }, "GetTimeExportFormatsV1Response": { "type": "object", "properties": { "formats": { "type": "array", "items": { "type": "string" } } } }, "GetTimeOffsetsCapabilitiesV1Response": { "type": "object", "properties": { "getTimeOffsets": { "$ref": "#/definitions/CapabilityV1" } } }, "GetTimeOffsetsV1Response": { "type": "object", "properties": { "timeoffsets": { "type": "array", "items": { "type": "string", "format": "date-time" } } } }, "GetTimeSummaryCapabilitiesV1Response": { "type": "object", "properties": { "getTimeSummary": { "$ref": "#/definitions/CapabilityV1" } } }, "GetTimeSummaryV1Response": { "type": "object", "properties": { "attributeId": { "type": "string", "description": "The ID of the summarized attribute." }, "interval": { "type": "number", "format": "float", "description": "The time period summarized, in seconds." }, "timestamp": { "type": "string", "format": "date-time", "description": "The date and time the summary was made." }, "summarizedValues": { "type": "object", "additionalProperties": { "type": "number", "format": "float" }, "description": "Time spent at each value, in seconds, grouped by the attribute's value." } }, "required": [ "attributeId", "interval", "timestamp", "summarizedValues" ] }, "GetTokenV1Response": { "type": "object", "properties": { "token": { "type": "string" } } }, "GetTorqueDragModelsByJobV1RequestParameters": { "type": "object", "properties": { "source": { "type": "string", "example": "Sentinel", "default": "\"Sentinel\"" }, "runId": { "type": "string", "example": "100" } }, "required": [ "runId" ] }, "GetTorqueDragModelsByJobV1Response": { "type": "object", "properties": { "models": { "type": "array", "items": { "$ref": "#/definitions/TorqueDragModelPointV1" } } } }, "GetTorqueDragModelsCapabilitiesV1Response": { "type": "object", "properties": { "getTorqueDragModels": { "$ref": "#/definitions/CapabilityV1" }, "updateTorqueDragModels": { "$ref": "#/definitions/CapabilityV1" } } }, "GetTorqueDragRunDataByJobV1RequestParameters": { "type": "object", "properties": { "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "source": { "type": "string", "example": "Sentinel", "default": "\"Sentinel\"", "title": "'Sentinel', Should support multiple sources, but for now only Sentinel" } } }, "GetTorqueDragRunDataByJobV1Response": { "type": "object", "properties": { "runOutputPoints": { "type": "array", "items": { "$ref": "#/definitions/TimeRecordV1" } }, "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeV1" } } } }, "GetTorqueDragRunDataCapabilitiesV1Response": { "type": "object", "properties": { "getTorqueDragRunData": { "$ref": "#/definitions/CapabilityV1", "title": "Capability of getting all run data" } } }, "GetTripSpeedModelCapabilitiesV1Response": { "type": "object", "properties": { "getTripSpeedModel": { "$ref": "#/definitions/CapabilityV1" } } }, "GetTripSpeedModelV1Parameters": { "type": "object", "properties": { "targetMudWeight": { "type": "number", "format": "float" } }, "description": "Specifies the targeted mud weight to build the tripping speed model.", "required": [ "targetMudWeight" ] }, "GetTripSpeedModelV1Response": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/AttributeBaseV1" } }, "tripSpeedPoints": { "type": "array", "items": { "$ref": "#/definitions/TripSpeedValueV1" } } } }, "GetUnitDefinitionsCapabilitiesV1Response": { "type": "object", "properties": { "getUnitDefinitions": { "$ref": "#/definitions/CapabilityV1" } } }, "GetUnitDefinitionsV1Response": { "type": "object", "properties": { "unitGroups": { "type": "array", "items": { "$ref": "#/definitions/UnitGroupV1" } } }, "required": [ "unitGroups" ] }, "GetUploadedFileCapabilitiesV1Response": { "type": "object", "properties": { "getUploadedFile": { "$ref": "#/definitions/CapabilityV1" }, "updateUploadedFile": { "$ref": "#/definitions/CapabilityV1" }, "deleteUploadedFile": { "$ref": "#/definitions/CapabilityV1" } }, "description": "Individual Uploaded File Capability Response" }, "GetUploadedFilesCapabilitiesV1Response": { "type": "object", "properties": { "getUploadedFiles": { "$ref": "#/definitions/CapabilityV1" }, "createUploadedFiles": { "$ref": "#/definitions/CapabilityV1" }, "updateUploadedFiles": { "$ref": "#/definitions/CapabilityV1" }, "deleteUploadedFiles": { "$ref": "#/definitions/CapabilityV1" } }, "description": "Get All uploaded files capabilities response" }, "GetUploadedFilesPropertiesV1Response": { "type": "object", "properties": { "uploadedFilesProperties": { "type": "array", "items": { "$ref": "#/definitions/UploadedFilePropertiesV1" } }, "returnedCount": { "type": "integer", "format": "int32" } } }, "JobAssetInfoTypeV1": { "type": "string", "enum": [ "Rig", "MudPump" ], "default": "Rig" }, "JobAssetInfoV1": { "type": "object", "properties": { "id": { "type": "string" }, "parentAssetId": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/definitions/JobAssetInfoTypeV1" }, "source": { "type": "string" }, "owner": { "type": "string", "title": "This is the equivalent to contractor" }, "division": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" } }, "required": [ "id", "name", "type", "owner" ] }, "JobCapabilities": { "type": "object", "properties": { "updateJob": { "$ref": "#/definitions/CapabilityV1" }, "deleteJob": { "$ref": "#/definitions/CapabilityV1" }, "viewJob": { "$ref": "#/definitions/CapabilityV1" }, "historicalData": { "$ref": "#/definitions/CapabilityV1" }, "realTime": { "$ref": "#/definitions/CapabilityV1" }, "torqueDrag": { "$ref": "#/definitions/CapabilityV1" }, "survey": { "$ref": "#/definitions/CapabilityV1" }, "drillingBeliefsAnalytics": { "$ref": "#/definitions/CapabilityV1" }, "viewBhas": { "$ref": "#/definitions/CapabilityV1" }, "viewCasings": { "$ref": "#/definitions/CapabilityV1" }, "viewMudChecks": { "$ref": "#/definitions/CapabilityV1" }, "viewMudPumps": { "$ref": "#/definitions/CapabilityV1" }, "viewRigs": { "$ref": "#/definitions/CapabilityV1" }, "alarmHistory": { "$ref": "#/definitions/CapabilityV1" }, "swabSurge": { "$ref": "#/definitions/CapabilityV1" }, "listReports": { "$ref": "#/definitions/CapabilityV1" }, "viewAlarms": { "$ref": "#/definitions/CapabilityV1" }, "downholeBroadbandSolution": { "$ref": "#/definitions/CapabilityV1" }, "viewFormations": { "$ref": "#/definitions/CapabilityV1" }, "viewPressureModels": { "$ref": "#/definitions/CapabilityV1" }, "viewActivitySummary": { "$ref": "#/definitions/CapabilityV1" }, "manageAudibleAlarms": { "$ref": "#/definitions/CapabilityV1" } } }, "JobReportsCapabililtiesV1": { "type": "object", "properties": { "listClassificationReports": { "$ref": "#/definitions/CapabilityV1" }, "getSummaryReports": { "$ref": "#/definitions/CapabilityV1" } } }, "JobSiteInfoV1": { "type": "object", "properties": { "owner": { "type": "string", "title": "This is the equivalent to operator" }, "padName": { "type": "string" }, "geoLocation": { "$ref": "#/definitions/GeoLocation" }, "province": { "type": "string" } }, "required": [ "owner" ] }, "JobStatusRequestV1": { "type": "string", "enum": [ "ActiveJobs", "AllJobs", "EndedJobs", "UnendedJobs" ], "default": "ActiveJobs", "description": "- ActiveJobs: Default value if not provided, Jobs that are still active (unreleased and last drilled on their rig)\n - AllJobs: All jobs\n - EndedJobs: Jobs that have finished or ended\n - UnendedJobs: Jobs that have not ended. Includes active jobs and unverified ended jobs.", "title": "JobStatusRequestV1" }, "JobStatusV1": { "type": "string", "enum": [ "Active", "Ended" ], "default": "Active", "description": "- Active: Jobs that are still active\n - Ended: Jobs that have finished or ended", "title": "JobStatusV1" }, "JobTypeV1": { "type": "string", "enum": [ "Drilling" ], "default": "Drilling" }, "JobV1": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/JobTypeV1" }, "name": { "type": "string" }, "assetInfoList": { "type": "array", "items": { "$ref": "#/definitions/JobAssetInfoV1" } }, "siteInfoList": { "type": "array", "items": { "$ref": "#/definitions/JobSiteInfoV1" } }, "startDate": { "type": "string", "format": "date-time", "example": "2021-07-06 5:13:48 PM" }, "endDate": { "type": "string", "format": "date-time", "example": "2021-08-15 12:45:03 AM" }, "firstDataDate": { "type": "string", "format": "date-time", "example": "2005-12-25 09:16:18 AM" }, "lastDataDate": { "type": "string", "format": "date-time", "example": "2017-03-17 2:28:35 PM" }, "jobNumber": { "type": "string" }, "jobStatus": { "$ref": "#/definitions/JobStatusV1" }, "drillingProperties": { "$ref": "#/definitions/DrillingPropertiesV1" }, "capabilities": { "$ref": "#/definitions/JobCapabilities" }, "alias": { "type": "object", "example": { "uidWell": "13127964-106a-406b-aea5-3c8913dc0d2d", "other_alias": "string" }, "additionalProperties": { "type": "string" } }, "latestReports": { "type": "object", "example": { "Morning report": { "date": "2025-09-15 05:13:48 AM" }, "Tour Sheet": { "date": "2025-09-16 13:13:48 PM" } }, "additionalProperties": { "$ref": "#/definitions/ReportPropertiesV1" } }, "componentVersions": { "type": "array", "example": [ { "key": "RigSenseVersion", "value": "4.31.0.0" }, { "key": "RMSVersion", "value": "1.4.0" } ], "items": { "$ref": "#/definitions/VersionPair" }, "description": "List of component versions for this job. Each VersionPair has the component name in 'key' and the version string in 'value'." } }, "description": "- If either 'firstDataDate' or 'lastDataDate' are present in the response, so should the other. We should never see 'firstDataDate' alone or 'lastDataDate' alone\r\n- For jobs in 'Active' status, 'startDate' should not be null in the response", "title": "JobV1", "required": [ "id", "type", "name", "jobStatus" ] }, "MudCheckV1": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/definitions/MudCheckV1MudTypeV1" }, "modifiedTime": { "type": "string", "format": "date-time" }, "mudCheckTime": { "type": "string", "format": "date-time" }, "density": { "$ref": "#/definitions/DataValueV1" }, "plasticViscosity": { "$ref": "#/definitions/DataValueV1" }, "yieldPoint": { "$ref": "#/definitions/DataValueV1" }, "source": { "type": "string" }, "description": { "type": "string" }, "locationSample": { "$ref": "#/definitions/MudCheckV1LocationSampleTypeV1" }, "measuredDepth": { "$ref": "#/definitions/DataValueV1" }, "trueVerticalDepth": { "$ref": "#/definitions/DataValueV1" }, "equivalentCirculatingDensity": { "$ref": "#/definitions/DataValueV1" }, "kickToleranceVolume": { "$ref": "#/definitions/DataValueV1" }, "kickToleranceIntensity": { "$ref": "#/definitions/DataValueV1" }, "tempFlowLine": { "$ref": "#/definitions/DataValueV1" }, "blowOutPreventerMaximumPressureRating": { "$ref": "#/definitions/DataValueV1" }, "funnelViscosity": { "$ref": "#/definitions/DataValueV1" }, "funnelViscosityTemperature": { "$ref": "#/definitions/DataValueV1" }, "gel10Sec": { "$ref": "#/definitions/DataValueV1" }, "gel10Min": { "$ref": "#/definitions/DataValueV1" }, "gel30Min": { "$ref": "#/definitions/DataValueV1" }, "filterCakeLowTemperatureLowPressure": { "$ref": "#/definitions/DataValueV1" }, "filtrateLowTemperatureLowPressure": { "$ref": "#/definitions/DataValueV1" }, "temperatureHighTemperatureHighPressure": { "$ref": "#/definitions/DataValueV1" }, "pressureHighTemperatureHighPressure": { "$ref": "#/definitions/DataValueV1" }, "filtrateHighTemperatureHighPressure": { "$ref": "#/definitions/DataValueV1" }, "filterCakeHighTemperatureHighPressure": { "$ref": "#/definitions/DataValueV1" }, "solidsPercentage": { "$ref": "#/definitions/DataValueV1" }, "waterPercentage": { "$ref": "#/definitions/DataValueV1" }, "oilPercentage": { "$ref": "#/definitions/DataValueV1" }, "sandPercentage": { "$ref": "#/definitions/DataValueV1" }, "solidsLowGravityPercentage": { "$ref": "#/definitions/DataValueV1" }, "solidsLowGravityContent": { "$ref": "#/definitions/DataValueV1" }, "solidsCalculatedPercentage": { "$ref": "#/definitions/DataValueV1" }, "baritePercentage": { "$ref": "#/definitions/DataValueV1" }, "lostCirculationMaterial": { "$ref": "#/definitions/DataValueV1" }, "methyleneBlueTitration": { "$ref": "#/definitions/DataValueV1" }, "ph": { "$ref": "#/definitions/DataValueV1" }, "phMeasurementTemperature": { "$ref": "#/definitions/DataValueV1" }, "wholeMudPhenolphthaleinAlkalinity": { "$ref": "#/definitions/DataValueV1" }, "mudFiltratePhenolphthaleinAlkalinity": { "$ref": "#/definitions/DataValueV1" }, "filtrateMethylOrangeAlkalinity": { "$ref": "#/definitions/DataValueV1" }, "alkalinityP1": { "$ref": "#/definitions/DataValueV1" }, "alkalinityP2": { "$ref": "#/definitions/DataValueV1" }, "chloride": { "$ref": "#/definitions/DataValueV1" }, "calcium": { "$ref": "#/definitions/DataValueV1" }, "magnesium": { "$ref": "#/definitions/DataValueV1" }, "potassium": { "$ref": "#/definitions/DataValueV1" }, "brinePercentage": { "$ref": "#/definitions/DataValueV1" }, "brineDensity": { "$ref": "#/definitions/DataValueV1" }, "lime": { "$ref": "#/definitions/DataValueV1" }, "electStab": { "$ref": "#/definitions/DataValueV1" }, "calciumChloridePercentage": { "$ref": "#/definitions/DataValueV1" }, "calciumChloride": { "$ref": "#/definitions/DataValueV1" }, "company": { "type": "string" }, "engineer": { "type": "string" }, "averageSpecificGravity": { "$ref": "#/definitions/DataValueV1" }, "solidsHighGravityPercentage": { "$ref": "#/definitions/DataValueV1" }, "solidsHighGravity": { "$ref": "#/definitions/DataValueV1" }, "polymer": { "$ref": "#/definitions/DataValueV1" }, "polymerType": { "type": "string" }, "solidsCorrectedChloridePercent": { "$ref": "#/definitions/DataValueV1" }, "oilOnCuttings": { "$ref": "#/definitions/DataValueV1" }, "oilOnDriedCuttings": { "$ref": "#/definitions/DataValueV1" }, "calciumHardnessTotal": { "$ref": "#/definitions/DataValueV1" }, "sulfide": { "$ref": "#/definitions/DataValueV1" }, "drillCuttingsAverageSize": { "$ref": "#/definitions/DataValueV1" }, "carbonate": { "$ref": "#/definitions/DataValueV1" }, "iron": { "$ref": "#/definitions/DataValueV1" }, "metalRecovered": { "$ref": "#/definitions/DataValueV1" }, "turbidity": { "$ref": "#/definitions/DataValueV1" }, "oilGrease": { "$ref": "#/definitions/DataValueV1" }, "salt": { "$ref": "#/definitions/DataValueV1" }, "saltPercentage": { "$ref": "#/definitions/DataValueV1" }, "trueCrystallizationTemperature": { "$ref": "#/definitions/DataValueV1" }, "waterPhaseSalinity": { "$ref": "#/definitions/DataValueV1" }, "wholeMudCalcium": { "$ref": "#/definitions/DataValueV1" }, "wholeMudChloride": { "$ref": "#/definitions/DataValueV1" }, "zincOxide": { "$ref": "#/definitions/DataValueV1" }, "sodiumChloride": { "$ref": "#/definitions/DataValueV1" }, "sodiumChloridePercentage": { "$ref": "#/definitions/DataValueV1" }, "comments": { "type": "string" } }, "title": "Mud check" }, "MudCheckV1LocationSampleTypeV1": { "type": "string", "enum": [ "OtherSample", "Suction", "Return", "Active", "Reserve", "TripTank", "StripTank", "Pits", "Slug" ], "default": "OtherSample", "title": "LocationSampleTypeV1" }, "MudCheckV1MudTypeV1": { "type": "string", "enum": [ "Other", "WaterBased", "OilBased", "Pneumatic", "SyntheticBased" ], "default": "Other", "title": "MudTypeV1" }, "MudPumpCheckV1": { "type": "object", "properties": { "id": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" }, "mudPumpCheckTime": { "type": "string", "format": "date-time" }, "efficiency": { "$ref": "#/definitions/DataValueV1" } }, "title": "Mud pump check" }, "MudPumpOperationV1": { "type": "object", "properties": { "id": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "linerSize": { "$ref": "#/definitions/DataValueV1" } }, "title": "Mud pump operation" }, "MudPumpV1": { "type": "object", "properties": { "jobAsset": { "$ref": "#/definitions/JobAssetInfoV1" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "strokeLength": { "$ref": "#/definitions/DataValueV1" }, "mudPumpChecks": { "type": "array", "items": { "$ref": "#/definitions/MudPumpCheckV1" } }, "mudPumpOperations": { "type": "array", "items": { "$ref": "#/definitions/MudPumpOperationV1" } }, "displacement": { "$ref": "#/definitions/DataValueV1" }, "source": { "type": "string" }, "pumpNumber": { "type": "string" } }, "title": "Mud pump" }, "NextDeletedReportCapabilitiesV1": { "type": "object", "properties": { "getNextDeletedReport": { "$ref": "#/definitions/CapabilityV1" } } }, "NextReportCapabilitiesV1": { "type": "object", "properties": { "getNextReport": { "$ref": "#/definitions/CapabilityV1" } } }, "NoteChangeV1Response": { "type": "object", "properties": { "type": { "$ref": "#/definitions/NoteChangeV1ResponseType" }, "note": { "$ref": "#/definitions/NoteV1" }, "id": { "type": "string" } }, "description": "The content of the response is determined by the type and will be one of note for create and update and id for delete", "required": [ "type" ] }, "NoteChangeV1ResponseType": { "type": "string", "enum": [ "Create", "Update", "Delete" ], "default": "Create" }, "NoteV1": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "depth": { "type": "number", "format": "float" }, "type": { "$ref": "#/definitions/NoteV1Type" }, "source": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "text", "timestamp", "type" ] }, "NoteV1Type": { "type": "string", "enum": [ "None", "Time", "Depth" ], "default": "None" }, "NullValueConversionV1": { "type": "string", "enum": [ "NoAction", "ToZeroOnAddSubtract", "ToOneOnMultiplyDivide", "All" ], "default": "NoAction", "description": "- NoAction: Do nothing\n - ToZeroOnAddSubtract: Convert null value (NaN) to 0 for addition or subtraction\n - ToOneOnMultiplyDivide: Convert null value (NaN) to 1 for multiplication or division\n - All: Convert null values (NaN) to 0 for addition or subtraction and to 1 for multiplication or division", "title": "Rules for handling null values in calculated expressions" }, "PressureModelPointV1": { "type": "object", "properties": { "id": { "type": "string" }, "trueVerticalDepth": { "type": "number", "format": "float" }, "measuredDepth": { "type": "number", "format": "float" }, "pressure": { "type": "number", "format": "float", "description": "The pressure value at that depth, if given on create or update is used." }, "emw": { "type": "number", "format": "float", "description": "The equivalent mud weight, on create or update value ignored if pressure is present." }, "comment": { "type": "string" }, "modifiedTime": { "type": "string", "format": "date-time" } }, "title": "PressureModelPointV1", "required": [ "trueVerticalDepth" ] }, "PressureModelTypeV1": { "type": "string", "enum": [ "PorePressure", "FracturePressure", "BoreholeBreakout", "Lithostatic" ], "default": "PorePressure", "title": "Pressure model types" }, "PressureModelV1": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "source": { "type": "string" }, "modelType": { "$ref": "#/definitions/PressureModelTypeV1" }, "description": { "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/definitions/PressureModelPointV1" } } }, "title": "A pressure model", "required": [ "name", "source", "points", "modelType" ] }, "ReportDatesV1": { "type": "object", "properties": { "reportDates": { "type": "array", "items": { "type": "string", "format": "date-time" } } } }, "ReportFilesCapabilitiesV1": { "type": "object", "properties": { "getReport": { "$ref": "#/definitions/CapabilityV1" } } }, "ReportFormatV1": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "pageCounts": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "ReportGroupsV1": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "total": { "type": "integer", "format": "int32" } } }, "ReportIdsV1": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "ReportPropertiesV1": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "title": "string link = 2;" } }, "description": "Report Properties will be returned if job has reports" }, "ReportV1": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date-time" } } }, "ReportsCapabililtiesV1": { "type": "object", "properties": { "listClassificationReports": { "$ref": "#/definitions/CapabilityV1" } } }, "ReportsClassificationCapabilitiesV1": { "type": "object", "properties": { "listReportGroups": { "$ref": "#/definitions/CapabilityV1" } } }, "ReportsFormatsCapabilitiesV1": { "type": "object", "properties": { "listAvailableReportFormats": { "$ref": "#/definitions/CapabilityV1" } } }, "ReportsGroupCapabilitiesV1": { "type": "object", "properties": { "listAvailableReports": { "$ref": "#/definitions/CapabilityV1" } } }, "ReportsSummaryGroupCapabilitiesV1": { "type": "object", "properties": { "listSummaryReports": { "$ref": "#/definitions/CapabilityV1" } } }, "RigV1": { "type": "object", "properties": { "jobAsset": { "$ref": "#/definitions/JobAssetInfoV1" }, "blockWeight": { "$ref": "#/definitions/DataValueV1" }, "source": { "type": "string" } } }, "RoadmapAttributeIntervalV1": { "type": "object", "properties": { "indexValue": { "type": "number", "format": "float" }, "value": { "type": "number", "format": "float" } }, "description": "The value of Roadmap attribute when the index value is equal or larger.\r\n * A blank index value denotes the smallest Roadmap value.\r\n * First entry represents the Roadmap attribute value for all values smaller than any index value in the list.\r\n * Last entry represents the Roadmap attribute value for all values larger than any index value in the list.", "required": [ "value" ] }, "RoadmapAttributeV1": { "type": "object", "properties": { "id": { "type": "string", "title": "Roadmap attribute identifier" }, "name": { "type": "string", "title": "Roadmap attribute Name" }, "unit": { "$ref": "#/definitions/UnitV1", "title": "Roadmap attribute Unit" }, "indexAttributeId": { "type": "string", "title": "Index attribute id from which its values are used to determine the Roadmap attribute values" }, "indexAttributeUnit": { "$ref": "#/definitions/UnitV1", "title": "Index attribute unit" }, "storageLocation": { "$ref": "#/definitions/StorageLocationV1", "title": "The location of the Roadmap attribute" }, "defaultScaleRange": { "$ref": "#/definitions/DefaultScaleRangeV1", "title": "Default scale range" } }, "required": [ "id", "name", "unit", "indexAttributeId", "indexAttributeUnit" ] }, "RoadmapAttributeV1Configuration": { "type": "object", "properties": { "name": { "type": "string", "title": "Roadmap attribute name" }, "unitId": { "type": "string", "title": "Roadmap attribute unit id (or unit label)" }, "indexAttributeId": { "type": "string", "title": "Index attribute id from which its values are used to determine the roadmap attribute values(e.g. HookLoad)" }, "indexAttributeUnitId": { "type": "string", "title": "Index attribute unit id" }, "intervals": { "type": "array", "items": { "$ref": "#/definitions/RoadmapAttributeIntervalV1" } }, "storageLocation": { "$ref": "#/definitions/StorageLocationV1", "title": "The location of the roadmap attribute" }, "defaultScaleRange": { "$ref": "#/definitions/DefaultScaleRangeV1", "title": "Default scale range" } }, "required": [ "name", "unitId", "indexAttributeId", "intervals" ] }, "RunPhaseV1": { "type": "string", "enum": [ "TripIn", "Drill", "ShortTrip", "TripOut", "SurfaceOperations" ], "default": "TripIn" }, "RunV1": { "type": "object", "properties": { "id": { "type": "string" }, "startTime": { "type": "string", "format": "date-time" }, "endTime": { "type": "string", "format": "date-time" }, "type": { "$ref": "#/definitions/RunV1RunTypeV1" }, "runNumber": { "type": "integer", "format": "int32", "title": "The sequence of the run by its type." }, "source": { "type": "string" }, "holeDepthRange": { "$ref": "#/definitions/FloatRangeV1", "title": "A range showing the hole depth when the run was started and ended." }, "onBottomEvent": { "$ref": "#/definitions/TimestampRangeV1", "title": "A range showing when the first on bottom and last on bottom occurred." }, "trips": { "type": "array", "items": { "$ref": "#/definitions/TripV1" }, "title": "Trips are considered a part of a run. This is a list of all the trips that belong to this run." }, "runOrdinal": { "type": "integer", "format": "int32", "title": "The ordinal of the run. This is the order in which the runs were performed." }, "status": { "$ref": "#/definitions/RunV1RunStatusV1", "description": "Specifies the status of a run" } } }, "RunV1RunStatusV1": { "type": "string", "enum": [ "Draft", "Approved", "Calculated" ], "default": "Draft" }, "RunV1RunTypeV1": { "type": "string", "enum": [ "Unknown", "Casing", "Bha" ], "default": "Unknown" }, "SectionV1": { "type": "object", "properties": { "id": { "type": "string" }, "sectionEvent": { "$ref": "#/definitions/TimestampRangeV1", "title": "The time range when the section was started and ended." }, "holeDepthRange": { "$ref": "#/definitions/FloatRangeV1", "title": "The hole depth when the section was started and completed." }, "holeSize": { "type": "number", "format": "float", "title": "The size of the hole or bit used to drill the section." }, "type": { "$ref": "#/definitions/SectionV1SectionTypeV1", "title": "The type of section. Should be one of Surface, Intermediate, Curve and Lateral otherwise Unknown." } }, "title": "SectionV1" }, "SectionV1SectionTypeV1": { "type": "string", "enum": [ "Unknown", "Surface", "Intermediate", "Curve", "Lateral" ], "default": "Unknown" }, "SegmentConfigurationV1": { "type": "object", "properties": { "parentId": { "type": "string" }, "fromTime": { "type": "string", "format": "date-time", "title": "The time value when the segment was started." }, "toTime": { "type": "string", "format": "date-time", "title": "The time value when the segment was ended." }, "fromDepth": { "type": "number", "format": "float", "title": "The depth value when the segment was started." }, "toDepth": { "type": "number", "format": "float", "title": "The depth value when the segment was ended." }, "depthUnitId": { "type": "string" }, "name": { "type": "string" }, "jobInfoSuffix": { "type": "string" } }, "required": [ "fromTime", "fromDepth", "name" ] }, "SegmentV1": { "type": "object", "properties": { "id": { "type": "string", "title": "The unique identifier for the segment." }, "parentId": { "type": "string", "title": "The parent segment ID of this segment, if any." }, "fromTime": { "type": "string", "format": "date-time", "title": "The time value when the segment was started." }, "toTime": { "type": "string", "format": "date-time", "title": "The time value when the segment was ended." }, "depthUnit": { "$ref": "#/definitions/UnitV1", "title": "The unit of measure for the depth values." }, "fromDepth": { "type": "number", "format": "float", "title": "The depth value when the segment was started." }, "toDepth": { "type": "number", "format": "float", "title": "The depth value when the segment was ended." }, "type": { "$ref": "#/definitions/SegmentV1SegmentTypeV1" }, "name": { "type": "string" }, "jobInfoSuffix": { "type": "string" }, "syncStatus": { "$ref": "#/definitions/SyncV1" }, "source": { "type": "string", "title": "The source of the segment (e.g., 'Rigsense')." } }, "required": [ "id", "depthUnit", "fromTime", "fromDepth", "type" ] }, "SegmentV1SegmentTypeV1": { "type": "string", "enum": [ "Unknown", "Wellbore" ], "default": "Unknown" }, "ShiftV1": { "type": "object", "properties": { "name": { "type": "string", "example": "Day" }, "timeRange": { "$ref": "#/definitions/TimestampRangeV1", "description": "Time range of the shift" } } }, "StorageLocationV1": { "type": "string", "enum": [ "Datacenter", "Edge" ], "default": "Datacenter" }, "SubReportV1": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" } } }, "SummaryReportTypeV1": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "availableFormats": { "type": "array", "items": { "$ref": "#/definitions/AvailableReportFormatV1" } } } }, "SummaryReportV1": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "number": { "type": "integer", "format": "int32" }, "validDates": { "type": "array", "items": { "type": "string", "format": "date-time" } }, "availableFormats": { "type": "array", "items": { "$ref": "#/definitions/ReportFormatV1" } } } }, "SurveyByJobV1Response": { "type": "object", "properties": { "surveys": { "type": "array", "items": { "$ref": "#/definitions/SurveyV1" }, "title": "List of surveys returned" } } }, "SurveyModelV1": { "type": "object", "properties": { "id": { "type": "string", "title": "Unique Id of the survey model" }, "surveyDepth": { "$ref": "#/definitions/DataValueV1", "title": "Measured depth (MD) with unit" }, "inclination": { "$ref": "#/definitions/DataValueV1", "title": "inclination with unit" }, "azimuth": { "$ref": "#/definitions/DataValueV1", "title": "Azimuth with unit" }, "trueVerticalDepth": { "$ref": "#/definitions/DataValueV1", "title": "True vertical depth with unit" }, "displacementNorthSouth": { "$ref": "#/definitions/DataValueV1", "title": "Displacement in North-South direction with unit" }, "displacementEastWest": { "$ref": "#/definitions/DataValueV1", "title": "Displacement in East-West direction with unit" }, "doglegSeverity": { "$ref": "#/definitions/DataValueV1", "title": "Dogleg severity with unit" }, "createdDate": { "type": "string", "format": "date-time", "title": "Date and time the survey model was created" }, "modifiedDate": { "type": "string", "format": "date-time", "title": "Date and time the survey model was last modified" } } }, "SurveyModelsByJobV1Response": { "type": "object", "properties": { "surveyModels": { "type": "array", "items": { "$ref": "#/definitions/SurveyModelV1" }, "title": "List of survey models returned" } } }, "SurveyStatusV1": { "type": "string", "enum": [ "Unapproved", "Approved" ], "default": "Unapproved" }, "SurveyV1": { "type": "object", "properties": { "id": { "type": "string", "title": "Unique Id of the survey" }, "surveyDepth": { "$ref": "#/definitions/DataValueV1", "title": "Measured depth (MD) with unit" }, "inclination": { "$ref": "#/definitions/DataValueV1", "title": "inclination with unit" }, "azimuth": { "$ref": "#/definitions/DataValueV1", "title": "Azimuth with unit" }, "trueVerticalDepth": { "$ref": "#/definitions/DataValueV1", "title": "True vertical depth with unit" }, "displacementNorthSouth": { "$ref": "#/definitions/DataValueV1", "title": "Displacement in North-South direction with unit" }, "displacementEastWest": { "$ref": "#/definitions/DataValueV1", "title": "Displacement in East-West direction with unit" }, "doglegSeverity": { "$ref": "#/definitions/DataValueV1", "title": "Dogleg severity with unit" }, "surveyStatus": { "$ref": "#/definitions/SurveyStatusV1", "title": "Survey status (All, Approved, Unapproved)" }, "timestamp": { "type": "string", "format": "date-time", "title": "Date and time of the survey measured" }, "trajectoryToolUsed": { "$ref": "#/definitions/SurveyV1SurveyToolTypeV1", "title": "Tool used for measuring the survey" }, "tvdCalculationState": { "$ref": "#/definitions/TVDCalculationStateV1", "title": "TVD calculation state (None, Survey, Derived, Projected)" }, "tvdSurveySourceType": { "$ref": "#/definitions/TVDSurveySourceTypeV1", "title": "TVD survey source type (None, WITS, LAS, Manual, CSV, WITSML, Auto, Excel)" } } }, "SurveyV1SurveyToolTypeV1": { "type": "string", "enum": [ "NotSet", "MagMwd", "GyroMwd", "GyroNorthSeeking", "GyroInertial", "MagSingleShot", "MagMultiShot", "Unknown" ], "default": "NotSet" }, "SwabSurgeTypeV1": { "type": "string", "enum": [ "Swab", "Surge" ], "default": "Swab" }, "SyncStatusV1": { "type": "string", "enum": [ "Latest", "Unsynced", "Synced", "Both" ], "default": "Latest" }, "SyncV1": { "type": "object", "properties": { "status": { "$ref": "#/definitions/SyncV1SyncStatusV1" } }, "description": "Message describing the sync status of the message" }, "SyncV1SyncStatusV1": { "type": "string", "enum": [ "Unknown", "Unsynced", "Syncing", "Synced" ], "default": "Unknown" }, "TVDCalculationStateV1": { "type": "string", "enum": [ "None", "Survey", "Derived", "Projected" ], "default": "None" }, "TVDSurveySourceTypeV1": { "type": "string", "enum": [ "Unspecified", "WITS", "LAS", "Manual", "CSV", "WITSML", "Auto", "Excel", "Innova", "API" ], "default": "Unspecified" }, "ThirdPartyDataFormat": { "type": "string", "enum": [ "Unknown", "WellView", "RigSense" ], "default": "Unknown" }, "TimeRecordV1": { "type": "object", "properties": { "timestamp": { "type": "string", "format": "date-time" }, "values": { "type": "array", "items": { "$ref": "#/definitions/TimeValueV1" } } }, "required": [ "timestamp", "values" ] }, "TimeValueV1": { "type": "object", "properties": { "index": { "type": "integer", "format": "int32" }, "value": { "type": "number", "format": "float" }, "status": { "$ref": "#/definitions/TimeValueV1ChannelStatusV1" } }, "description": "Note: The serialization of this record is compact in that field names are not returned.\r\n\r\n example:\r\n * [22, 6712.12, \"Enabled\"]\r\n", "required": [ "index", "value" ] }, "TimeValueV1ChannelStatusV1": { "type": "string", "enum": [ "Unknown", "Disabled", "Enabled" ], "default": "Unknown" }, "TimestampRangeV1": { "type": "object", "properties": { "from": { "type": "string", "format": "date-time", "example": "2021-06-18T09:16:00-06:00" }, "to": { "type": "string", "format": "date-time", "example": "2021-07-18T09:16:00-06:00" } } }, "TorqueDragModelPointV1": { "type": "object", "properties": { "depth": { "$ref": "#/definitions/DataValueV1" }, "dogLegSeverity": { "$ref": "#/definitions/DataValueV1" }, "freeRotatingWeight": { "$ref": "#/definitions/DataValueV1" }, "slackOffWeight": { "type": "array", "items": { "$ref": "#/definitions/FrictionValueV1" } }, "pickUpWeight": { "type": "array", "items": { "$ref": "#/definitions/FrictionValueV1" } }, "freeRotatingTorque": { "type": "array", "items": { "$ref": "#/definitions/FrictionValueV1" } }, "minBucklingWob": { "type": "array", "items": { "$ref": "#/definitions/FrictionValueV1" } } } }, "TripSpeedValueV1": { "type": "object", "properties": { "depth": { "type": "number", "format": "float" }, "speed": { "type": "number", "format": "float" } } }, "TripV1": { "type": "object", "properties": { "tripEvent": { "$ref": "#/definitions/TimestampRangeV1", "title": "The start and end times for the trip." }, "bitPositionRange": { "$ref": "#/definitions/FloatRangeV1", "title": "The first on bottom and last on bottom bit position." }, "type": { "$ref": "#/definitions/TripV1TripTypeV1", "title": "The type of the trip as defined by one of TripInHole, TripOutHole or ShortTrip, otherwise use Unknown." } }, "title": "TripV1" }, "TripV1TripTypeV1": { "type": "string", "enum": [ "Unknown", "TripInHole", "TripOutHole", "ShortTrip" ], "default": "Unknown" }, "UnitDefinitionV1": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "abbreviation": { "type": "string" } }, "required": [ "id", "name", "abbreviation" ] }, "UnitGroupV1": { "type": "object", "properties": { "name": { "type": "string" }, "units": { "type": "array", "items": { "$ref": "#/definitions/UnitDefinitionV1" } } }, "required": [ "name", "units" ] }, "UnitV1": { "type": "object", "properties": { "id": { "type": "string", "title": "Unit identifier" }, "name": { "type": "string", "title": "Unit name" }, "abbreviation": { "type": "string", "title": "Unit abbreviation" } }, "required": [ "id", "name", "abbreviation" ] }, "UpdateNoteV1": { "type": "object", "properties": { "id": { "type": "string" }, "text": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "depth": { "type": "number", "format": "float" }, "type": { "$ref": "#/definitions/UpdateNoteV1Type" }, "source": { "type": "string", "example": "Sentinel", "title": "Currently 'RT' \u0026 'Sentinel' are the only supported values for cloud. (Cloud default: 'RT')" } }, "required": [ "id", "text", "timestamp", "type" ] }, "UpdateNoteV1Type": { "type": "string", "enum": [ "None", "Time", "Depth" ], "default": "None" }, "UploadedFilePropertiesV1": { "type": "object", "properties": { "id": { "type": "string" }, "fullPath": { "type": "string" }, "description": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time", "example": "2021-06-14T16:19:00.990Z" }, "depth": { "$ref": "#/definitions/DataValueV1", "description": "The unit of measure for the depth index returned,from_depth,to_depth \u0026 interval. for example: Depth.Meter.0 or Depth.Feet.1" }, "fileSizeInBytes": { "type": "integer", "format": "int32" } } }, "UserV1": { "type": "object", "properties": { "groupIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/UserV1Role" } } } }, "UserV1Role": { "type": "string", "enum": [ "Alpha", "Beta" ], "default": "Alpha" }, "ValueMetaV1": { "type": "object", "properties": { "value": { "type": "string", "title": "String representation of a numeric code" }, "meta": { "type": "object", "additionalProperties": { "type": "string" }, "title": "Optional meta data map" } }, "required": [ "value" ] }, "VersionPair": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "protobufAny": { "type": "object", "properties": { "@type": { "type": "string" } }, "additionalProperties": {} }, "rpcStatus": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/protobufAny" } } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "description": "API Key Authentication", "name": "Token", "in": "header" }, "BasicAuth": { "type": "basic" } }, "security": [ { "ApiKeyAuth": [] } ] }