--- title: Bulk add / update screw compressor curve(s) slug: bulk-add-update-screw-compressor-curves docTags: createdAt: 2024-04-26T20:42:16.945Z --- { "id": "qTgFSPn7o2OFLgYmd09sw", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://data.onxecta.com/api/production/network/compressor/curve", "servers": [ { "url": "https://data.onxecta.com/api/production/network/compressor/curve", "description": "AWS Cloud API Endpoint" }, { "url": "http://localhost/api/production/network/compressor/curve", "description": "Local Testing API Endpoint" } ], "name": "Bulk add / update screw compressor curve(s)", "description": "", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "array", "description": "", "customType": "ScrewCompressorInput[]", "schema": [ { "name": "sourceNetworkId", "kind": "required", "type": "string", "description": "SourceNetworkId in which the compressor is installed", "maxLength": 100 }, { "name": "sourceCompressorId", "kind": "required", "type": "string", "description": "sourceCompressorId is a unique identifier of the compressor to enable upsert functionality", "maxLength": 100 }, { "name": "sourceId", "kind": "required", "type": "string", "description": "SourceId is a unique identifier for the compressor curve to enable upsert functionality", "maxLength": 100 }, { "name": "date", "kind": "required", "type": "string", "description": "

Date in which the compressor curve becomes active in the network. Datetime offset (with timezone) in ISO 8601 format. Example: 2022-09-27T16:28

+0000

", "format": "date-time" }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "Whether this is the active compressor curve for the sourceCompressorId", "default": true }, { "name": "compressorCurve", "kind": "required", "type": "array", "description": "Compressor curve", "modelRef": "#/components/schemas/CompressorCurveInput", "customType": "CompressorCurveInput[]", "schema": [ { "name": "dischargePressure", "kind": "required", "type": "number", "description": "

Discharge pressure for which the curves apply, psig

", "format": "double" }, { "name": "suctionPressure", "kind": "required", "type": "array", "description": "

Suction pressure, psig

", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" }, { "name": "gasRate", "kind": "required", "type": "array", "description": "

Gas rate, Mscf/d

", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" }, { "name": "fuelGas", "kind": "required", "type": "array", "description": "

Percent of gas consumed for fuel, decimal percent

", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/ScrewCompressorInput", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "bearerAuth", "kind": "optional", "type": "http", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "NetworkScrewCompressor[]", "schema": [ { "name": "xid", "kind": "required", "type": "string", "description": "", "format": "uuid" }, { "name": "sourceNetworkId", "kind": "required", "type": "string", "description": "" }, { "name": "sourceCompressorId", "kind": "required", "type": "string", "description": "" }, { "name": "sourceId", "kind": "required", "type": "string", "description": "" }, { "name": "date", "kind": "required", "type": "string", "description": "", "format": "date-time" }, { "name": "isActive", "kind": "optional", "type": "boolean", "description": "", "default": true }, { "name": "compressorCurve", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/CompressorCurve", "customType": "CompressorCurve[]", "schema": [ { "name": "dischargePressure", "kind": "required", "type": "number", "description": "", "format": "double" }, { "name": "suctionPressure", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" }, { "name": "gasRate", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" }, { "name": "fuelGas", "kind": "required", "type": "array", "description": "", "example": "", "itemType": "number", "customType": "number[]", "itemExample": "", "itemDefault": "" } ] } ], "modelRef": "#/components/schemas/NetworkScrewCompressor", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "TyQB_kiCqQREgigeKdZ7z", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://data.onxecta.com/api/production/network/compressor/curve \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '[\n {\n \"sourceNetworkId\": \"\",\n \"sourceCompressorId\": \"\",\n \"sourceId\": \"\",\n \"date\": \"\",\n \"isActive\": true,\n \"compressorCurve\": [\n {\n \"dischargePressure\": \"\",\n \"suctionPressure\": [],\n \"gasRate\": [],\n \"fuelGas\": []\n }\n ]\n }\n ]'" }, { "id": "_wRu7PtQumASFXsEBTBIf", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify([\n {\n \"sourceNetworkId\": \"\",\n \"sourceCompressorId\": \"\",\n \"sourceId\": \"\",\n \"date\": \"\",\n \"isActive\": true,\n \"compressorCurve\": [\n {\n \"dischargePressure\": \"\",\n \"suctionPressure\": [],\n \"gasRate\": [],\n \"fuelGas\": []\n }\n ]\n }\n]);\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://data.onxecta.com/api/production/network/compressor/curve\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "NPYdtSDelHDe3DeGEIJD4", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://data.onxecta.com/api/production/network/compressor/curve\"\n\npayload = json.dumps([\n {\n \"sourceNetworkId\": \"\",\n \"sourceCompressorId\": \"\",\n \"sourceId\": \"\",\n \"date\": \"\",\n \"isActive\": True,\n \"compressorCurve\": [\n {\n \"dischargePressure\": \"\",\n \"suctionPressure\": [],\n \"gasRate\": [],\n \"fuelGas\": []\n }\n ]\n }\n])\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "R9oHZ_hzfxig6p-OAxkxp", "language": "csharp", "label": "C#", "code": "var options = new RestClientOptions(\"https://data.onxecta.com\")\n{\n MaxTimeout = -1,\n};\nvar client = new RestClient(options);\nvar request = new RestRequest(\"/api/production/network/compressor/curve\", Method.Post);\nrequest.AddHeader(\"accept\", \"application/json\");\nrequest.AddHeader(\"content-type\", \"application/json\");\nvar body = @\"[\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"sourceNetworkId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"sourceCompressorId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"sourceId\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"date\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"isActive\"\": true,\" + \"\\n\" +\n@\" \"\"compressorCurve\"\": [\" + \"\\n\" +\n@\" {\" + \"\\n\" +\n@\" \"\"dischargePressure\"\": \"\"\"\",\" + \"\\n\" +\n@\" \"\"suctionPressure\"\": [],\" + \"\\n\" +\n@\" \"\"gasRate\"\": [],\" + \"\\n\" +\n@\" \"\"fuelGas\"\": []\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\" ]\" + \"\\n\" +\n@\" }\" + \"\\n\" +\n@\"]\";\nrequest.AddStringBody(body, DataFormat.Json);\nRestResponse response = await client.ExecuteAsync(request);\nConsole.WriteLine(response.Content);" }, { "id": "is7UAQvPTA8Ugb1xCBDZs", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"[\\n {\\n \\\"sourceNetworkId\\\": \\\"\\\",\\n \\\"sourceCompressorId\\\": \\\"\\\",\\n \\\"sourceId\\\": \\\"\\\",\\n \\\"date\\\": \\\"\\\",\\n \\\"isActive\\\": true,\\n \\\"compressorCurve\\\": [\\n {\\n \\\"dischargePressure\\\": \\\"\\\",\\n \\\"suctionPressure\\\": [],\\n \\\"gasRate\\\": [],\\n \\\"fuelGas\\\": []\\n }\\n ]\\n }\\n]\");\nRequest request = new Request.Builder()\n .url(\"https://data.onxecta.com/api/production/network/compressor/curve\")\n .method(\"POST\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "TyQB_kiCqQREgigeKdZ7z" }, "results": { "languages": [ { "id": "GRfmQ2PG1v5x6KUtmWuoz", "language": "200", "code": "// OK\n[\n {\n \"xid\": \"\",\n \"sourceNetworkId\": \"\",\n \"sourceCompressorId\": \"\",\n \"sourceId\": \"\",\n \"date\": \"\",\n \"isActive\": false,\n \"compressorCurve\": [\n {\n \"dischargePressure\": \"\",\n \"suctionPressure\": [\n 0\n ],\n \"gasRate\": [\n 0\n ],\n \"fuelGas\": [\n 0\n ]\n }\n ]\n }\n]" } ], "selectedLanguageId": "GRfmQ2PG1v5x6KUtmWuoz" } }, "children": [ { "text": "" } ] }