UNPKG

liveapicreator-cli

Version:

A REST command line utility for CA Live API Creator from CA Technologies

1,827 lines 155 kB
{ "swagger": "2.0", "info": { "title": "Demo", "description": "Welcome examples.", "version": "v1" }, "host": "localhost:8080", "schemes": [ "http" ], "basePath": "/rest/default/demo/v1", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ { "name": "AllCustomers", "description": "Query for all customers" }, { "name": "CustomerBusinessObject", "description": "all customer attributes and related child data" }, { "name": "CustomerJSOrdersREST", "description": "RESTful Orders from a REST call" }, { "name": "Customers", "description": "API example - illustrates attribute aliasing / projection" }, { "name": "MDBDemoCustomers", "description": "Multiple Database join, using Virtual Foreign Key (see Data Sources > Relatio..." }, { "name": "OrderMergeInsertProduct", "description": "PUT this object to see the MERGE_INSERT / LOOKUP facility in action." }, { "name": "Products", "description": "Query for all products" }, { "name": "PurchaseOrders", "description": "Query for all orders with line items" }, { "name": "PurchaseOrdersFreeSQL", "description": "Using FreeSQL - you can create complex sql statements" }, { "name": "demo:customer", "description": null }, { "name": "demo:employee", "description": null }, { "name": "demo:employee_picture", "description": null }, { "name": "demo:LineItem", "description": null }, { "name": "demo:product", "description": null }, { "name": "demo:PurchaseOrder", "description": null }, { "name": "demo:purchaseorder_audit", "description": null }, { "name": "finance:orders", "description": null }, { "name": "demo:customers_owing", "description": null }, { "name": "demo:employee_with_picture", "description": null }, { "name": "demo:LineItemJoinProduct", "description": null } ], "paths": { "/AllCustomers/{name}": { "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" } ], "get": { "tags": [ "AllCustomers" ], "summary": "Retrieve a specific AllCustomers object", "description": "# Retrieve a specific AllCustomers object\nQuery for all customers", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" } ], "responses": { "200": { "description": "Zero or one AllCustomers object", "schema": { "type": "array", "items": { "$ref": "#/definitions/AllCustomers" } } } } }, "put": { "tags": [ "AllCustomers" ], "summary": "Update a specific AllCustomers object", "description": "# Update a specific AllCustomers object\nQuery for all customers", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "delete": { "tags": [ "AllCustomers" ], "summary": "Delete a specific AllCustomers object", "description": "# Delete a specific AllCustomers object\nQuery for all customers", "parameters": [ { "$ref": "#/parameters/checksum" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/ignoredeleted" }, { "$ref": "#/parameters/auth" } ] } }, "/AllCustomers": { "get": { "tags": [ "AllCustomers" ], "summary": "Retrieve zero or more AllCustomers objects", "description": "# Retrieve zero or more AllCustomers objects\nQuery for all customers", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" }, { "$ref": "#/parameters/filter" }, { "$ref": "#/parameters/sysfilter" }, { "$ref": "#/parameters/order" }, { "$ref": "#/parameters/sysorder" } ], "responses": { "200": { "description": "Zero or more AllCustomers object", "schema": { "type": "array", "items": { "$ref": "#/definitions/AllCustomers" } } } } }, "post": { "tags": [ "AllCustomers" ], "summary": "Insert zero or more AllCustomers objects", "description": "# Insert zero or more AllCustomers objects\nQuery for all customers", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "put": { "tags": [ "AllCustomers" ], "summary": "Update zero or more AllCustomers objects", "description": "# Update zero or more AllCustomers objects\nQuery for all customers", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] } }, "/CustomerBusinessObject/{name}": { "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" } ], "get": { "tags": [ "CustomerBusinessObject" ], "summary": "Retrieve a specific CustomerBusinessObject object", "description": "# Retrieve a specific CustomerBusinessObject object\nall customer attributes and related child data", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" } ], "responses": { "200": { "description": "Zero or one CustomerBusinessObject object", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerBusinessObject" } } } } }, "put": { "tags": [ "CustomerBusinessObject" ], "summary": "Update a specific CustomerBusinessObject object", "description": "# Update a specific CustomerBusinessObject object\nall customer attributes and related child data", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "delete": { "tags": [ "CustomerBusinessObject" ], "summary": "Delete a specific CustomerBusinessObject object", "description": "# Delete a specific CustomerBusinessObject object\nall customer attributes and related child data", "parameters": [ { "$ref": "#/parameters/checksum" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/ignoredeleted" }, { "$ref": "#/parameters/auth" } ] } }, "/CustomerBusinessObject": { "get": { "tags": [ "CustomerBusinessObject" ], "summary": "Retrieve zero or more CustomerBusinessObject objects", "description": "# Retrieve zero or more CustomerBusinessObject objects\nall customer attributes and related child data", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" }, { "$ref": "#/parameters/filter" }, { "$ref": "#/parameters/sysfilter" }, { "$ref": "#/parameters/order" }, { "$ref": "#/parameters/sysorder" } ], "responses": { "200": { "description": "Zero or more CustomerBusinessObject object", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerBusinessObject" } } } } }, "post": { "tags": [ "CustomerBusinessObject" ], "summary": "Insert zero or more CustomerBusinessObject objects", "description": "# Insert zero or more CustomerBusinessObject objects\nall customer attributes and related child data", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "put": { "tags": [ "CustomerBusinessObject" ], "summary": "Update zero or more CustomerBusinessObject objects", "description": "# Update zero or more CustomerBusinessObject objects\nall customer attributes and related child data", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] } }, "/CustomerJSOrdersREST/{name}": { "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" } ], "get": { "tags": [ "CustomerJSOrdersREST" ], "summary": "Retrieve a specific CustomerJSOrdersREST object", "description": "# Retrieve a specific CustomerJSOrdersREST object\nRESTful Orders from a REST call\n -- click Detail tab\nMake a SQL Call for each customer and then make a REST call to another REST Endpoint to create a compound document resource.", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" } ], "responses": { "200": { "description": "Zero or one CustomerJSOrdersREST object", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerJSOrdersREST" } } } } }, "put": { "tags": [ "CustomerJSOrdersREST" ], "summary": "Update a specific CustomerJSOrdersREST object", "description": "# Update a specific CustomerJSOrdersREST object\nRESTful Orders from a REST call\n -- click Detail tab\nMake a SQL Call for each customer and then make a REST call to another REST Endpoint to create a compound document resource.", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "delete": { "tags": [ "CustomerJSOrdersREST" ], "summary": "Delete a specific CustomerJSOrdersREST object", "description": "# Delete a specific CustomerJSOrdersREST object\nRESTful Orders from a REST call\n -- click Detail tab\nMake a SQL Call for each customer and then make a REST call to another REST Endpoint to create a compound document resource.", "parameters": [ { "$ref": "#/parameters/checksum" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/ignoredeleted" }, { "$ref": "#/parameters/auth" } ] } }, "/CustomerJSOrdersREST": { "get": { "tags": [ "CustomerJSOrdersREST" ], "summary": "Retrieve zero or more CustomerJSOrdersREST objects", "description": "# Retrieve zero or more CustomerJSOrdersREST objects\nRESTful Orders from a REST call\n -- click Detail tab\nMake a SQL Call for each customer and then make a REST call to another REST Endpoint to create a compound document resource.", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" }, { "$ref": "#/parameters/filter" }, { "$ref": "#/parameters/sysfilter" }, { "$ref": "#/parameters/order" }, { "$ref": "#/parameters/sysorder" } ], "responses": { "200": { "description": "Zero or more CustomerJSOrdersREST object", "schema": { "type": "array", "items": { "$ref": "#/definitions/CustomerJSOrdersREST" } } } } }, "post": { "tags": [ "CustomerJSOrdersREST" ], "summary": "Insert zero or more CustomerJSOrdersREST objects", "description": "# Insert zero or more CustomerJSOrdersREST objects\nRESTful Orders from a REST call\n -- click Detail tab\nMake a SQL Call for each customer and then make a REST call to another REST Endpoint to create a compound document resource.", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "put": { "tags": [ "CustomerJSOrdersREST" ], "summary": "Update zero or more CustomerJSOrdersREST objects", "description": "# Update zero or more CustomerJSOrdersREST objects\nRESTful Orders from a REST call\n -- click Detail tab\nMake a SQL Call for each customer and then make a REST call to another REST Endpoint to create a compound document resource.", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] } }, "/Customers/{name}": { "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" } ], "get": { "tags": [ "Customers" ], "summary": "Retrieve a specific Customers object", "description": "# Retrieve a specific Customers object\nAPI example - illustrates attribute aliasing / projection", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" } ], "responses": { "200": { "description": "Zero or one Customers object", "schema": { "type": "array", "items": { "$ref": "#/definitions/Customers" } } } } }, "put": { "tags": [ "Customers" ], "summary": "Update a specific Customers object", "description": "# Update a specific Customers object\nAPI example - illustrates attribute aliasing / projection", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "delete": { "tags": [ "Customers" ], "summary": "Delete a specific Customers object", "description": "# Delete a specific Customers object\nAPI example - illustrates attribute aliasing / projection", "parameters": [ { "$ref": "#/parameters/checksum" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/ignoredeleted" }, { "$ref": "#/parameters/auth" } ] } }, "/Customers": { "get": { "tags": [ "Customers" ], "summary": "Retrieve zero or more Customers objects", "description": "# Retrieve zero or more Customers objects\nAPI example - illustrates attribute aliasing / projection", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" }, { "$ref": "#/parameters/filter" }, { "$ref": "#/parameters/sysfilter" }, { "$ref": "#/parameters/order" }, { "$ref": "#/parameters/sysorder" } ], "responses": { "200": { "description": "Zero or more Customers object", "schema": { "type": "array", "items": { "$ref": "#/definitions/Customers" } } } } }, "post": { "tags": [ "Customers" ], "summary": "Insert zero or more Customers objects", "description": "# Insert zero or more Customers objects\nAPI example - illustrates attribute aliasing / projection", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "put": { "tags": [ "Customers" ], "summary": "Update zero or more Customers objects", "description": "# Update zero or more Customers objects\nAPI example - illustrates attribute aliasing / projection", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] } }, "/MDBDemoCustomers/{name}": { "parameters": [ { "name": "name", "in": "path", "required": true, "type": "string" } ], "get": { "tags": [ "MDBDemoCustomers" ], "summary": "Retrieve a specific MDBDemoCustomers object", "description": "# Retrieve a specific MDBDemoCustomers object\nMultiple Database join, using Virtual Foreign Key (see Data Sources > Relationships).\n\nNote: this database is provided with your account. The associated project illustrates many rule examples (see http://ca-doc.espressologic.com/docs/tutorial). It is provided for appliances, and , and can be loaded into Eval accounts as described in the link above.", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" } ], "responses": { "200": { "description": "Zero or one MDBDemoCustomers object", "schema": { "type": "array", "items": { "$ref": "#/definitions/MDBDemoCustomers" } } } } }, "put": { "tags": [ "MDBDemoCustomers" ], "summary": "Update a specific MDBDemoCustomers object", "description": "# Update a specific MDBDemoCustomers object\nMultiple Database join, using Virtual Foreign Key (see Data Sources > Relationships).\n\nNote: this database is provided with your account. The associated project illustrates many rule examples (see http://ca-doc.espressologic.com/docs/tutorial). It is provided for appliances, and , and can be loaded into Eval accounts as described in the link above.", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "delete": { "tags": [ "MDBDemoCustomers" ], "summary": "Delete a specific MDBDemoCustomers object", "description": "# Delete a specific MDBDemoCustomers object\nMultiple Database join, using Virtual Foreign Key (see Data Sources > Relationships).\n\nNote: this database is provided with your account. The associated project illustrates many rule examples (see http://ca-doc.espressologic.com/docs/tutorial). It is provided for appliances, and , and can be loaded into Eval accounts as described in the link above.", "parameters": [ { "$ref": "#/parameters/checksum" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/ignoredeleted" }, { "$ref": "#/parameters/auth" } ] } }, "/MDBDemoCustomers": { "get": { "tags": [ "MDBDemoCustomers" ], "summary": "Retrieve zero or more MDBDemoCustomers objects", "description": "# Retrieve zero or more MDBDemoCustomers objects\nMultiple Database join, using Virtual Foreign Key (see Data Sources > Relationships).\n\nNote: this database is provided with your account. The associated project illustrates many rule examples (see http://ca-doc.espressologic.com/docs/tutorial). It is provided for appliances, and , and can be loaded into Eval accounts as described in the link above.", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" }, { "$ref": "#/parameters/filter" }, { "$ref": "#/parameters/sysfilter" }, { "$ref": "#/parameters/order" }, { "$ref": "#/parameters/sysorder" } ], "responses": { "200": { "description": "Zero or more MDBDemoCustomers object", "schema": { "type": "array", "items": { "$ref": "#/definitions/MDBDemoCustomers" } } } } }, "post": { "tags": [ "MDBDemoCustomers" ], "summary": "Insert zero or more MDBDemoCustomers objects", "description": "# Insert zero or more MDBDemoCustomers objects\nMultiple Database join, using Virtual Foreign Key (see Data Sources > Relationships).\n\nNote: this database is provided with your account. The associated project illustrates many rule examples (see http://ca-doc.espressologic.com/docs/tutorial). It is provided for appliances, and , and can be loaded into Eval accounts as described in the link above.", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "put": { "tags": [ "MDBDemoCustomers" ], "summary": "Update zero or more MDBDemoCustomers objects", "description": "# Update zero or more MDBDemoCustomers objects\nMultiple Database join, using Virtual Foreign Key (see Data Sources > Relationships).\n\nNote: this database is provided with your account. The associated project illustrates many rule examples (see http://ca-doc.espressologic.com/docs/tutorial). It is provided for appliances, and , and can be loaded into Eval accounts as described in the link above.", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] } }, "/OrderMergeInsertProduct/{order_number}": { "parameters": [ { "name": "order_number", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "get": { "tags": [ "OrderMergeInsertProduct" ], "summary": "Retrieve a specific OrderMergeInsertProduct object", "description": "# Retrieve a specific OrderMergeInsertProduct object\nPUT this object to see the MERGE_INSERT / LOOKUP facility in action.\n{ \"@metadata\": { \"action\": \"INSERT\" }, \"Customer\": { \"@metadata\": { \"action\": \"LOOKUP\", \"key\": \"name\"}, \"Name\": \"Alpha and Sons\"}, \"Product\": {\"action\": \"MERGE_INSERT\", \"key=\"PRODUCT_NAME\"}, \"Name\": \"Bolts\"}", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" } ], "responses": { "200": { "description": "Zero or one OrderMergeInsertProduct object", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderMergeInsertProduct" } } } } }, "put": { "tags": [ "OrderMergeInsertProduct" ], "summary": "Update a specific OrderMergeInsertProduct object", "description": "# Update a specific OrderMergeInsertProduct object\nPUT this object to see the MERGE_INSERT / LOOKUP facility in action.\n{ \"@metadata\": { \"action\": \"INSERT\" }, \"Customer\": { \"@metadata\": { \"action\": \"LOOKUP\", \"key\": \"name\"}, \"Name\": \"Alpha and Sons\"}, \"Product\": {\"action\": \"MERGE_INSERT\", \"key=\"PRODUCT_NAME\"}, \"Name\": \"Bolts\"}", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "delete": { "tags": [ "OrderMergeInsertProduct" ], "summary": "Delete a specific OrderMergeInsertProduct object", "description": "# Delete a specific OrderMergeInsertProduct object\nPUT this object to see the MERGE_INSERT / LOOKUP facility in action.\n{ \"@metadata\": { \"action\": \"INSERT\" }, \"Customer\": { \"@metadata\": { \"action\": \"LOOKUP\", \"key\": \"name\"}, \"Name\": \"Alpha and Sons\"}, \"Product\": {\"action\": \"MERGE_INSERT\", \"key=\"PRODUCT_NAME\"}, \"Name\": \"Bolts\"}", "parameters": [ { "$ref": "#/parameters/checksum" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/ignoredeleted" }, { "$ref": "#/parameters/auth" } ] } }, "/OrderMergeInsertProduct": { "get": { "tags": [ "OrderMergeInsertProduct" ], "summary": "Retrieve zero or more OrderMergeInsertProduct objects", "description": "# Retrieve zero or more OrderMergeInsertProduct objects\nPUT this object to see the MERGE_INSERT / LOOKUP facility in action.\n{ \"@metadata\": { \"action\": \"INSERT\" }, \"Customer\": { \"@metadata\": { \"action\": \"LOOKUP\", \"key\": \"name\"}, \"Name\": \"Alpha and Sons\"}, \"Product\": {\"action\": \"MERGE_INSERT\", \"key=\"PRODUCT_NAME\"}, \"Name\": \"Bolts\"}", "produces": [ "application/json", "application/xml", "text/csv" ], "parameters": [ { "$ref": "#/parameters/pagesize" }, { "$ref": "#/parameters/offset" }, { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/downloadName" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/procrowlimit" }, { "$ref": "#/parameters/procinlinelimit" }, { "$ref": "#/parameters/chunksize" }, { "$ref": "#/parameters/auth" }, { "$ref": "#/parameters/filter" }, { "$ref": "#/parameters/sysfilter" }, { "$ref": "#/parameters/order" }, { "$ref": "#/parameters/sysorder" } ], "responses": { "200": { "description": "Zero or more OrderMergeInsertProduct object", "schema": { "type": "array", "items": { "$ref": "#/definitions/OrderMergeInsertProduct" } } } } }, "post": { "tags": [ "OrderMergeInsertProduct" ], "summary": "Insert zero or more OrderMergeInsertProduct objects", "description": "# Insert zero or more OrderMergeInsertProduct objects\nPUT this object to see the MERGE_INSERT / LOOKUP facility in action.\n{ \"@metadata\": { \"action\": \"INSERT\" }, \"Customer\": { \"@metadata\": { \"action\": \"LOOKUP\", \"key\": \"name\"}, \"Name\": \"Alpha and Sons\"}, \"Product\": {\"action\": \"MERGE_INSERT\", \"key=\"PRODUCT_NAME\"}, \"Name\": \"Bolts\"}", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] }, "put": { "tags": [ "OrderMergeInsertProduct" ], "summary": "Update zero or more OrderMergeInsertProduct objects", "description": "# Update zero or more OrderMergeInsertProduct objects\nPUT this object to see the MERGE_INSERT / LOOKUP facility in action.\n{ \"@metadata\": { \"action\": \"INSERT\" }, \"Customer\": { \"@metadata\": { \"action\": \"LOOKUP\", \"key\": \"name\"}, \"Name\": \"Alpha and Sons\"}, \"Product\": {\"action\": \"MERGE_INSERT\", \"key=\"PRODUCT_NAME\"}, \"Name\": \"Bolts\"}", "parameters": [ { "$ref": "#/parameters/logging" }, { "$ref": "#/parameters/debug" }, { "$ref": "#/parameters/txsummary" }, { "$ref": "#/parameters/rulesummary" }, { "$ref": "#/parameters/deferred" }, { "$ref": "#/parameters/inline" }, { "$ref": "#/parameters/inlinelimit" }, { "$ref": "#/parameters/auth" } ] } }, "/Products/{product_number}": { "parameters": [ { "name": "product_number", "in": "path", "required": true, "type": "integer", "format": "int64" } ], "get": { "tags": [ "Products" ], "summary": "Retrieve a specific Products object", "description": "# Retrieve a specific Products object\nQuery for all products", "produces": [ "application/json", "application/xml", "text/csv" ]