{ "opencollection": "1.0.0", "info": { "name": "Data Flow API", "version": "20200129" }, "items": [ { "info": { "name": "DataFlow", "type": "folder" }, "items": [ { "info": { "name": "List the applications.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/applications", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort the results. Multiple fields are not supported.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The ordering of results in ascending or descending order.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "The query parameter for the Spark application name.\n" }, { "name": "ownerPrincipalId", "value": "", "type": "query", "description": "The OCID of the user who created the resource.\n" }, { "name": "displayNameStartsWith", "value": "", "type": "query", "description": "The displayName prefix.\n" } ] }, "docs": "Lists all applications in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.\n" }, { "info": { "name": "Create an application.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/applications", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an application.\n" }, { "info": { "name": "Get the application.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/applications/:applicationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The unique ID for an application.\n" } ] }, "docs": "Retrieves an application using an `applicationId`.\n" }, { "info": { "name": "Update the application.", "type": "http" }, "http": { "method": "PUT", "url": "/20200129/applications/:applicationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The unique ID for an application.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an application using an `applicationId`.\n" }, { "info": { "name": "Delete the application.", "type": "http" }, "http": { "method": "DELETE", "url": "/20200129/applications/:applicationId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The unique ID for an application.\n" } ] }, "docs": "Deletes an application using an `applicationId`.\n" }, { "info": { "name": "Delete the application and terminate related Runs.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/applications/:applicationId/actions/cascadingDeleteApplication", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The unique ID for an application.\n" } ] }, "docs": "Deletes an application using an `applicationId` and terminates related runs. This operation will timeout in approximate 30 minutes if any related Runs are not terminated successfully.\n" }, { "info": { "name": "Moves an application into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/applications/:applicationId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "applicationId", "value": "", "type": "path", "description": "The unique ID for an application.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.\nAssociated resources, like runs, will not be automatically moved.\n" }, { "info": { "name": "List the pools.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/pools", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The LifecycleState of the pool.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort the results. Multiple fields are not supported.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The ordering of results in ascending or descending order.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "The query parameter for the Spark application name.\n" }, { "name": "ownerPrincipalId", "value": "", "type": "query", "description": "The OCID of the user who created the resource.\n" }, { "name": "displayNameStartsWith", "value": "", "type": "query", "description": "The displayName prefix.\n" } ] }, "docs": "Lists all pools in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.\n" }, { "info": { "name": "Create a pool to be used by dataflow runs or applications.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/pools", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a pool to be used by dataflow runs or applications.\n" }, { "info": { "name": "Get a pool.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/pools/:poolId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The unique ID for a pool.\n" } ] }, "docs": "Retrieves a pool using a `poolId`.\n" }, { "info": { "name": "Updates a pool for provided `poolId`.", "type": "http" }, "http": { "method": "PUT", "url": "/20200129/pools/:poolId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The unique ID for a pool.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a pool using a `poolId`.If changes to a pool doesn't match\na previously defined pool,then a 409 status code will be returned.This indicates\nthat a conflict has been detected.\n" }, { "info": { "name": "Deletes a pool using a `poolId`.", "type": "http" }, "http": { "method": "DELETE", "url": "/20200129/pools/:poolId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The unique ID for a pool.\n" } ] }, "docs": "Deletes a pool using a `poolId`.\n" }, { "info": { "name": "Moves a pool into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/pools/:poolId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The unique ID for a pool.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a pool into a different compartment. When provided, If-Match is checked against ETag\nvalues of the resource. Associated resources, like historical metrics, will not be\nautomatically moved. The pool must be in a terminal state (STOPPED, FAILED) in\norder for it to be moved to a different compartment\n" }, { "info": { "name": "Starts a dataflow pool.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/pools/:poolId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The unique ID for a pool.\n" } ] }, "docs": "Starts the dataflow pool for a given `poolId`. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Stops a dataflow pool.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/pools/:poolId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "poolId", "value": "", "type": "path", "description": "The unique ID for a pool.\n" } ] }, "docs": "Stops the dataflow pool for a given `poolId`. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "List the private endpoints.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/privateEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The LifecycleState of the private endpoint.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort the results. Multiple fields are not supported.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The ordering of results in ascending or descending order.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "The query parameter for the Spark application name.\n" }, { "name": "ownerPrincipalId", "value": "", "type": "query", "description": "The OCID of the user who created the resource.\n" }, { "name": "displayNameStartsWith", "value": "", "type": "query", "description": "The displayName prefix.\n" } ] }, "docs": "Lists all private endpoints in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.\n" }, { "info": { "name": "Create a private endpoint to be used by an application.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/privateEndpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a private endpoint to be used by applications.\n" }, { "info": { "name": "Get a private endpoint.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/privateEndpoints/:privateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "privateEndpointId", "value": "", "type": "path", "description": "The unique ID for a private endpoint.\n" } ] }, "docs": "Retrieves an private endpoint using a `privateEndpointId`.\n" }, { "info": { "name": "Update a private endpoint.", "type": "http" }, "http": { "method": "PUT", "url": "/20200129/privateEndpoints/:privateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "privateEndpointId", "value": "", "type": "path", "description": "The unique ID for a private endpoint.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a private endpoint using a `privateEndpointId`. If changes to a private endpoint match\na previously defined private endpoint, then a 409 status code will be returned. This indicates\nthat a conflict has been detected.\n" }, { "info": { "name": "Delete a private endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "/20200129/privateEndpoints/:privateEndpointId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "privateEndpointId", "value": "", "type": "path", "description": "The unique ID for a private endpoint.\n" } ] }, "docs": "Deletes a private endpoint using a `privateEndpointId`.\n" }, { "info": { "name": "Moves a private endpoint into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/privateEndpoints/:privateEndpointId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "privateEndpointId", "value": "", "type": "path", "description": "The unique ID for a private endpoint.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "List the runs.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/runs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "applicationId", "value": "", "type": "query", "description": "The ID of the application.\n" }, { "name": "poolId", "value": "", "type": "query", "description": "The ID of the pool.\n" }, { "name": "ownerPrincipalId", "value": "", "type": "query", "description": "The OCID of the user who created the resource.\n" }, { "name": "displayNameStartsWith", "value": "", "type": "query", "description": "The displayName prefix.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The LifecycleState of the run.\n" }, { "name": "timeCreatedGreaterThan", "value": "", "type": "query", "description": "The epoch time that the resource was created.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort the results. Multiple fields are not supported.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The ordering of results in ascending or descending order.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "The query parameter for the Spark application name.\n" } ] }, "docs": "Lists all runs of an application in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.\n" }, { "info": { "name": "Create a run.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/runs", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a run for an application.\n" }, { "info": { "name": "Get the run.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/runs/:runId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" } ] }, "docs": "Retrieves the run for the specified `runId`.\n" }, { "info": { "name": "Update the run.", "type": "http" }, "http": { "method": "PUT", "url": "/20200129/runs/:runId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a run using a `runId`.\n" }, { "info": { "name": "Cancels the specified run.", "type": "http" }, "http": { "method": "DELETE", "url": "/20200129/runs/:runId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" } ] }, "docs": "Cancels the specified run if it has not already completed or was previously cancelled.\nIf a run is in progress, the executing job will be killed.\n" }, { "info": { "name": "Moves a run into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/runs/:runId/actions/changeCompartment", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a run into a different compartment. When provided, If-Match is checked against ETag\nvalues of the resource. Associated resources, like historical metrics, will not be\nautomatically moved. The run must be in a terminal state (CANCELED, FAILED, SUCCEEDED) in\norder for it to be moved to a different compartment\n" }, { "info": { "name": "List the run log summaries.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/runs/:runId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" } ] }, "docs": "Retrieves summaries of the run's logs.\n" }, { "info": { "name": "Get the gzipped content of the run log.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/runs/:runId/logs/:name", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" }, { "name": "name", "value": "", "type": "path", "description": "The name of the log. Avoid entering confidential information.\n" } ] }, "docs": "Retrieves the content of an run log.\n" }, { "info": { "name": "List the statements for a Session run.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/runs/:runId/statements", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The LifecycleState of the statement.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field used to sort the results. Multiple fields are not supported.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The ordering of results in ascending or descending order.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" } ] }, "docs": "Lists all statements for a Session run.\n" }, { "info": { "name": "Execute a statement for a Session Run.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/runs/:runId/statements", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Executes a statement for a Session run.\n" }, { "info": { "name": "Get the specific statement for a Session run.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/runs/:runId/statements/:statementId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" }, { "name": "statementId", "value": "", "type": "path", "description": "The unique ID for the statement.\n" } ] }, "docs": "Retrieves the statement corresponding to the `statementId` for a Session run specified by `runId`.\n" }, { "info": { "name": "Cancels the specified statement for a Session run.", "type": "http" }, "http": { "method": "DELETE", "url": "/20200129/runs/:runId/statements/:statementId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "runId", "value": "", "type": "path", "description": "The unique ID for the run\n" }, { "name": "statementId", "value": "", "type": "path", "description": "The unique ID for the statement.\n" } ] }, "docs": "Cancels the specified statement for a Session run.\n" }, { "info": { "name": "Gets a list of all Sql Endpoints in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/sqlEndpoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment in which to query resources." }, { "name": "sqlEndpointId", "value": "", "type": "query", "description": "The unique id of the SQL Endpoint." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "The query parameter for the Spark application name.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items that can be returned." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The ordering of results in ascending or descending order.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified timeCreated is used by default.\n" } ] }, "docs": "Lists all Sql Endpoints in the specified compartment.\nThe query must include compartmentId or sqlEndpointId.\nIf the query does not include either compartmentId or sqlEndpointId, an error is returned.\n" }, { "info": { "name": "Creates a new Sql Endpoint.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/sqlEndpoints", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Sql Endpoint." }, { "info": { "name": "Retrieves a SQL Endpoint using a sqlEndpointId.", "type": "http" }, "http": { "method": "GET", "url": "/20200129/sqlEndpoints/:sqlEndpointId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlEndpointId", "value": "", "type": "path", "description": "The unique id of the SQL Endpoint." } ] }, "docs": "Retrieves a SQL Endpoint using a sqlEndpointId." }, { "info": { "name": "Update a provisioned Sql Endpoint.", "type": "http" }, "http": { "method": "PUT", "url": "/20200129/sqlEndpoints/:sqlEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlEndpointId", "value": "", "type": "path", "description": "The unique id of the SQL Endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Sql Endpoint resource, identified by the SqlEndpoint id." }, { "info": { "name": "Delete a provisioned Sql Endpoint.", "type": "http" }, "http": { "method": "DELETE", "url": "/20200129/sqlEndpoints/:sqlEndpointId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sqlEndpointId", "value": "", "type": "path", "description": "The unique id of the SQL Endpoint." } ] }, "docs": "Delete a Sql Endpoint resource, identified by the SqlEndpoint id." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20200129/sqlEndpoints/:sqlEndpointId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "sqlEndpointId", "value": "", "type": "path", "description": "The unique id of the SQL Endpoint." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an Sql Endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the Sql Endpoint." }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "/20200129/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The OCID of the compartment.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "/20200129/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The unique ID for a work request.\n" } ] }, "docs": "Gets the status of the work request with the given OCID.\n" }, { "info": { "name": "Lists work request errors", "type": "http" }, "http": { "method": "GET", "url": "/20200129/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" }, { "name": "workRequestId", "value": "", "type": "path", "description": "The unique ID for a work request.\n" } ] }, "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": "/20200129/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of results to return in a paginated `List` call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call\nto sent back to server for getting the next page of results.\n" }, { "name": "workRequestId", "value": "", "type": "path", "description": "The unique ID for a work request.\n" } ] }, "docs": "Return a paginated list of logs for a given work request.\n" } ] } ], "bundled": true }