{ "opencollection": "1.0.0", "info": { "name": "Connector Hub Service Connector API", "version": "20200909" }, "items": [ { "info": { "name": "serviceConnector", "type": "folder" }, "items": [ { "info": { "name": "Lists connectors in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20200909/serviceConnectors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE`\n" }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the given display name exactly.\n\nExample: `example_service_connector`\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return\nin a paginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeCreated` is descending.\nDefault order for `displayName` is ascending. If no value is specified `timeCreated` is default.\n" } ] }, "docs": "Lists connectors in the specified compartment.\nFor more information, see\n[Listing Connectors](/iaas/Content/connector-hub/list-service-connector.htm).\n" }, { "info": { "name": "Creates a new connector.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20200909/serviceConnectors", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new connector in the specified compartment.\nA connector is a logically defined flow for moving data from\na source service to a destination service in Oracle Cloud Infrastructure.\nFor more information, see\n[Creating a Connector](/iaas/Content/connector-hub/create-service-connector.htm).\nFor general information about connectors, see\n[Overview of Connector Hub](/iaas/Content/connector-hub/overview.htm).\n\nFor purposes of access control, you must provide the\n[OCID](/iaas/Content/General/Con" }, { "info": { "name": "Gets the specified connector's configuration information.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20200909/serviceConnectors/:serviceConnectorId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.\n" } ] }, "docs": "Gets the specified connector's configuration information.\nFor more information, see\n[Getting a Connector](/iaas/Content/connector-hub/get-service-connector.htm).\n" }, { "info": { "name": "Updates the configuration information for the specified connector.", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20200909/serviceConnectors/:serviceConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration information for the specified connector.\nFor more information, see\n[Updating a Connector](/iaas/Content/connector-hub/update-service-connector.htm).\n\nAfter you send your request, the connector's state is temporarily\nUPDATING and any data transfer pauses. The state then changes back to its\noriginal value: if ACTIVE, then data transfer resumes.\n" }, { "info": { "name": "Deletes the specified connector.", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20200909/serviceConnectors/:serviceConnectorId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.\n" } ] }, "docs": "Deletes the specified connector.\nFor more information, see\n[Deleting a Connector](/iaas/Content/connector-hub/delete-service-connector.htm).\n\nAfter you send your request, the connector's state is temporarily\nDELETING and any data transfer stops. The state then changes to DELETED.\n" }, { "info": { "name": "Activate the ServiceConnector identified by the id", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20200909/serviceConnectors/:serviceConnectorId/actions/activate", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.\n" } ] }, "docs": "Activates the specified connector.\n\nAfter you send your request, the connector's state is temporarily\nUPDATING. When the state changes to ACTIVE, data begins transferring from the\nsource service to the target service.\nFor more information, see\n[Activating a Connector](/iaas/Content/connector-hub/activate-service-connector.htm).\n" }, { "info": { "name": "Moves a connector into a different compartment within the same tenancy.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20200909/serviceConnectors/:serviceConnectorId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a connector into a different compartment within the same tenancy.\nFor more information, see\n[Moving a Connector](/iaas/Content/connector-hub/change-compartment-service-connector.htm).\n\nWhen provided, If-Match is checked against ETag values of the resource.\n" }, { "info": { "name": "Deactivates the specified connector.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20200909/serviceConnectors/:serviceConnectorId/actions/deactivate", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "serviceConnectorId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the connector.\n" } ] }, "docs": "Deactivates the specified connector.\n\nAfter you send your request, the connector's state is temporarily\nUPDATING and any data transfer stops. The state then changes to INACTIVE.\nFor more information, see\n[Deactivating a Connector](/iaas/Content/connector-hub/deactivate-service-connector.htm).\n" }, { "info": { "name": "Lists the work requests in the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20200909/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment for this request.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return\nin a paginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists the work requests in the specified compartment.\nFor more information, see\n[Listing Work Requests](/iaas/Content/connector-hub/list-work-request.htm).\n" }, { "info": { "name": "Gets the details of the specified work request.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20200909/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.\n" } ] }, "docs": "Gets the details of the specified work request.\nFor more information, see\n[Getting a Work Request's Details](/iaas/Content/connector-hub/get-work-request.htm).\n" }, { "info": { "name": "LLists work request errors for the specified work request. Results are paginated.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20200909/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return\nin a paginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists work request errors for the specified work request. Results are paginated.\nFor more information, see\n[Listing Work Request Errors](/iaas/Content/connector-hub/list-work-request-error.htm).\n" }, { "info": { "name": "Lists work request errors for the specified work request. Results are paginated.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20200909/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return\nin a paginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" } ] }, "docs": "Lists logs for the specified work request. Results are paginated.\nFor more information, see\n[Listing Work Request Log Entries](/iaas/Content/connector-hub/list-work-request-log-entry.htm).\n" } ] } ], "bundled": true }