{ "opencollection": "1.0.0", "info": { "name": "Database Nosql API", "version": "20190828" }, "items": [ { "info": { "name": "nosql", "type": "folder" }, "items": [ { "info": { "name": "Execute a SQL query.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190828/query", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Execute a SQL query." }, { "info": { "name": "Prepare a SQL statement for use in a query with variable substitution.\n", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/query/prepare", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment." }, { "name": "statement", "value": "", "type": "query", "description": "A NoSQL SQL statement." }, { "name": "isGetQueryPlan", "value": "", "type": "query", "description": "Include a query execution plan in the result." } ] }, "docs": "Prepare a SQL statement for use in a query with variable substitution.\n" }, { "info": { "name": "Check the syntax and return a brief summary of a SQL statement.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/query/summarize", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment." }, { "name": "statement", "value": "", "type": "query", "description": "A NoSQL SQL statement." } ] }, "docs": "Check the syntax and return a brief summary of a SQL statement.\n" }, { "info": { "name": "Get a list of tables in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/tables", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment." }, { "name": "name", "value": "", "type": "query", "description": "A shell-globbing-style (*?[]) filter for names." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter list by the lifecycle state of the item." } ] }, "docs": "Get a list of tables in a compartment." }, { "info": { "name": "Create a new table.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190828/tables", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new table." }, { "info": { "name": "Get table info by identifier.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" } ] }, "docs": "Get table info by identifier." }, { "info": { "name": "Alter the table identified by tableNameOrId.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Alter the table identified by tableNameOrId,\nchanging schema, limits, or tags\n" }, { "info": { "name": "Delete a table by tableNameOrId.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" }, { "name": "isIfExists", "value": "", "type": "query", "description": "Set as true to select \"if exists\" behavior." } ] }, "docs": "Delete a table by tableNameOrId." }, { "info": { "name": "Change a table's compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change a table's compartment." }, { "info": { "name": "Get a list of indexes on a table.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/indexes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" }, { "name": "name", "value": "", "type": "query", "description": "A shell-globbing-style (*?[]) filter for names." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter list by the lifecycle state of the item." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n" } ] }, "docs": "Get a list of indexes on a table." }, { "info": { "name": "Create a new index.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/indexes", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new index on the table identified by tableNameOrId." }, { "info": { "name": "Get information about a single index.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/indexes/:indexName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "indexName", "value": "", "type": "path", "description": "The name of a table's index." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" } ] }, "docs": "Get information about a single index." }, { "info": { "name": "Delete an index.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/indexes/:indexName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "indexName", "value": "", "type": "path", "description": "The name of a table's index." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" }, { "name": "isIfExists", "value": "", "type": "query", "description": "Set as true to select \"if exists\" behavior." } ] }, "docs": "Delete an index from the table identified by tableNameOrId." }, { "info": { "name": "Add a replica for this table. The table's schema must be frozen prior to this operation.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/replicas", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a replica for this table. The table's schema must be frozen prior to this operation." }, { "info": { "name": "Delete a replica.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/replicas/:region", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "region", "value": "", "type": "path", "description": "A customer-facing region identifier" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" } ] }, "docs": "Delete the specified replica table in the remote region." }, { "info": { "name": "Get a single row from the table by primary key.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/rows", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" }, { "name": "key", "value": "", "type": "query", "description": "An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n" }, { "name": "consistency", "value": "", "type": "query", "description": "Consistency requirement for a read operation." }, { "name": "timeoutInMs", "value": "", "type": "query", "description": "Timeout setting for this operation." } ] }, "docs": "Get a single row from the table by primary key." }, { "info": { "name": "Write a single row into the table.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/rows", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Write a single row into the table." }, { "info": { "name": "Delete a single row from the table, by primary key.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/rows", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" }, { "name": "key", "value": "", "type": "query", "description": "An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n" }, { "name": "isGetReturnRow", "value": "", "type": "query", "description": "If true, and the operation fails due to an option setting\n(ifVersion et al), then the existing row will be returned.\n" }, { "name": "timeoutInMs", "value": "", "type": "query", "description": "Timeout setting for this operation." } ] }, "docs": "Delete a single row from the table, by primary key." }, { "info": { "name": "Get table usage info.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/tables/:tableNameOrId/usage", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "tableNameOrId", "value": "", "type": "path", "description": "A table name within the compartment, or a table OCID." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n" }, { "name": "timeStart", "value": "", "type": "query", "description": "The start time to use for the request. If no time range\nis set for this request, the most recent complete usage\nrecord is returned.\n" }, { "name": "timeEnd", "value": "", "type": "query", "description": "The end time to use for the request." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n" } ] }, "docs": "Get table usage info." }, { "info": { "name": "List the work requests in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of a table's compartment." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "List the work requests in a compartment." }, { "info": { "name": "Get the status of the work request with the given ID.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Get the status of the work request with the given ID." }, { "info": { "name": "Cancel a work request operation with the given ID.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20190828/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Cancel a work request operation with the given ID." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20190828/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }