openapi: 3.2.0 info: description: Use the Data Integration API to organize your data integration projects, create data flows, pipelines and tasks, and then publish, schedule, and run tasks that extract, transform, and load data. For more information, see [Data Integration](https://docs.oracle.com/iaas/data-integration/home.htm). license: name: Oracle Corporation title: Data Integration API version: '20200430' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/85979cfb4fad4fd1086a187bef6767b32619ed61ae3506aad96bd6431326aa45.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Data Integration API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/85979cfb4fad4fd1086a187bef6767b32619ed61ae3506aad96bd6431326aa45.yaml what: the harvested document for Data Integration API servers: - url: https://localhost:8484/20200430 - url: http://localhost:8484/20200430 tags: - name: DataIntegration paths: /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: Sucessfully retrieved a list of work requests. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: description: This is the collection of work request summaries, it may be a collection of lightweight details or full definitions. items: $ref: '#/components/schemas/WorkRequestSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list work requests. tags: - DataIntegration x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: Retrieves the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the details of the work request. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: Indicates the number of seconds to wait before making a follow-up request. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get work request status. tags: - DataIntegration x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/logs: get: description: 'Retrieves a paginated list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: Successfully retrieved the list of work request logs. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: description: This is the collection of work request summaries, it may be a collection of lightweight details or full definitions. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list work request logs. tags: - DataIntegration x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/workRequestErrors: get: description: 'Retrieves a paginated list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: Successfully retrieved the list of work request errors. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: description: This is the collection of work request summaries, it may be a collection of lightweight details or full definitions. items: $ref: '#/components/schemas/WorkRequestError' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list work request errors. tags: - DataIntegration x-related-resource: '#/definitions/WorkRequest' /workspaces: get: description: 'Retrieves a list of Data Integration workspaces. ' operationId: ListWorkspaces parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of workspace summaries. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/WorkspaceSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of all Data Integration workspaces in a compartment. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' post: description: 'Creates a new Data Integration workspace ready for performing data integration tasks. To retrieve the OCID for the new workspace, use the opc-work-request-id returned by this API and call the [GetWorkRequest](#/en/data-integration/latest/WorkRequest/GetWorkRequest) API. ' operationId: CreateWorkspace parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request. The Data Integration workspace will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a new Data Integration workspace. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkspaceDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateWorkspaceDetails' description: The information needed to create a new Data Integration workspace. required: true /workspaces/{workspaceId}: delete: description: Deletes a Data Integration workspace resource using the specified identifier. operationId: DeleteWorkspace parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/QuiesceTimeoutQueryParam' - $ref: '#/components/parameters/ForceOperationQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request. The workspace will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a provisioned Data Integration workspace. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' get: description: Retrieves a Data Integration workspace using the specified identifier. operationId: GetWorkspace parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the specified Data Integration workspace. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Workspace' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a specified workspace. tags: - DataIntegration put: description: Updates the specified Data Integration workspace. operationId: UpdateWorkspace parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Successfully accepted the request. The Data Integration workspace will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Workspace' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the Data Integration workspace identified by the ID. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWorkspaceDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateWorkspaceDetails' description: The information needed to update the workspace. required: true /workspaces/{workspaceId}/actions/changeCompartment: post: description: 'Moves a workspace to a specified compartment. ' operationId: ChangeCompartment parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Successfully accepted the request. The workspace will be moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to move a workspace to reside in a specified compartment. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' multipart/form-data: schema: $ref: '#/components/schemas/ChangeCompartmentDetails' description: The information needed to move a workspace to a specified compartment. required: true /workspaces/{workspaceId}/actions/start: post: description: 'Starts a workspace. ' operationId: StartWorkspace parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Successfully accepted the request. The workspace will be started. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to start the workspace. tags: - DataIntegration x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/Workspace' /workspaces/{workspaceId}/actions/stop: post: description: 'Stops a workspace. ' operationId: StopWorkspace parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/QuiesceTimeoutQueryParam' - $ref: '#/components/parameters/ForceOperationQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Successfully accepted the request. The workspace will be stopped. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to stop a workspace. tags: - DataIntegration x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/Workspace' /workspaces/{workspaceId}/applications: get: description: Retrieves a list of applications and provides options to filter the list. operationId: ListApplications parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/NameContainsQueryParameter' - $ref: '#/components/parameters/IdentifierFilter' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FavoritesQueryParam' responses: '200': description: Successfully retrieved a list of applications. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ApplicationSummaryCollection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to lists applications with filtering options. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata post: description: 'Creates an application. ' operationId: CreateApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '200': description: Successfully created an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to create an application. tags: - DataIntegration x-example: "Example: Create a new application.\nPOST /20200430/workspaces/<workspace_id>/applications HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"definedTags\": {},\n \"freeformTags\": {},\n \"modelType\": \"INTEGRATION_APPLICATION\",\n \"compartmentId\": \"ocid1.compartment.oc1..tbd\",\n \"name\": \"New Application\",\n \"identifier\": \"NEW_APPLICATION\",\n \"description\": \"\"\n}\nExample: Copy an application - create a new application from an existing one.\nPOST /20200430/workspaces/<workspace_id>/applications HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"definedTags\": {},\n \"freeformTags\": {},\n \"sourceApplicationInfo\": {\n \"applicationKey\": \"source_application_key\",\n \"workspaceId\": \"ocid1.disworkspace.oc1.iad.tbd\"\n },\n \"modelType\": \"INTEGRATION_APPLICATION\",\n \"compartmentId\": \"ocid1.compartment.oc1..tbd\",\n \"name\": \"New Application\",\n \"identifier\": \"NEW_APPLICATION\",\n \"description\": \"\"\n}\n" x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApplicationDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateApplicationDetails' description: The details needed to create an application. required: true /workspaces/{workspaceId}/applications/{applicationKey}: delete: description: Removes an application using the specified identifier. operationId: DeleteApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '204': description: Successfully deleted the specified application. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 412: $ref: '#/components/responses/412' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to delete an application. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata get: description: Retrieves an application using the specified identifier. operationId: GetApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get an application. tags: - DataIntegration x-targetService: metadata put: description: Updates an application. operationId: UpdateApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully updated an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application' 412: $ref: '#/components/responses/412' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to update an application. tags: - DataIntegration x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateApplicationDetails' description: The details needed to update an application. required: true /workspaces/{workspaceId}/applications/{applicationKey}/compositeState: get: description: 'This endpoint can be used to get composite state for a given aggregator ' operationId: GetCompositeState parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/AggregatorKeyCompositeStateQueryParam' responses: 200: description: Composite State object for provided Aggregator Key. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CompositeState' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Composite State for a given aggregator tags: - DataIntegration /workspaces/{workspaceId}/applications/{applicationKey}/dependentObjects: get: description: Retrieves a list of all dependent objects for a specific application. operationId: ListDependentObjects parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/NameContainsQueryParameter' - $ref: '#/components/parameters/IdentifierFilter' - $ref: '#/components/parameters/TypeFilter' - $ref: '#/components/parameters/TypeInSubtree' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved a list of objects depended on by an application. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DependentObjectSummaryCollection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to list all dependent objects. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata /workspaces/{workspaceId}/applications/{applicationKey}/dependentObjects/{dependentObjectKey}: get: description: Retrieves the details of a dependent object from an application. operationId: GetDependentObject parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/dependentObjectKey' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved the details of a dependent object. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DependentObject' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get the details of a dependent object. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata /workspaces/{workspaceId}/applications/{applicationKey}/detailedDescription: delete: description: Deletes detailed description of an Application. operationId: DeleteApplicationDetailedDescription parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' responses: 202: description: Successfully accepted the delete request. The detailed description will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete detailed description of an Application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata get: description: Retrieves detailed description of an Application operationId: GetApplicationDetailedDescription parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' responses: 200: description: Successfully retrieved the detailed description of specified Application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetailedDescription' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get the detailed description of an Application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata post: description: Creates detailed description for an application. operationId: CreateApplicationDetailedDescription parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '200': description: Successfully created detailed description for an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetailedDescription' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to create detailed description for an application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDetailedDescriptionDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateDetailedDescriptionDetails' description: Detailed description of an application. required: true put: description: Updates the detailed description of an Application. operationId: UpdateApplicationDetailedDescription parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' responses: 200: description: Successfully accepted the update request. The detailed description will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetailedDescription' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to change the detailed description of an Application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDetailedDescriptionDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateDetailedDescriptionDetails' description: The details needed to update the detailed description of Application required: true /workspaces/{workspaceId}/applications/{applicationKey}/patchChanges: get: description: Retrieves a list of patches in an application and provides options to filter the list. operationId: ListPatchChanges parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/SincePatchQueryParam' - $ref: '#/components/parameters/ToPatchQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved a list of patches in an application. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PatchChangeSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to list changes made in the application by patches. tags: - DataIntegration x-related-resource: '#/definitions/Application' /workspaces/{workspaceId}/applications/{applicationKey}/patches: get: description: Retrieves a list of patches in an application and provides options to filter the list. For listing changes based on a period and logical objects changed, see ListPatchChanges API. operationId: ListPatches parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierFilter' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved a list of patches in an application. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PatchSummaryCollection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to list patches with filtering options. For listing changes based on a period and logical objects changed, see ListPatchChanges API. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata post: description: Creates a patch in an application. operationId: CreatePatch parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '200': description: Successfully created a patch in an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Patch' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to create a patch in an application. tags: - DataIntegration x-example: "Example: Execute a task with no parameters.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/patches HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"patchType\": \"REFRESH\"\n}\n" x-related-resource: '#/definitions/Application' x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePatchDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreatePatchDetails' description: Detailed needed to create a patch in an application. required: true /workspaces/{workspaceId}/applications/{applicationKey}/patches/{patchKey}: delete: description: Removes a patch using the specified identifier. operationId: DeletePatch parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/patchKey' responses: 202: description: Successfully accepted the delete request. The patch will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a patch. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata-service get: description: Retrieves a patch in an application using the specified identifier. operationId: GetPatch parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/patchKey' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved a patch in an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Patch' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get a patch in an application. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata /workspaces/{workspaceId}/applications/{applicationKey}/publishedObjects: get: description: Retrieves a list of all the published objects for a specified application. Use the fields query parameter with value 'metadata' to retrieve minimal information. operationId: ListPublishedObjects parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/NameStartsWithQueryParam' - $ref: '#/components/parameters/NameContainsQueryParameter' - $ref: '#/components/parameters/IdentifierFilter' - $ref: '#/components/parameters/TypeFilter' - $ref: '#/components/parameters/TypeInSubtree' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved a list of published objects for an application. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PublishedObjectSummaryCollection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to list the all published objects. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata /workspaces/{workspaceId}/applications/{applicationKey}/publishedObjects/{publishedObjectKey}: get: description: Retrieves the details of a published object from an application. operationId: GetPublishedObject parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/publishedObjectKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ExpandReferences' responses: '200': description: Successfully retrieved the details of a published object. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublishedObject' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get details of a published object. tags: - DataIntegration x-related-resource: '#/definitions/Application' x-targetService: metadata /workspaces/{workspaceId}/applications/{applicationKey}/references: get: description: Retrieves a list of references in an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections. operationId: ListReferences parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: '200': description: Successfully retrieved references in an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ReferenceSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get a list of references for an application. Reference objects are created when dataflows and tasks use objects, such as data assets and connections. This endpoint returns a set of the references used in the application. tags: - DataIntegration x-related-resource: '#/definitions/Reference' /workspaces/{workspaceId}/applications/{applicationKey}/references/{referenceKey}: get: description: Retrieves a reference in an application. operationId: GetReference parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/referenceKey' responses: '200': description: Successfully retrieved a reference in an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Reference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get a reference for an application. tags: - DataIntegration x-related-resource: '#/definitions/Reference' put: description: Updates the application references. For example, to map a data asset to a different target object. operationId: UpdateReference parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/referenceKey' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Successfully accepted the update request. The task run will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Reference' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update application references. For example, to map a data asset to a different target object. tags: - DataIntegration x-example: "Example: Update data asset reference for an ADW.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/references/<reference_key> HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"targetObject\": {\n \"key\": \"target_adw_data_asset_key\",\n \"modelType\": \"ORACLE_ADWC_DATA_ASSET\"\n }\n}\nExample: Update connection reference for an ADW.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/references/<reference_key> HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"targetObject\": {\n \"key\": \"target_adw_connection_key\",\n \"modelType\": \"ORACLE_ADWC_CONNECTION\"\n }\n}\nExample: Update schema reference.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/references/<reference_key> HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"targetObject\": {\n \"key\": \"dataref:connection_key/YOURSCHEMANAME\",\n \"modelType\": \"SCHEMA\"\n }\n}\n" x-related-resource: '#/definitions/Reference' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateReferenceDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateReferenceDetails' description: The details needed to update the references. required: true /workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines: get: description: 'This endpoint can be used to list runtime pipelines with filtering options ' operationId: ListRuntimePipelines parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/KeyListQueryParam' - $ref: '#/components/parameters/AggregatorKeyQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/AggregatorTypeListQueryParam' - $ref: '#/components/parameters/FilterListQueryParameter' responses: 200: description: A page of Runtime Pipeline objects. headers: opc-next-page: description: 'For pagination of a list of `RuntimePipeline`s. If this header appears in the response, then this is a partial list of RuntimePipeline. Include this value as the `page` parameter in a subsequent GET request to get the next batch of RuntimePipelines. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RuntimePipelineSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists Runtime Pipelines with filtering options tags: - DataIntegration x-feature-id: Orchestration /workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines/{runtimePipelineKey}: get: description: Retrieves a runtime pipeline using the specified identifier. operationId: GetRuntimePipeline parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/runtimePipelineKey' - $ref: '#/components/parameters/ExpandReferences' responses: 200: description: Successfully retrieved the specified runtime pipeline. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RuntimePipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a runtime pipeline using the specified identifier. tags: - DataIntegration x-feature-id: Orchestration /workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines/{runtimePipelineKey}/runtimeOperators: get: description: 'This endpoint can be used to list runtime operators with filtering options ' operationId: ListRuntimeOperators parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/runtimePipelineKey' - $ref: '#/components/parameters/KeyListQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/AggregatorTypeListQueryParam' responses: 200: description: A page of Runtime Operator objects. headers: opc-next-page: description: 'For pagination of a list of `RuntimeOperator`s. If this header appears in the response, then this is a partial list of RuntimeOperator. Include this value as the `page` parameter in a subsequent GET request to get the next batch of RuntimeOperators. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RuntimeOperatorSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists Runtime Operators with filtering options tags: - DataIntegration x-feature-id: Orchestration ? /workspaces/{workspaceId}/applications/{applicationKey}/runtimePipelines/{runtimePipelineKey}/runtimeOperators/{runtimeOperatorKey} : get: description: Retrieves a runtime operator using the specified identifier. operationId: GetRuntimeOperator parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/runtimePipelineKey' - $ref: '#/components/parameters/runtimeOperatorKey' responses: 200: description: Successfully retrieved the specified runtime operator. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RuntimeOperator' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a runtime operator using the specified identifier. tags: - DataIntegration x-feature-id: Orchestration /workspaces/{workspaceId}/applications/{applicationKey}/schedules: get: description: 'Use this endpoint to list schedules. ' operationId: ListSchedules parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/KeyListQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/TypeListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FavoritesQueryParam' - $ref: '#/components/parameters/FilterQueryParam' responses: '200': description: List of Schedule objects headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ScheduleSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of schedules. tags: - DataIntegration x-related-resource: '#/definitions/Schedule' post: description: Endpoint to create a new schedule operationId: CreateSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Schedule is created successfully headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a new schedule object. tags: - DataIntegration x-example: "Example: Create a schedule with a Cron expression.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/schedules HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"Schedule every 30 mins\",\n \"identifier\": \"SCHEDULE_EVERY_30_MINS\",\n \"frequencyDetails\": { \"modelType\": \"CUSTOM\", \"customExpression\": \"*/30 * * * *\" },\n \"isDaylightAdjustmentEnabled\": false,\n \"timezone\": \"UTC\"\n}\n" x-related-resource: '#/definitions/Schedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScheduleDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateScheduleDetails' description: Request body parameter for Schedule details required: true /workspaces/{workspaceId}/applications/{applicationKey}/schedules/{scheduleKey}: delete: description: Endpoint to delete schedule. operationId: DeleteSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/scheduleKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '204': description: Schedule and corresponding objects are deleted headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a schedule. tags: - DataIntegration x-related-resource: '#/definitions/Schedule' get: description: Retrieves schedule by schedule key operationId: GetSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/scheduleKey' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: A Schedule object headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a schedule. tags: - DataIntegration x-related-resource: '#/definitions/Schedule' put: description: Endpoint used to update the schedule operationId: UpdateSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/scheduleKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Schedule is updated headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the schedule object identified by the key. tags: - DataIntegration x-related-resource: '#/definitions/Schedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateScheduleDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateScheduleDetails' description: Request body parameter for Schedule details required: true /workspaces/{workspaceId}/applications/{applicationKey}/taskRunLineages: get: description: 'This endpoint can be used to list Task Run Lineages within a given time window. ' operationId: ListTaskRunLineages parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FilterListQueryParameter' - $ref: '#/components/parameters/TimeUpdatedGreaterThanQueryParam' - $ref: '#/components/parameters/TimeUpdatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeUpdatedLessThanQueryParam' - $ref: '#/components/parameters/TimeUpdatedLessThanOrEqualToQueryParam' responses: 200: description: A page of TaskRunLineage objects. headers: opc-next-page: description: 'For pagination of a list of `TaskRunLineage`s. If this header appears in the response, then this is a partial list of TaskRunLineage. Include this value as the `page` parameter in a subsequent GET request to get the next batch of TaskRunLineages. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskRunLineageSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists Task Run Lineages with filtering options. tags: - DataIntegration x-feature-id: Orchestration /workspaces/{workspaceId}/applications/{applicationKey}/taskRuns: get: description: Retrieves a list of task runs and provides options to filter the list. operationId: ListTaskRuns parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/KeyListQueryParam' - $ref: '#/components/parameters/AggregatorQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FilterListQueryParameter' - $ref: '#/components/parameters/NameStartsWithQueryParam' - $ref: '#/components/parameters/NameContainsQueryParameter' responses: 200: description: Successfully retrieved a page of task runs. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/TaskRunSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to lists task runs with filtering options. tags: - DataIntegration x-related-resource: '#/definitions/TaskRun' x-targetService: metadata-service post: description: Creates a data integration task run for the specified task. operationId: CreateTaskRun parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' responses: 200: description: Successfully created a task run. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a Data Integration task run for the specified task. tags: - DataIntegration x-example: "Example: Execute a task with no parameters.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/taskRuns HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"registryMetadata\": {\n \"aggregatorKey\": \"your_task_key_to_run\"\n }\n}\nExample: Execute a task with a string parameter.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/taskRuns HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"configProvider\": {\n \"bindings\": {\n \"YOUR_STRING_PARAMETER\": {\n \"simpleValue\": \"Hello\"\n }\n }\n },\n \"registryMetadata\": {\n \"aggregatorKey\": \"your_task_key_to_run\"\n }\n}\n" x-related-resource: '#/definitions/TaskRun' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTaskRunDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateTaskRunDetails' description: The details needed to create a task run. required: true /workspaces/{workspaceId}/applications/{applicationKey}/taskRuns/{taskRunKey}: delete: description: Deletes a task run using the specified identifier. operationId: DeleteTaskRun parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/taskRunKey' responses: 202: description: Successfully accepted the delete request. The task run will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a task run. tags: - DataIntegration x-related-resource: '#/definitions/TaskRun' x-targetService: metadata-service get: description: Retrieves a task run using the specified identifier. operationId: GetTaskRun parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/taskRunKey' responses: 200: description: Successfully retrieved the specified task run. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskRun' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a task run using the specified identifier. tags: - DataIntegration put: description: Updates the status of the task run. For example, aborts a task run. operationId: UpdateTaskRun parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/taskRunKey' responses: 200: description: Successfully accepted the update request. The task run will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskRunDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to change the status of the task run. For example, to abort the task run. tags: - DataIntegration x-related-resource: '#/definitions/TaskRun' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTaskRunDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateTaskRunDetails' description: The details needed to update the status of a task run. required: true /workspaces/{workspaceId}/applications/{applicationKey}/taskRuns/{taskRunKey}/logs: get: description: Gets log entries for task runs using its key. operationId: ListTaskRunLogs parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/taskRunKey' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: Successfully retrieved a list of task run logs. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: description: This is the collection of task run log entries. items: $ref: '#/components/schemas/TaskRunLogSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list task run logs. tags: - DataIntegration /workspaces/{workspaceId}/applications/{applicationKey}/taskSchedules: get: description: 'This endpoint can be used to get the list of all the TaskSchedule objects. ' operationId: ListTaskSchedules parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/KeyListQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/TypeListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IsEnabledQueryParam' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: A page of TaskSchedule objects headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/TaskScheduleSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of task schedules. tags: - DataIntegration x-related-resource: '#/definitions/TaskSchedule' post: description: Endpoint to be used create TaskSchedule. operationId: CreateTaskSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: TaskSchedule is created successfully headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskSchedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a new task schedule object. tags: - DataIntegration x-example: "Example: Schedule a task with no parameters.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/taskSchedules HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"Task Every Period\",\n \"identifier\": \"TASK_EVERY_PERIOD\",\n \"scheduleRef\": {\"key\":\"your_schedule_key\"},\n \"registryMetadata\": {\n \"aggregatorKey\": \"your_task_key_to_run\"\n }\n}\nExample: Schedule a task with a string parameter.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/taskSchedules HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"Task Every Period\",\n \"identifier\": \"TASK_EVERY_PERIOD\",\n \"scheduleRef\": {\"key\":\"your_schedule_key\"},\n \"configProvider\": {\n \"bindings\": {\n \"YOUR_STRING_PARAMETER\": {\n \"simpleValue\": \"Hello\"\n }\n }\n },\n \"registryMetadata\": {\n \"aggregatorKey\": \"your_task_key_to_run\"\n }\n}\nExample: Schedule a task with end time and retry and other properties.\nPOST /20200430/workspaces/<workspace_id>/applications/<application_key>/taskSchedules HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"Task Every Period\",\n \"identifier\": \"TASK_EVERY_PERIOD\",\n \"endTimeMillis\": 1768791660000,\n \"expectedDuration\": 1,\n \"expectedDurationUnit\": \"HOURS\",\n \"isConcurrentAllowed\": true,\n \"isEnabled\": true,\n \"retryAttempts\": 3,\n \"retryDelay\": 1,\n \"retryDelayUnit\": \"MINUTES\",\n \"scheduleRef\": {\"key\":\"your_schedule_key\"},\n \"timezone\": \"UTC\",\n \"registryMetadata\": {\n \"aggregatorKey\": \"your_task_key_to_run\"\n }\n}\n" x-related-resource: '#/definitions/TaskSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTaskScheduleDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateTaskScheduleDetails' description: Request body parameter for TaskSchedule details required: true /workspaces/{workspaceId}/applications/{applicationKey}/taskSchedules/{taskScheduleKey}: delete: description: Endpoint to delete TaskSchedule. operationId: DeleteTaskSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/taskScheduleKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '204': description: TaskSchedule and corresponding objects are deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a task schedule. tags: - DataIntegration x-related-resource: '#/definitions/TaskSchedule' get: description: Endpoint used to get taskSchedule by its key operationId: GetTaskSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/taskScheduleKey' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: A TaskSchedule object headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskSchedule' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to fetch a task Schedule. tags: - DataIntegration x-related-resource: '#/definitions/TaskSchedule' put: description: Endpoint used to update the TaskSchedule operationId: UpdateTaskSchedule parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/taskScheduleKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: TaskSchedule is updated headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskSchedule' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the task schedule object identified by the key tags: - DataIntegration x-related-resource: '#/definitions/TaskSchedule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTaskScheduleDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateTaskScheduleDetails' description: Request body parameter for TaskSchedule details required: true /workspaces/{workspaceId}/connectionValidations: get: description: Retrieves a list of connection validations within the specified workspace. operationId: ListConnectionValidations parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/KeyQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a page of connection validations. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ConnectionValidationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of connection validations. tags: - DataIntegration x-related-resource: '#/definitions/ConnectionValidation' post: description: Creates a connection validation. operationId: CreateConnectionValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/CreateConnectionValidationDetails' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Successfully created a connection validation. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConnectionValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Use this endpoint to create a connection validation object. tags: - DataIntegration x-related-resource: '#/definitions/ConnectionValidation' x-targetService: connectivity /workspaces/{workspaceId}/connectionValidations/{connectionValidationKey}: delete: description: Deletes a connection validation. operationId: DeleteConnectionValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionValidationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The validation object is successfully deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a connection validation. tags: - DataIntegration x-related-resource: '#/definitions/ConnectionValidation' get: description: Retrieves a connection validation using the specified identifier. operationId: GetConnectionValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionValidationKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a connection validation. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConnectionValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get the connection validation based on its ID. tags: - DataIntegration x-related-resource: '#/definitions/ConnectionValidation' /workspaces/{workspaceId}/connections: get: description: Retrieves a list of all connections. operationId: ListConnections parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/DataAssetKeyQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/TypeQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a list of connections. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ConnectionSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a summary of connections. tags: - DataIntegration x-related-resource: '#/definitions/Connection' x-targetService: connectivity post: description: Creates a connection under an existing data asset. operationId: CreateConnection parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/CreateConnectionDetails' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Successfully created a connection. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a connection under an existing data asset. tags: - DataIntegration x-related-resource: '#/definitions/Connection' x-targetService: connectivity /workspaces/{workspaceId}/connections/{connectionKey}: delete: description: Removes a connection using the specified identifier. operationId: DeleteConnection parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the connection. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete the connection by given connection id. tags: - DataIntegration x-related-resource: '#/definitions/Connection' x-targetService: connectivity get: description: Retrieves the connection details using the specified identifier. operationId: GetConnection parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the specified connection. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get the connection details using the specified identifier. tags: - DataIntegration x-related-resource: '#/definitions/Connection' x-targetService: connectivity put: description: Updates a connection under a data asset. operationId: UpdateConnection parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/UpdateConnectionDetails' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Successfully updated the connection. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update a connection under a data asset. tags: - DataIntegration x-example: "Example: Update a connection.\nPOST /20200430/workspaces/<workspace_id>/connections/<connection_key> HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"Default connection\",\n \"description\": \"Connection description here.\",\n \"identifier\": \"DEFAULT_CONNECTION\",\n \"modelType\": \"ORACLE_ADWC_CONNECTION\",\n \"username\": \"YOUR_SCHEMA\",\n \"passwordSecret\": {\n \"secretConfig\": {\n \"secretId\": \"ocid1.vaultsecret.oc1.iad.tbd\",\n \"modelType\": \"OCI_VAULT_SECRET_CONFIG\"\n }\n },\n \"tnsAlias\": \"iadtest_high\",\n \"isDefault\": true,\n \"key\": \"your_connection_key\",\n \"registryMetadata\": {\n \"aggregatorKey\": \"your_data_asset_key\"\n }\n}\n" x-related-resource: '#/definitions/Connection' x-targetService: connectivity /workspaces/{workspaceId}/connections/{connectionKey}/schemas: get: description: Retrieves a list of all the schemas that can be accessed using the specified connection. operationId: ListSchemas parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SchemaResourceNameQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameListQueryParam' - $ref: '#/components/parameters/IncludeTypesQueryParam' responses: 200: description: Successfully retrieved a list of schemas that can be accessed using the specified connection. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/SchemaSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Use this endpoint to get a summary of schemas using the specified connection. tags: - DataIntegration x-related-resource: '#/definitions/Schema' x-targetService: connectivity /workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}: get: description: Retrieves a schema that can be accessed using the specified connection. operationId: GetSchema parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/SchemaResourceName' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a schema that can be accessed using the specified connection. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Schema' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Use this endpoint to get a schema with the given schema resource name. tags: - DataIntegration x-related-resource: '#/definitions/Schema' x-targetService: connectivity /workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}/dataEntities: get: description: "Lists a summary of data entities from the data asset using the specified connection. \n" operationId: ListDataEntities parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/SchemaResourceName' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/TypeQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/NameListQueryParam' - $ref: '#/components/parameters/IsPatternParam' - $ref: '#/components/parameters/IncludeTypesQueryParam' responses: 200: description: Successfully retrieved a page of data entities. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DataEntitySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list the summaries of data entities within the specified schema. tags: - DataIntegration x-related-resource: '#/definitions/DataEntity' x-targetService: connectivity /workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}/dataEntities/{dataEntityKey}: get: description: Retrieves the data entity details with the given name from live schema. operationId: GetDataEntity parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/SchemaResourceName' - $ref: '#/components/parameters/DataEntityKey' responses: 200: description: Successfully retrieved the data entity. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataEntity' 400: description: Bad Request headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' 401: description: Unauthorized headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' 404: description: Not Found headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' 429: $ref: '#/components/responses/429' 500: description: Internal Server Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get the data entity from live schema. tags: - DataIntegration x-related-resource: '#/definitions/DataEntity' x-targetService: connectivity /workspaces/{workspaceId}/connections/{connectionKey}/schemas/{schemaResourceName}/entityShapes: post: description: Creates the data entity shape using the shape from the data asset. operationId: CreateEntityShape parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/ConnectionKey' - $ref: '#/components/parameters/SchemaResourceName' responses: 200: description: Successfully created the data entity shape. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/EntityShape' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a data entity shape using the shape from the data asset. tags: - DataIntegration x-related-resource: '#/definitions/DataEntity' x-targetService: connectivity requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEntityShapeDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateEntityShapeDetails' description: The details needed to create the data entity shape. required: true /workspaces/{workspaceId}/copyObjectRequests: get: description: 'This endpoint can be used to get the list of copy object requests. ' operationId: ListCopyObjectRequests parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/CopyStatusQueryParameter' - $ref: '#/components/parameters/GetCopyObjectProjection' - $ref: '#/components/parameters/TimeStartedQueryParam' - $ref: '#/components/parameters/TimeEndedQueryParam' responses: '200': description: List copy object requests headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CopyObjectRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: List copy object requests. tags: - DataIntegration x-targetService: metadata post: description: 'Copy Metadata Object. ' operationId: CreateCopyObjectRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/workspaceId' responses: '202': description: Successfully accepted the copy object request. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CopyObjectRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to copy object from one workspace to same/another workspace. tags: - DataIntegration x-example: "Example: Copy objects from one workspace to another.\nPOST /20200430/workspaces/<workspace_id>/copyObjectRequests HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"sourceWorkspaceId\": \"source_workspace_id\",\n \"objectKeys\": [\n \"source_object_key\"\n ],\n \"copyConflictResolution\": {\n \"requestType\": \"RETAIN\"\n }\n}\n" x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCopyObjectRequestDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateCopyObjectRequestDetails' description: The details needed to copy metadata object. required: true /workspaces/{workspaceId}/copyObjectRequests/{copyObjectRequestKey}: delete: description: Delete copy object request using the specified identifier. operationId: DeleteCopyObjectRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/copyObjectRequestKey' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Successfully accepted the delete request. The copy object request will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete copy object request. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' x-targetService: metadata-service get: description: 'This endpoint can be used to get the summary/details of object being copied. ' operationId: GetCopyObjectRequest parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/copyObjectRequestKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Copy metadata object request summary/details. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CopyObjectRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Get copy object request summary/details by key. tags: - DataIntegration x-targetService: metadata put: description: Updates the status of a copy object request. operationId: UpdateCopyObjectRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/copyObjectRequestKey' responses: 200: description: Successfully accepted the update request. The copy object request will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CopyObjectRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to change the status of a copy object request. For example, cancel a copy object request. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCopyObjectRequestDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateCopyObjectRequestDetails' description: The details needed to update the status of a copy object request. required: true /workspaces/{workspaceId}/countStatistics/{countStatisticKey}: get: description: "Retrieves statistics on a workspace. It returns an object with an array of property values, such as the number of projects, |\n applications, data assets, and so on.\n" operationId: GetCountStatistic parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - description: A unique key of the container object, such as workspace, project, and so on, to count statistics for. The statistics is fetched for the given key. in: path name: countStatisticKey required: true schema: type: string responses: 200: description: Successfully retreived a page of workspace statistics. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CountStatistic' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list statistics on the workspace. tags: - DataIntegration x-related-resource: '#/definitions/Project' x-targetService: metadata-service /workspaces/{workspaceId}/dataAssets: get: description: 'Retrieves a list of all data asset summaries. ' operationId: ListDataAssets parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/TypeQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a list of data asset summaries. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DataAssetSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get all the data asset summaries. Result can be filtered based on type of data asset by passing type query parameter. tags: - DataIntegration x-related-resource: '#/definitions/DataAsset' x-targetService: connectivity post: description: Creates a data asset with default connection. operationId: CreateDataAsset parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/CreateDataAssetDetails' responses: 200: description: Successfully created a data asset. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a data asset with default connection. tags: - DataIntegration x-example: "Example: Create an OCI Object Storage Data Asset.\nPOST /20200430/workspaces/<workspace_id>/dataAssets HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"My Data Asset\",\n \"identifier\": \"MY_DATA_ASSET\",\n \"modelType\": \"ORACLE_OBJECT_STORAGE_DATA_ASSET\",\n \"defaultConnection\": {\n \"name\": \"Default connection\",\n \"identifier\": \"DEFAULT_CONNECTION\",\n \"modelType\": \"ORACLE_OBJECT_STORAGE_CONNECTION\"\n },\n \"ociRegion\": \"us-ashburn-1\",\n \"tenancyId\": \"ocid1.tenancy.oc1..tbd\",\n \"namespace\": \"your_namespace\"\n}\nExample: Create an OCI ADW Data Asset.\nPOST /20200430/workspaces/<workspace_id>/dataAssets HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"My ADW Data Asset\",\n \"identifier\": \"MY_ADW_DATA_ASSET\",\n \"modelType\": \"ORACLE_ADWC_DATA_ASSET\",\n \"defaultConnection\": {\n \"name\": \"Default connection\",\n \"identifier\": \"DEFAULT_CONNECTION\",\n \"modelType\": \"ORACLE_ADWC_CONNECTION\",\n \"username\": \"YOURSCHEMA\",\n \"passwordSecret\": {\n \"secretConfig\": {\n \"secretId\": \"ocid1.vaultsecret.oc1.iad.tbd\",\n \"modelType\": \"OCI_VAULT_SECRET_CONFIG\"\n }\n },\n \"tnsAlias\": \"iadtest_high\"\n },\n \"walletSecret\": {\n \"secretConfig\": {\n \"modelType\": \"OCI_VAULT_SECRET_CONFIG\",\n \"secretId\": \"ocid1.vaultsecret.oc1.iad.tbd\"\n }\n },\n \"stagingDataAsset\": {\n \"modelType\": \"ORACLE_OBJECT_STORAGE_DATA_ASSET\",\n \"key\": \"your_object_storage_data_asset_key\"\n },\n \"stagingConnection\": {\n \"modelType\": \"ORACLE_OBJECT_STORAGE_CONNECTION\",\n \"key\": \"your_object_storage_connection_key\",\n \"name\": \"Default Connection\"\n },\n \"bucketSchema\": {\n \"modelType\": \"SCHEMA\",\n \"key\": \"dataref:your_object_storage_connection_key/your_bucket\"\n }\n}\n" x-related-resource: '#/definitions/DataAsset' x-targetService: connectivity /workspaces/{workspaceId}/dataAssets/{dataAssetKey}: delete: description: Removes a data asset using the specified identifier. operationId: DeleteDataAsset parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/DataAssetKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully processed the delete request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a data asset by key. tags: - DataIntegration x-related-resource: '#/definitions/DataAsset' x-targetService: connectivity get: description: Retrieves details of a data asset using the specified identifier. operationId: GetDataAsset parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/DataAssetKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the specified data asset. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get details of a data asset based on data asset key. tags: - DataIntegration x-targetService: connectivity put: description: Updates a specific data asset with default connection. operationId: UpdateDataAsset parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/DataAssetKey' - $ref: '#/components/parameters/UpdateDataAssetDetails' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Successfully updated the data asset. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAsset' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update a data asset with default connection. tags: - DataIntegration x-targetService: connectivity /workspaces/{workspaceId}/dataFlowValidations: get: description: Retrieves a list of data flow validations within the specified workspace. operationId: ListDataFlowValidations parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/KeyQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a list of data flow validations. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DataFlowValidationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of data flow validations. tags: - DataIntegration x-related-resource: '#/definitions/DataFlowValidation' post: description: 'Accepts the data flow definition in the request payload and creates a data flow validation. ' operationId: CreateDataFlowValidation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully processed the validation request. The migration definition along with a list of validation results is returned. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataFlowValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to execute a data flow validation. tags: - DataIntegration x-related-resource: '#/definitions/DataFlowValidation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataFlowValidationDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateDataFlowValidationDetails' description: The information needed to create the data flow validation for the data flow object. required: true /workspaces/{workspaceId}/dataFlowValidations/{dataFlowValidationKey}: delete: description: Removes a data flow validation using the specified identifier. operationId: DeleteDataFlowValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/dataFlowValidationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the data flow validation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a data flow validation. tags: - DataIntegration x-related-resource: '#/definitions/DataFlowValidation' get: description: Retrieves a data flow validation using the specified identifier. operationId: GetDataFlowValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/dataFlowValidationKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the specified data flow validation. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataFlowValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to gets a data flow validation using the specified identifier. tags: - DataIntegration x-related-resource: '#/definitions/DataFlowValidation' /workspaces/{workspaceId}/dataFlows: get: description: 'Retrieves a list of data flows in a project or folder. ' operationId: ListDataFlows parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/FolderKeyQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a page of data flows. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DataFlowSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of all data flows in a project or folder. tags: - DataIntegration x-related-resource: '#/definitions/DataFlow' post: description: 'Creates a new data flow in a project or folder ready for performing data integrations. ' operationId: CreateDataFlow parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully created a new data flow. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataFlow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a new data flow object for specifying the data transformations that need to performed. tags: - DataIntegration x-related-resource: '#/definitions/DataFlow' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDataFlowDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateDataFlowDetails' description: The details needed to create a new data flow. required: true /workspaces/{workspaceId}/dataFlows/{dataFlowKey}: delete: description: Removes a data flow from a project or folder using the specified identifier. operationId: DeleteDataFlow parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/dataFlowKey' responses: 202: description: Successfully accepted the delete request. The data flow will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a data flow. tags: - DataIntegration x-related-resource: '#/definitions/DataFlow' get: description: Retrieves a data flow using the specified identifier. operationId: GetDataFlow parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/dataFlowKey' - $ref: '#/components/parameters/ExpandReferences' responses: 200: description: Successfully retrieved the specified data flow. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataFlow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a data flow. tags: - DataIntegration put: description: Updates a specific data flow. operationId: UpdateDataFlow parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/dataFlowKey' responses: 200: description: Successfully accepted the update request. The data flow will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataFlow' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the data flow object identified by the key. tags: - DataIntegration x-related-resource: '#/definitions/DataFlow' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDataFlowDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateDataFlowDetails' description: The details needed to updated a data flow. required: true /workspaces/{workspaceId}/disApplications: get: description: Retrieves a list of DIS Applications in a compartment and provides options to filter the list. operationId: ListDisApplications parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/NameContainsQueryParameter' - $ref: '#/components/parameters/IdentifierFilter' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FavoritesQueryParam' - description: OCID of the compartment for which the list of DIS Applications is to be retrieved. in: query name: compartmentId required: true schema: type: string responses: '200': description: Successfully retrieved a list of applications. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/DisApplicationSummaryCollection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to list DIS applications in a given compartment with filtering options. tags: - DataIntegration x-related-resource: '#/definitions/DisApplication' x-targetService: metadata post: description: 'Creates a DIS Application. ' operationId: CreateDisApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '200': description: Successfully created the DIS application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DisApplication' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to create a DIS application. tags: - DataIntegration x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDisApplicationDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateDisApplicationDetails' description: The details needed to create a DIS application. required: true /workspaces/{workspaceId}/disApplications/{applicationKey}/detailedDescription: delete: description: Deletes detailed description of an Application. operationId: DeleteDisApplicationDetailedDescription parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' responses: 202: description: Successfully accepted the delete request. The detailed description will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete detailed description of an Application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata get: description: Retrieves detailed description of an Application. operationId: GetDisApplicationDetailedDescription parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' responses: 200: description: Successfully retrieved the detailed description of specified Application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetailedDescription' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get the detailed description of an Application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata post: description: Creates detailed description for an application. operationId: CreateDisApplicationDetailedDescription parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '200': description: Successfully created detailed description for an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetailedDescription' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to create detailed description for an application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDetailedDescriptionDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateDetailedDescriptionDetails' description: Detailed description of an application. required: true put: description: Updates the detailed description of an Application. operationId: UpdateDisApplicationDetailedDescription parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/applicationKey' responses: 200: description: Successfully accepted the update request. The detailed description will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DetailedDescription' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to change the detailed description of an Application. tags: - DataIntegration x-related-resource: '#/definitions/DetailedDescription' x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDetailedDescriptionDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateDetailedDescriptionDetails' description: The details needed to update the detailed description of Application. required: true /workspaces/{workspaceId}/disApplications/{disApplicationId}: delete: description: Removes a DIS application using the specified identifier. operationId: DeleteDisApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/disApplicationId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '204': description: Successfully deleted the specified application. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 412: $ref: '#/components/responses/412' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to delete a DIS application. tags: - DataIntegration x-related-resource: '#/definitions/DisApplication' x-targetService: metadata get: description: Retrieves an application using the specified OCID. operationId: GetDisApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/disApplicationId' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved the DIS Application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DisApplication' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get a DIS application. tags: - DataIntegration x-targetService: metadata put: description: Updates a DIS Application. operationId: UpdateDisApplication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/disApplicationId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully updated an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DisApplication' 412: $ref: '#/components/responses/412' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to update a DIS application. tags: - DataIntegration x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDisApplicationDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateDisApplicationDetails' description: The details needed to update an application. required: true /workspaces/{workspaceId}/disApplications/{disApplicationId}/actions/changeCompartment: post: description: 'Moves a DIS Application to a specified compartment. ' operationId: ChangeDisApplicationCompartment parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/disApplicationId' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Successfully moved the DIS Application to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to move a DIS Application to reside in a specified compartment. tags: - DataIntegration x-related-resource: '#/definitions/DisApplication' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDisApplicationCompartmentDetails' multipart/form-data: schema: $ref: '#/components/schemas/ChangeDisApplicationCompartmentDetails' description: The information needed to move a DIS Application to a specified compartment. required: true /workspaces/{workspaceId}/disApplications/{disApplicationId}/taskRunLineages: get: description: 'This endpoint can be used to list Task Run Lineages within a given time window. ' operationId: ListDisApplicationTaskRunLineages parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/disApplicationId' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FilterListQueryParameter' - $ref: '#/components/parameters/TimeUpdatedGreaterThanQueryParam' - $ref: '#/components/parameters/TimeUpdatedGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/TimeUpdatedLessThanQueryParam' - $ref: '#/components/parameters/TimeUpdatedLessThanOrEqualToQueryParam' responses: 200: description: A page of TaskRunLineage objects. headers: opc-next-page: description: 'For pagination of a list of `TaskRunLineage`s. If this header appears in the response, then this is a partial list of TaskRunLineage. Include this value as the `page` parameter in a subsequent GET request to get the next batch of TaskRunLineages. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskRunLineageSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists Task Run Lineages with filtering options. tags: - DataIntegration x-feature-id: Orchestration x-related-resource: '#/definitions/TaskRunLineageSummaryCollection' /workspaces/{workspaceId}/exportRequests: get: description: 'This endpoint can be used to get the list of export object requests. ' operationId: ListExportRequests parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/ExportStatusQueryParameter' - $ref: '#/components/parameters/GetExportObjectProjection' - $ref: '#/components/parameters/TimeStartedQueryParam' - $ref: '#/components/parameters/TimeEndedQueryParam' responses: 200: description: List export object requests. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExportRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List export object requests. tags: - DataIntegration x-targetService: metadata post: description: Export Metadata Object operationId: CreateExportRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/workspaceId' responses: 202: description: Successfully accepted the export object request. Returned export object request summary. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExportRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to export objects tags: - DataIntegration x-example: "Example: Create an export of an object and overwrite the file.\nPOST /20200430/workspaces/<workspace_id>/exportRequests HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"bucketName\":\"your_bucket_name\",\n \"objectStorageRegion\":\"us-ashburn-1\",\n \"objectStorageTenancyId\":\"ocid1.tenancy.oc1..tbd\",\n \"fileName\":\"your_filename.zip\",\n \"areReferencesIncluded\":true,\n \"isObjectOverwriteEnabled\":true,\n \"objecKeys\":[\"your_object_key_to_export\"]\n}\n" x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExportRequestDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateExportRequestDetails' description: The details needed to export metadata object. required: true /workspaces/{workspaceId}/exportRequests/{exportRequestKey}: delete: description: 'Delete export object request using the specified identifier. ' operationId: DeleteExportRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/exportRequestKey' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: Successfully deleted the export request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete export object request. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' x-targetService: metadata-service get: description: 'This endpoint can be used to get the summary/details of object being exported. ' operationId: GetExportRequest parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/exportRequestKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Export metadata object request summary/details. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExportRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get export object request summary/details by key. tags: - DataIntegration x-targetService: metadata put: description: Updates the status of a export object request. operationId: UpdateExportRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/exportRequestKey' responses: 200: description: Successfully updates the export request, typically to terminate the export. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExportRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to change the status of a export object request. For example, cancel a export object request. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExportRequestDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateExportRequestDetails' description: The details needed to update the status of a export object request. required: true /workspaces/{workspaceId}/folders: get: description: 'Retrieves a list of folders in a project and provides options to filter the list. ' operationId: ListFolders parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/AggregatorQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/NameContainsQueryParameter' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a page of folders. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/FolderSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list the folders in a project. tags: - DataIntegration x-related-resource: '#/definitions/Folder' x-targetService: metadata-service post: description: 'Creates a folder in a project or in another folder, limited to two levels of folders. | Folders are used to organize your design-time resources, such as tasks or data flows. ' operationId: CreateFolder parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully created a folder. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Folder' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a folder. tags: - DataIntegration x-related-resource: '#/definitions/Folder' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFolderDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateFolderDetails' description: The details needed to create a folder. required: true /workspaces/{workspaceId}/folders/{folderKey}: delete: description: Removes a folder from a project using the specified identifier. operationId: DeleteFolder parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/folderKey' responses: 202: description: Successfully accepted the delete request. The folder will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a `Folder` object. tags: - DataIntegration x-related-resource: '#/definitions/Folder' x-targetService: metadata-service get: description: Retrieves a folder using the specified identifier. operationId: GetFolder parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/folderKey' - $ref: '#/components/parameters/GetProjection' responses: 200: description: Successfully retrieved the specified folder. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Folder' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a folder using its key. tags: - DataIntegration put: description: Updates a specific folder. operationId: UpdateFolder parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/folderKey' responses: 200: description: Successfully accepted the update request. The folder will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Folder' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the `Folder` object identified by its key. tags: - DataIntegration x-related-resource: '#/definitions/Folder' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFolderDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateFolderDetails' description: The details needed to update a folder. required: true /workspaces/{workspaceId}/functionLibraries: get: description: 'Retrieves a list of function libraries in a project and provides options to filter the list. ' operationId: ListFunctionLibraries parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/AggregatorQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: Successfully retrieved a page of functionLibraries. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/FunctionLibrarySummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list the function libraries in a project. tags: - DataIntegration x-related-resource: '#/definitions/FunctionLibrary' post: description: 'Creates a function library in a project or in another function library, limited to two levels of function libraries. | FunctionLibraries are used to organize your design-time resources, such as tasks or data flows. ' operationId: CreateFunctionLibrary parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully created a functionLibrary. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/FunctionLibrary' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a function Library. tags: - DataIntegration x-related-resource: '#/definitions/FunctionLibrary' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFunctionLibraryDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateFunctionLibraryDetails' description: The details needed to create a function Library. required: true /workspaces/{workspaceId}/functionLibraries/{functionLibraryKey}: delete: description: Removes a Function Library from a project using the specified identifier. operationId: DeleteFunctionLibrary parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/functionLibraryKey' responses: 204: description: Successfully accepted the delete request. The Function Library is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a `FunctionLibrary` object. tags: - DataIntegration x-related-resource: '#/definitions/FunctionLibrary' get: description: Retrieves a Function Library using the specified identifier. operationId: GetFunctionLibrary parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/functionLibraryKey' - $ref: '#/components/parameters/GetProjection' responses: 200: description: Successfully retrieved the specified Function Library. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/FunctionLibrary' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a Function Library using its key. tags: - DataIntegration put: description: Updates a specific Function Library. operationId: UpdateFunctionLibrary parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/functionLibraryKey' responses: 200: description: Successfully accepted the update request. The Function Library will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/FunctionLibrary' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the `FunctionLibrary` object identified by its key. tags: - DataIntegration x-related-resource: '#/definitions/FunctionLibrary' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFunctionLibraryDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateFunctionLibraryDetails' description: The details needed to update a FunctionL ibrary. required: true /workspaces/{workspaceId}/importRequests: get: description: 'This endpoint can be used to get the list of import object requests. ' operationId: ListImportRequests parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/ImportStatusQueryParameter' - $ref: '#/components/parameters/GetImportObjectProjection' - $ref: '#/components/parameters/TimeStartedQueryParam' - $ref: '#/components/parameters/TimeEndedQueryParam' responses: 200: description: List import object requests. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImportRequestSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List import object requests. tags: - DataIntegration x-targetService: metadata post: description: Import Metadata Object operationId: CreateImportRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/workspaceId' responses: 202: description: Successfully accepted the import object request. Returned import object request summary. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImportRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to import an object tags: - DataIntegration x-example: "Example: Create an import of a file and retain existing objects.\nPOST /20200430/workspaces/<workspace_id>/importRequests HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"bucketName\":\"your_bucket_name\",\n \"fileName\":\"your_filename.zip\",\n \"objectStorageTenancyId\":\"ocid1.tenancy.oc1..tbd\",\n \"objectStorageRegion\": \"us-ashburn-1\",\n \"objectKeyForImport\": null,\n \"importConflictResolution\": {\n \"importConflictResolutionType\": \"RETAIN\"\n }\n}\n" x-targetService: metadata requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateImportRequestDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateImportRequestDetails' description: The details needed to import metadata object. required: true /workspaces/{workspaceId}/importRequests/{importRequestKey}: delete: description: 'Delete import object request using the specified identifier. ' operationId: DeleteImportRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/importRequestKey' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: Successfully deleted the import request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete import object request. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' x-targetService: metadata-service get: description: 'This endpoint can be used to get the summary/details of object being imported. ' operationId: GetImportRequest parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/importRequestKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' responses: 200: description: Import metadata object request summary/details. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImportRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get import object request summary/details by key. tags: - DataIntegration x-targetService: metadata put: description: Updates the status of a import object request. operationId: UpdateImportRequest parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/importRequestKey' responses: 200: description: Successfully updates the import request, typically to terminate the import. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ImportRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to change the status of a import object request. For example, cancel a import object request. tags: - DataIntegration x-related-resource: '#/definitions/Workspace' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateImportRequestDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateImportRequestDetails' description: The details needed to update the status of a import object request. required: true /workspaces/{workspaceId}/pipelineValidations: get: description: Retrieves a list of pipeline validations within the specified workspace. operationId: ListPipelineValidations parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/KeyQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a list of pipeline validations. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PipelineValidationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of pipeline validations. tags: - DataIntegration x-related-resource: '#/definitions/PipelineValidation' post: description: 'Accepts the data flow definition in the request payload and creates a pipeline validation. ' operationId: CreatePipelineValidation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully processed the validation request. The migration definition along with a list of validation results is returned. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PipelineValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to execute a pipeline validation. tags: - DataIntegration x-related-resource: '#/definitions/PipelineValidation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePipelineValidationDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreatePipelineValidationDetails' description: The information needed to create the data flow validation for the pipeline object. required: true /workspaces/{workspaceId}/pipelineValidations/{pipelineValidationKey}: delete: description: Removes a pipeline validation using the specified identifier. operationId: DeletePipelineValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/pipelineValidationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the pipeline validation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a pipeline validation. tags: - DataIntegration x-related-resource: '#/definitions/PipelineValidation' get: description: Retrieves a pipeline validation using the specified identifier. operationId: GetPipelineValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/pipelineValidationKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the specified pipeline validation. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PipelineValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to gets a pipeline validation using the specified identifier. tags: - DataIntegration x-related-resource: '#/definitions/PipelineValidation' /workspaces/{workspaceId}/pipelines: get: description: 'Retrieves a list of pipelines in a project or folder from within a workspace, the query parameter specifies the project or folder. ' operationId: ListPipelines parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/AggregatorQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a page of pipelines. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/PipelineSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of all pipelines in a project or folder within a workspace. tags: - DataIntegration x-related-resource: '#/definitions/Pipeline' post: description: 'Creates a new pipeline in a project or folder ready for performing task orchestration. ' operationId: CreatePipeline parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully created a new pipeline. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a new pipeline object for specifying the orchestration operations that need to performed. tags: - DataIntegration x-related-resource: '#/definitions/Pipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePipelineDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreatePipelineDetails' description: The details needed to create a new pipeline. required: true /workspaces/{workspaceId}/pipelines/{pipelineKey}: delete: description: Removes a pipeline from a project or folder using the specified identifier. operationId: DeletePipeline parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/pipelineKey' responses: 202: description: Successfully accepted the delete request. The pipeline will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a pipeline. tags: - DataIntegration x-related-resource: '#/definitions/Pipeline' get: description: Retrieves a pipeline using the specified identifier. operationId: GetPipeline parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/pipelineKey' - $ref: '#/components/parameters/ExpandReferences' responses: 200: description: Successfully retrieved the specified pipeline. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a pipeline. tags: - DataIntegration x-related-resource: '#/definitions/Pipeline' put: description: Updates a specific pipeline. operationId: UpdatePipeline parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/pipelineKey' responses: 200: description: Successfully accepted the update request. The pipeline will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pipeline' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the pipeline object identified by the key. tags: - DataIntegration x-related-resource: '#/definitions/Pipeline' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdatePipelineDetails' description: The details needed to updated a pipeline. required: true /workspaces/{workspaceId}/projects: get: description: 'Retrieves a lists of projects in a workspace and provides options to filter the list. ' operationId: ListProjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/NameContainsQueryParameter' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a page of projects. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ProjectSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list projects in the workspace. tags: - DataIntegration x-related-resource: '#/definitions/Project' x-targetService: metadata-service post: description: 'Creates a project. Projects are organizational constructs within a workspace that you use to organize your design-time resources, such as tasks or data flows. Projects can be organized into folders. ' operationId: CreateProject parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully created a project. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a project. tags: - DataIntegration x-related-resource: '#/definitions/Project' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateProjectDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateProjectDetails' description: The details needed to create a project in a workspace. required: true /workspaces/{workspaceId}/projects/{projectKey}: delete: description: Removes a project from the workspace using the specified identifier. operationId: DeleteProject parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/projectKey' responses: 202: description: Successfully accepted the delete request. The project will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a `Project` object. tags: - DataIntegration x-related-resource: '#/definitions/Project' x-targetService: metadata-service get: description: Retrieves a project using the specified identifier. operationId: GetProject parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/projectKey' - $ref: '#/components/parameters/GetProjection' responses: 200: description: Successfully retrieved the specified project. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a project using its key. tags: - DataIntegration put: description: Updates a specific project. operationId: UpdateProject parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/projectKey' responses: 200: description: Successfully accepted the update request. The project will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Project' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the `Project` object identified by the key. tags: - DataIntegration x-related-resource: '#/definitions/Project' x-targetService: metadata-service requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProjectDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateProjectDetails' description: The details needed to update a project. required: true /workspaces/{workspaceId}/taskValidations: get: description: 'Retrieves a list of task validations within the specified workspace. ' operationId: ListTaskValidations parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/KeyQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a list of task validations. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/TaskValidationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of task validations. tags: - DataIntegration x-related-resource: '#/definitions/TaskValidation' post: description: Validates a specific task. operationId: CreateTaskValidation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/CreateTaskValidationDetails' responses: 200: description: Successfully validated the specified task. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskValidation' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Use this endpoint to validate a task. tags: - DataIntegration /workspaces/{workspaceId}/taskValidations/{taskValidationKey}: delete: description: 'Removes a task validation using the specified identifier. ' operationId: DeleteTaskValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/TaskValidationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the task validation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a task validation. tags: - DataIntegration x-related-resource: '#/definitions/TaskValidation' get: description: 'Retrieves a task validation using the specified identifier. ' operationId: GetTaskValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/TaskValidationKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the specified validation. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TaskValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a task validation using the specified identifier. tags: - DataIntegration x-related-resource: '#/definitions/TaskValidation' /workspaces/{workspaceId}/tasks: get: description: 'Retrieves a list of all tasks in a specified project or folder. ' operationId: ListTasks parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/FolderKeyQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/KeyListQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/TypeListQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a page of tasks. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/TaskSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of all tasks in a specified project or folder. tags: - DataIntegration x-related-resource: '#/definitions/Task' post: description: 'Creates a new task ready for performing data integrations. There are specialized types of tasks that include data loader and integration tasks. ' operationId: CreateTask parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully created the task. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Task' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a new task. Tasks can be data loading tasks or integration tasks. tags: - DataIntegration x-example: "Example: Create a REST Task.\nPOST /20200430/workspaces/<workspace_id>/tasks HTTP/1.1\nHost: dataintegration.us-ashburn-1.oraclecloud.com\n<authorization and other headers>\n{\n \"modelType\": \"REST_TASK\",\n \"name\": \"Execute OCI POST API and Poll\",\n \"description\": \"Execute a POST REST API. This fits a very specific OCI pattern for REST calls. One thing to note, is that the attribute used in the poll is hard-wired right now as the attribute id in the response.\",\n \"identifier\": \"EXECUTE_OCI_POST_API_AND_POLL\",\n \"parameters\": [\n {\n \"modelType\": \"PARAMETER\",\n \"type\": \"Seeded:/typeSystems/PLATFORM/dataTypes/STRING\",\n \"configValues\": {\n \"configParamValues\": {\n \"length\": { \"intValue\": 255 }\n }\n },\n \"description\": \"\",\n \"defaultValue\": \"https://abc\",\n \"isInput\": true,\n \"isOutput\": false,\n \"name\": \"URL\",\n \"typeName\": \"STRING\"\n },\n {\n \"modelType\": \"PARAMETER\",\n \"key\": \"14154173-021f-4f6b-92f8-0757e8543a45\",\n \"type\": {\n \"modelType\": \"JAVA_TYPE\",\n \"javaTypeName\": \"com.oracle.dicom.model.dataformat.JsonText\"\n },\n \"description\": \"POST API Request Body\",\n \"isInput\": true,\n \"isOutput\": false,\n \"name\": \"REQUEST_BODY\",\n \"rootObjectDefaultValue\": {\n \"modelType\": \"JSON_TEXT\",\n \"encoded\": false,\n \"configValues\": {\n \"configParamValues\": {\n \"dataParam\": { \"stringValue\": \"{}\" }\n }\n }\n },\n \"typeName\": \"com.oracle.dicom.model.dataformat.JsonText\"\n },\n {\n \"modelType\": \"PARAMETER\",\n \"type\": \"Seeded:/typeSystems/PLATFORM/dataTypes/STRING\",\n \"configValues\": {\n \"configParamValues\": {\n \"length\": { \"intValue\": 255 }\n }\n },\n \"description\": \"\",\n \"defaultValue\": \"https://abc\",\n \"isInput\": true,\n \"isOutput\": false,\n \"name\": \"POLL_URL\",\n \"typeName\": \"STRING\"\n },\n {\n \"modelType\": \"PARAMETER\",\n \"key\": \"e9000971-ce45-4423-874f-719293fe41c4\",\n \"type\": {\n \"modelType\": \"JAVA_TYPE\",\n \"javaTypeName\": \"com.oracle.dicom.model.expression.Expression\"\n },\n \"description\": \"\",\n \"defaultValue\": \"SYS.RESPONSE_STATUS >= 200 AND SYS.RESPONSE_STATUS < 300\",\n \"isInput\": true,\n \"isOutput\": false,\n \"name\": \"SUCCESS_CONDITION\",\n \"typeName\": \"com.oracle.dicom.model.expression.Expression\"\n },\n {\n \"modelType\": \"PARAMETER\",\n \"key\": \"5088c60a-f85c-4741-94e5-5edf8bb4f9a5\",\n \"type\": {\n \"modelType\": \"JAVA_TYPE\",\n \"javaTypeName\": \"com.oracle.dicom.model.expression.Expression\"\n },\n \"description\": \"\",\n \"defaultValue\": \"CAST(json_path(SYS.RESPONSE_PAYLOAD, '$.lifecycleState') AS String) != 'SUCCEEDED' AND CAST(json_path(SYS.RESPONSE_PAYLOAD, '$.lifecycleState') AS String) != 'FAILED'\",\n \"isInput\": true,\n \"isOutput\": false,\n \"name\": \"POLL_CONDITION\",\n \"typeName\": \"com.oracle.dicom.model.expression.Expression\"\n }\n ],\n \"opConfigValues\": {\n \"configParamValues\": {\n \"successCondition\": { \"parameterValue\": \"e9000971-ce45-4423-874f-719293fe41c4\" }\n }\n },\n \"executeRestCallConfig\": {\n \"modelType\": \"REST_CALL_CONFIG\",\n \"key\": \"7b2af7c3-ca47-4724-ae6c-a20cf978d70f\",\n \"methodType\": \"POST\",\n \"requestHeaders\": { \"Content-Type\": \"application/json\" },\n \"configValues\": {\n \"configParamValues\": {\n \"requestURL\": { \"stringValue\": \"${URL}\" },\n \"requestPayload\": { \"parameterValue\": \"14154173-021f-4f6b-92f8-0757e8543a45\" }\n }\n }\n },\n \"cancelRestCallConfig\": {\n \"modelType\": \"REST_CALL_CONFIG\",\n \"methodType\": \"DELETE\"\n },\n \"pollRestCallConfig\": {\n \"modelType\": \"POLL_REST_CALL_CONFIG\",\n \"methodType\": \"GET\",\n \"configValues\": {\n \"configParamValues\": {\n \"pollMaxDuration\": { \"objectValue\": 120 },\n \"pollMaxDurationUnit\": { \"stringValue\": \"SECONDS\" },\n \"pollInterval\": { \"objectValue\": 60 },\n \"pollIntervalUnit\": { \"stringValue\": \"SECONDS\" },\n \"requestURL\": { \"stringValue\": \"${POLL_URL}\" },\n \"pollCondition\": { \"parameterValue\": \"5088c60a-f85c-4741-94e5-5edf8bb4f9a5\" }\n }\n }\n },\n \"typedExpressions\": [\n {\n \"modelType\": \"TYPED_EXPRESSION\",\n \"type\": \"Seeded:/typeSystems/PLATFORM/dataTypes/VARCHAR\",\n \"configValues\": {\n \"configParamValues\": {\n \"length\": { \"intValue\": 2000 }\n }\n },\n \"expression\": \"CAST(json_path(SYS.RESPONSE_PAYLOAD, '$.id') AS String)\\t\",\n \"name\": \"ID\"\n }\n ],\n \"apiCallMode\": \"ASYNC_GENERIC\",\n \"authConfig\": {\n \"modelType\": \"OCI_RESOURCE_AUTH_CONFIG\",\n \"resourcePrincipalSource\": \"WORKSPACE\"\n },\n \"registryMetadata\": {\n \"aggregatorKey\": \"your_project_key\"\n } \n}\n" x-related-resource: '#/definitions/Task' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTaskDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateTaskDetails' description: The details needed to create a new task. required: true /workspaces/{workspaceId}/tasks/{taskKey}: delete: description: Removes a task using the specified identifier. operationId: DeleteTask parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' responses: 202: description: Successfully accepted the delete request. The task will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a task. tags: - DataIntegration x-related-resource: '#/definitions/Task' get: description: Retrieves a task using the specified identifier. operationId: GetTask parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/ExpandReferences' responses: 200: description: Successfully retrieved the specified task. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Task' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a task. tags: - DataIntegration put: description: Updates a specific task. For example, you can update the task description or move the task to a different folder by changing the `aggregatorKey` to a different folder in the registry. operationId: UpdateTask parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' responses: 200: description: Sucessfully accepted the update request. The task will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Task' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update a task. tags: - DataIntegration x-related-resource: '#/definitions/Task' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTaskDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateTaskDetails' description: The details needed to update a task. required: true /workspaces/{workspaceId}/tasks/{taskKey}/externalPublicationValidations: get: description: 'Retrieves a lists of external publication validations in a workspace and provides options to filter the list. ' operationId: ListExternalPublicationValidations parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: Successfully retrieved a page of external publication validations. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ExternalPublicationValidationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to list external publication validations in the workspace. tags: - DataIntegration x-related-resource: '#/definitions/ExternalPublicationValidation' x-targetService: metadata-service post: description: Validates a specific task. operationId: CreateExternalPublicationValidation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Successfully validated the specified task. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalPublicationValidation' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Use this endpoint to validate a task that is externally published to OCI DataFlow. tags: - DataIntegration requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalPublicationValidationDetails' description: The information needed to create a task validation. required: true /workspaces/{workspaceId}/tasks/{taskKey}/externalPublicationValidations/{externalPublicationValidationKey}: delete: description: 'Removes a task validation using the specified identifier. ' operationId: DeleteExternalPublicationValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/externalPublicationValidationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the task validation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a task validation. tags: - DataIntegration x-related-resource: '#/definitions/ExternalPublicationValidation' get: description: Retrieves an external publication validation using the specified identifier. operationId: GetExternalPublicationValidation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/externalPublicationValidationKey' responses: 200: description: Successfully retrieved the specified external publication validation. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalPublicationValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a project using its key. tags: - DataIntegration /workspaces/{workspaceId}/tasks/{taskKey}/externalPublications: get: description: Retrieves a list of external publications in an application and provides options to filter the list. operationId: ListExternalPublications parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/FavoritesQueryParam' responses: '200': description: Successfully retrieved a list of publications in an OCI DataFlow application. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ExternalPublicationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to list external publication objects with filtering options. tags: - DataIntegration x-related-resource: '#/definitions/ExternalPublication' post: description: Publish a DataFlow in a OCI DataFlow application. operationId: CreateExternalPublication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: '200': description: Successfully created an externalObject in an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalPublication' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to publish a task in a OCI Data Flow Application. tags: - DataIntegration x-related-resource: '#/definitions/ExternalPublication' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateExternalPublicationDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateExternalPublicationDetails' description: Details needed to publish a task to OCI DataFlow application. required: true /workspaces/{workspaceId}/tasks/{taskKey}/externalPublications/{externalPublicationsKey}: delete: description: Removes a published object using the specified identifier. operationId: DeleteExternalPublication parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/externalPublicationsKey' responses: 202: description: Successfully accepted the delete request. The patch will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a published object. tags: - DataIntegration x-related-resource: '#/definitions/ExternalPublication' get: description: Retrieves a publshed object in an task using the specified identifier. operationId: GetExternalPublication parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/externalPublicationsKey' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: Successfully retrieved a patch in an application. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalPublication' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Use this endpoint to get an externalPublished object in an application. tags: - DataIntegration x-related-resource: '#/definitions/ExternalPublication' put: description: Updates the external publication object. operationId: UpdateExternalPublication parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/taskKey' - $ref: '#/components/parameters/externalPublicationsKey' responses: 200: description: Accepted the request. The external daatflow publication object will be updated. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExternalPublication' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the external publication object identified by the key. tags: - DataIntegration x-related-resource: '#/definitions/ExternalPublication' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExternalPublicationDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateExternalPublicationDetails' description: The information to be updated. required: true /workspaces/{workspaceId}/templates: get: description: This endpoint can be used to list application templates with filtering options. operationId: ListTemplates parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierFilter' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PageNumberQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: List of application templates. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/TemplateSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Lists application templates with filtering options. tags: - DataIntegration x-related-resource: '#/definitions/Template' /workspaces/{workspaceId}/templates/{templateId}: get: description: This endpoint can be used to get an application template using a key. operationId: GetTemplate parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/templateId' - $ref: '#/components/parameters/RequestIdHeader' responses: '200': description: An application template. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Template' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: description: Unexpected Error. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' summary: Gets an application template. tags: - DataIntegration /workspaces/{workspaceId}/userDefinedFunctionValidations: get: description: Retrieves a list of UserDefinedFunctionvalidations within the specified workspace. operationId: ListUserDefinedFunctionValidations parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/KeyQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved a list of UserDefinedFunction validations. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/UserDefinedFunctionValidationSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of UserDefinedFunction validations. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunctionValidation' post: description: 'Accepts the UserDefinedFunction definition in the request payload and creates a UserDefinedFunction validation. ' operationId: CreateUserDefinedFunctionValidation parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully processed the validation request. The validation results are returned. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserDefinedFunctionValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to execute a UserDefinedFunction validation. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunctionValidation' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserDefinedFunctionValidationDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateUserDefinedFunctionValidationDetails' description: The information needed to create the UserDefinedFunction validation for the UserDefinedFunction object. required: true /workspaces/{workspaceId}/userDefinedFunctionValidations/{userDefinedFunctionValidationKey}: delete: description: Removes a UserDefinedFunction validation using the specified identifier. operationId: DeleteUserDefinedFunctionValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/userDefinedFunctionValidationKey' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Successfully deleted the UserDefinedFunction validation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a UserDefinedFunction validation. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunctionValidation' get: description: Retrieves a UserDefinedFunction validation using the specified identifier. operationId: GetUserDefinedFunctionValidation parameters: - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/userDefinedFunctionValidationKey' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the specified UserDefinedFunction validation. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserDefinedFunctionValidation' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to gets a UserDefinedFunction validation using the specified identifier. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunctionValidation' /workspaces/{workspaceId}/userDefinedFunctions: get: description: 'Retrieves a list of UserDefinedFunctions in a function library. ' operationId: ListUserDefinedFunctions parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/FunctionLibraryKeyQueryParam' - $ref: '#/components/parameters/FieldsQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/IdentifierListQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/FavoritesQueryParam' responses: 200: description: Successfully retrieved a page of UserDefinedFunctions. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'Total items in the entire list. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/UserDefinedFunctionSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a list of all UserDefinedFunctions in a project or function library. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunction' post: description: 'Creates a new UserDefinedFunction in a function library ready for performing data integrations. ' operationId: CreateUserDefinedFunction parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' responses: 200: description: Successfully created a new UserDefinedFunction. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserDefinedFunction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to create a new UserDefinedFunction object for specifying the data transformations that need to performed. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunction' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateUserDefinedFunctionDetails' multipart/form-data: schema: $ref: '#/components/schemas/CreateUserDefinedFunctionDetails' description: The details needed to create a new UserDefinedFunction. required: true /workspaces/{workspaceId}/userDefinedFunctions/{userDefinedFunctionKey}: delete: description: Removes a UserDefinedFunction from a function library using the specified identifier. operationId: DeleteUserDefinedFunction parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/userDefinedFunctionKey' responses: 204: description: Successfully accepted the delete request. The UserDefinedFunction is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to delete a UserDefinedFunction. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunction' get: description: Retrieves a UserDefinedFunction using the specified identifier. operationId: GetUserDefinedFunction parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/userDefinedFunctionKey' responses: 200: description: Successfully retrieved the specified UserDefinedFunction. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserDefinedFunction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to get a UserDefinedFunction. tags: - DataIntegration put: description: Updates a specific UserDefinedFunction. operationId: UpdateUserDefinedFunction parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/workspaceId' - $ref: '#/components/parameters/userDefinedFunctionKey' responses: 200: description: Successfully accepted the update request. The UserDefinedFunction will be updated. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UserDefinedFunction' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Use this endpoint to update the UserDefinedFunction object identified by the key. tags: - DataIntegration x-related-resource: '#/definitions/UserDefinedFunction' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUserDefinedFunctionDetails' multipart/form-data: schema: $ref: '#/components/schemas/UpdateUserDefinedFunctionDetails' description: The details needed to updated a UserDefinedFunction. required: true components: parameters: NameQueryParam: description: Used to filter by the name of the object. in: query name: name required: false x-default-description: If no name filter is specified, all names will be processed. schema: type: string TimeUpdatedLessThanQueryParam: description: This parameter allows users to get objects which were updated before a certain time. The format of timeUpatedLessThan is "YYYY-MM-dd'T'HH:mm:ss.SSS'Z'" in: query name: timeUpatedLessThan required: false x-default-description: If no TimeUpdatedLessThanQueryParam is specified, then all Objects are considered irrespective of the time they are updated. schema: type: string format: date-time IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the `etag` from a previous GET or POST response for that resource. The resource will be updated or deleted only if the `etag` you provide matches the resource''s current `etag` value. When ''if-match'' is provided and its value does not exactly match the ''etag'' of the resource on the server, the request fails with the 412 response code. ' in: header name: if-match required: false schema: type: string taskKey: description: The task key. in: path name: taskKey required: true schema: type: string maxLength: 36 minLength: 1 ConnectionValidationKey: description: The key of the connection validation. in: path name: connectionValidationKey required: true schema: type: string maxLength: 36 minLength: 1 AggregatorKeyCompositeStateQueryParam: description: Unique key of the aggregator for which we want to get the Composite State in: query name: aggregatorKey required: true schema: type: string TaskValidationKey: description: The task validation key. in: path name: taskValidationKey required: true schema: type: string maxLength: 36 minLength: 1 LifecycleStateQueryParam: description: The lifecycle state of a resource. When specified, the operation only returns resources that match the given lifecycle state. When not specified, all lifecycle states are processed as a match. in: query name: lifecycleState required: false x-default-description: If not specified in query, all lifecycle states are processed as a match. x-obmcs-enumref: '#/definitions/Workspace/lifecycleState' schema: type: string TypeFilter: description: 'Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. For Data Integration APIs, a filter based on type Task is used. ' in: query name: type required: false style: form explode: true schema: type: array items: type: string default: [] FieldsQueryParam: description: Specify the value 'metadata' to retrieve minimal information for example when listing published objects. This uses fewer system resources, leading to faster retrieval times. in: query name: fields required: false style: form explode: true schema: type: array items: type: string default: [] QuiesceTimeoutQueryParam: description: Used to set the timeout for Data Integration to gracefully close down any running jobs before stopping the workspace. in: query name: quiesceTimeout required: false schema: type: integer format: int64 default: 0 minimum: 0 TimeUpdatedGreaterThanQueryParam: description: This parameter allows users to get objects which were updated after a certain time. The format of timeUpdatedGreaterThan is "YYYY-MM-dd'T'HH:mm:ss.SSS'Z'" in: query name: timeUpdatedGreaterThan required: false x-default-description: If no TimeUpdatedGreaterThanQueryParam is specified, then all Objects are considered irrespective of the time they are updated. schema: type: string format: date-time AggregatorTypeListQueryParam: description: Unique type of the aggregator in: query name: aggregatorType required: false x-default-description: No aggregator type filter, all types will be processed. style: form explode: true schema: type: array items: type: string default: [] TimeUpdatedGreaterThanOrEqualToQueryParam: description: This parameter allows users to get objects which were updated after and at a certain time. The format of timeUpdatedGreaterThanOrEqualTo is "YYYY-MM-dd'T'HH:mm:ss.SSS'Z'" in: query name: timeUpdatedGreaterThanOrEqualTo required: false x-default-description: If no TimeUpdatedGreaterThanOrEqualToQueryParam is specified, then all Objects are considered irrespective of the time they are updated. schema: type: string format: date-time TypeListQueryParam: description: Used to filter by the object type of the object. It can be suffixed with an optional filter operator InSubtree. If this operator is not specified, then exact match is considered.

Examples:
in: query name: type required: false style: form explode: true schema: type: array items: type: string default: [] SchemaResourceName: description: The schema resource name used for retrieving schemas. in: path name: schemaResourceName required: true x-default-description: If the schema resource name filter is not specifed, all schemas will be processed. schema: type: string TimeStartedQueryParam: description: Specifies start time of a copy object request. in: query name: timeStartedInMillis required: false x-default-description: If no value is specified, all requests will be considered from first request. schema: type: integer format: int64 PaginationLimitQueryParam: description: Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: limit schema: type: integer default: 20 maximum: 1000 minimum: 1 CreateConnectionValidationDetails: description: The information needed to validate a connection. in: body name: CreateConnectionValidationDetails required: true schema: $ref: '#/components/schemas/CreateConnectionValidationDetails' IncludeTypesQueryParam: description: Artifact type which needs to be listed while listing Artifacts. in: query name: includeTypes required: false x-default-description: No types filter, all types will be processed. style: form explode: true schema: type: array items: type: string ImportStatusQueryParameter: description: Specifies import status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . in: query name: importStatus required: false x-default-description: If no status is specified, all imports will be processed. schema: type: string enum: - IN_PROGRESS - SUCCESSFUL - QUEUED - TERMINATING - TERMINATED - FAILED ToPatchQueryParam: description: Specifies the patch key to query to. in: query name: toPatch required: false x-default-description: If not specified in query, all patches are processed as a match. schema: type: string userDefinedFunctionKey: description: The user defined function key. in: path name: userDefinedFunctionKey required: true schema: type: string maxLength: 36 minLength: 0 SortOrderQueryParam: description: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending). in: query name: sortOrder required: false schema: type: string enum: - ASC - DESC default: DESC referenceKey: description: The reference key. in: path name: referenceKey required: true schema: type: string maxLength: 36 minLength: 1 externalPublicationsKey: description: The external published object key. in: path name: externalPublicationsKey required: true schema: type: string maxLength: 36 minLength: 1 WorkRequestStatusQueryParam: description: The work request status. in: query name: workRequestStatus required: false x-default-description: If not specified in query, all work request states are processed as a match. schema: type: string enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED WorkRequestIdPathParam: description: The ID of the asynchronous work request to retrieve. in: path name: workRequestId required: true schema: type: string dataFlowKey: description: The data flow key. in: path name: dataFlowKey required: true schema: type: string maxLength: 36 minLength: 0 FilterQueryParam: description: This filter parameter can be used to filter by name field of the Schedule object

Examples:-
in: query name: filter required: false x-default-description: If no filter query is specified, all objects will be processed. style: form explode: true schema: type: array items: type: string default: [] projectKey: description: The project key. in: path name: projectKey required: true schema: type: string maxLength: 36 minLength: 1 NameStartsWithQueryParam: description: This parameter can be used to filter objects by the names starting with the given value. in: query name: nameStartsWith required: false x-default-description: If no nameStartsWith filter is specified, all names will be processed. schema: type: string AggregatorQueryParam: description: 'Used to filter by the project or the folder object. ' in: query name: aggregatorKey required: false x-default-description: If no project key is specified, all projects will be processed. schema: type: string CreateTaskValidationDetails: description: The information needed to create a task validation. in: body name: CreateTaskValidationDetails required: true schema: $ref: '#/components/schemas/CreateTaskValidationDetails' disApplicationId: description: The OCID of the DIS Application. in: path name: disApplicationId required: true schema: type: string FavoritesQueryParam: description: If value is FAVORITES_ONLY, then only objects marked as favorite by the requesting user will be included in result. If value is NON_FAVORITES_ONLY, then objects marked as favorites by the requesting user will be skipped. If value is ALL or if not specified, all objects, irrespective of favorites or not will be returned. Default is ALL. in: query name: favoritesQueryParam required: false schema: type: string enum: - FAVORITES_ONLY - NON_FAVORITES_ONLY - ALL default: ALL DataEntityKey: description: The key of the data entity. in: path name: dataEntityKey required: true schema: type: string maxLength: 1000 minLength: 1 CompartmentIdQueryParam: description: The OCID of the compartment containing the resources you want to list. in: query name: compartmentId required: true schema: type: string publishedObjectKey: description: The published object key. in: path name: publishedObjectKey required: true schema: type: string maxLength: 36 minLength: 1 IdentifierListQueryParam: description: Used to filter by the identifier of the object. in: query name: identifier required: false style: form explode: true schema: type: array items: type: string default: [] templateId: description: The OCID of the template. in: path name: templateId required: true schema: type: string CopyStatusQueryParameter: description: Specifies copy status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . in: query name: copyStatus required: false schema: type: string enum: - IN_PROGRESS - SUCCESSFUL - QUEUED - TERMINATING - TERMINATED - FAILED - ALL default: ALL importRequestKey: description: The key of the object export object request in: path name: importRequestKey required: true schema: type: string maxLength: 36 minLength: 1 DataAssetKey: description: The data asset key. in: path name: dataAssetKey required: true schema: type: string maxLength: 36 minLength: 1 IdentifierFilter: description: 'Used to filter by the identifier of the published object. ' in: query name: identifier required: false style: form explode: true schema: type: array items: type: string default: [] folderKey: description: The folder key. in: path name: folderKey required: true schema: type: string maxLength: 36 minLength: 0 scheduleKey: description: Schedule Key in: path name: scheduleKey required: true schema: type: string workspaceIdQueryParam: description: DIS workspace id in: query name: workspaceId required: false schema: type: string default: '' CreateConnectionDetails: description: The information needed to create a connection. in: body name: CreateConnectionDetails required: true schema: $ref: '#/components/schemas/CreateConnectionDetails' IdentifierQueryParam: description: Used to filter by the identifier of the object. in: query name: identifier required: false x-default-description: If no identifier filter is specified, all identifiers will be processed. schema: type: string patchKey: description: The patch key. in: path name: patchKey required: true schema: type: string maxLength: 36 minLength: 1 TypeInSubtree: description: 'Used in association with type parameter. If value is true, then type all sub types of the given type parameter is considered. If value is false, then sub types are not considered. Default is false. ' in: query name: typeInSubtree required: false schema: type: string default: [] ExportStatusQueryParameter: description: Specifies export status to use, either - ALL, SUCCESSFUL, IN_PROGRESS, QUEUED, FAILED . in: query name: exportStatus required: false x-default-description: If no status is specified, all exports will be processed. schema: type: string enum: - IN_PROGRESS - SUCCESSFUL - QUEUED - TERMINATING - TERMINATED - FAILED runtimeOperatorKey: description: Runtime Operator Key in: path name: runtimeOperatorKey required: true schema: type: string TypeQueryParam: description: Type of the object to filter the results with. in: query name: type required: false x-default-description: If no type filter is specified, all types will be processed. schema: type: string CreateDataAssetDetails: description: The information needed to create a data asset. in: body name: CreateDataAssetDetails required: true schema: $ref: '#/components/schemas/CreateDataAssetDetails' taskScheduleKey: description: TaskSchedule Key in: path name: taskScheduleKey required: true schema: type: string workspaceId: description: The workspace ID. in: path name: workspaceId required: true schema: type: string LimitQueryParam: description: Sets the maximum number of results per page, or items to return in a paginated `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: limit required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 GetExportObjectProjection: description: This parameter allows users to specify which view of the export object response to return. SUMMARY - Summary of the export object request will be returned. This is the default option when no value is specified. DETAILS - Details of export object request will be returned. This will include details of all the objects to be exported. in: query name: projection required: false schema: type: string enum: - SUMMARY - DETAILS default: SUMMARY IsPatternParam: description: This parameter can be used to specify whether entity search type is pattern search or not. in: query name: isPattern required: false x-default-description: Without isPattern param, the search will be a simple text search. schema: type: boolean default: false UpdateConnectionDetails: description: The information needed to update a connection. in: body name: UpdateConnectionDetails required: true schema: $ref: '#/components/schemas/UpdateConnectionDetails' exportRequestKey: description: The key of the object export object request in: path name: exportRequestKey required: true schema: type: string maxLength: 36 minLength: 1 FilterListQueryParameter: description: This filter parameter can be used to filter by model specific queryable fields of the object

Examples:-
in: query name: filter required: false x-default-description: If no filter query is specified, all objects will be processed. style: form explode: true schema: type: array items: type: string default: [] dataFlowValidationKey: description: The key of the dataflow validation. in: path name: dataFlowValidationKey required: true schema: type: string maxLength: 36 minLength: 1 NameContainsQueryParameter: description: This parameter can be used to filter objects by the names that match partially or fully with the given value. in: query name: nameContains required: false x-default-description: If no nameContains filter is specified, all names will be processed. schema: type: string FolderKeyQueryParam: description: Unique key of the folder. in: query name: folderId required: false x-default-description: If no folder key filter is specified, all folders will be processed. schema: type: string copyObjectRequestKey: description: The key of the object to be copied, for example this could be the key of a project. in: path name: copyObjectRequestKey required: true schema: type: string maxLength: 36 minLength: 1 PageQueryParam: description: For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: page required: false x-default-description: If no page filter is specified, results will not be paginated. schema: type: string FunctionLibraryKeyQueryParam: description: Unique key of the FunctionLibrary. in: query name: functionLibraryKey required: false x-default-description: If no Function Library key filter is specified, all function libraries will be processed. schema: type: string userDefinedFunctionValidationKey: description: The key of the userDefinedFunction validation. in: path name: userDefinedFunctionValidationKey required: true schema: type: string maxLength: 36 minLength: 1 GetCopyObjectProjection: description: This parameter allows users to specify which view of the copy object response to return. SUMMARY - Summary of the copy object response will be returned. This is the default option when no value is specified. DETAILS - Details of copy object response will be returned. This will include details of all the objects to be copied. in: query name: projection required: false schema: type: string enum: - SUMMARY - DETAILS default: SUMMARY functionLibraryKey: description: The functionLibrary key. in: path name: functionLibraryKey required: true schema: type: string maxLength: 36 minLength: 0 SchemaResourceNameQueryParam: description: Schema resource name used for retrieving schemas. in: query name: schemaResourceName required: true x-default-description: If no schema resource name filter is specified, all schemas will be processed. schema: type: string ForceOperationQueryParam: description: Used to force close down the workspace. in: query name: isForceOperation required: false schema: type: boolean default: false TimeEndedQueryParam: description: Specifies end time of a copy object request. in: query name: timeEndedInMillis required: false x-default-description: If no value is specified, all requests will be considered until last request. schema: type: integer format: int64 SincePatchQueryParam: description: Specifies the patch key to query from. in: query name: sincePatch required: false x-default-description: If not specified in query, all patches are processed as a match. schema: type: string AggregatorKeyQueryParam: description: Unique key of the aggregator in: query name: aggregatorKey required: false x-default-description: No aggregator key filter, all folders will be processed. schema: type: string pipelineValidationKey: description: The key of the pipeline validation. in: path name: pipelineValidationKey required: true schema: type: string maxLength: 36 minLength: 1 KeyListQueryParam: description: Used to filter by the key of the object. in: query name: key required: false style: form explode: true schema: type: array items: type: string default: [] externalPublicationValidationKey: description: The external published object key. in: path name: externalPublicationValidationKey required: true schema: type: string maxLength: 36 minLength: 1 runtimePipelineKey: description: Runtime Pipeline Key in: path name: runtimePipelineKey required: true schema: type: string IsEnabledQueryParam: description: This filter parameter can be used to filter task schedule by its state. in: query name: isEnabled required: false x-default-description: No isEnabled filter, all objects will be processed. schema: type: boolean pipelineKey: description: The pipeline key. in: path name: pipelineKey required: true schema: type: string maxLength: 36 minLength: 0 RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string SortByQueryParam: description: Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, results are shown in descending order. All other fields default to ascending order. Sorting related parameters are ignored when parameter `query` is present (search operation and sorting order is by relevance score in descending order). in: query name: sortBy required: false schema: type: string enum: - TIME_CREATED - DISPLAY_NAME - TIME_UPDATED default: TIME_CREATED taskRunKey: description: The task run key. in: path name: taskRunKey required: true schema: type: string maxLength: 36 minLength: 1 applicationKey: description: The application key. in: path name: applicationKey required: true schema: type: string maxLength: 36 minLength: 1 KeyQueryParam: description: Used to filter by the key of the object. in: query name: key required: false x-default-description: If no key filter is specified, all keys will be processed. schema: type: string ExpandReferences: description: Used to expand references of the object. If value is true, then all referenced objects are expanded. If value is false, then shallow objects are returned in place of references. Default is false.

Example:
in: query name: expandReferences required: false schema: type: string default: 'false' TimeUpdatedLessThanOrEqualToQueryParam: description: This parameter allows users to get objects which were updated before and at a certain time. The format of timeUpatedLessThanOrEqualTo is "YYYY-MM-dd'T'HH:mm:ss.SSS'Z'" in: query name: timeUpatedLessThanOrEqualTo required: false x-default-description: If no TimeUpdatedLessThanOrEqualToQueryParam is specified, then all Objects are considered irrespective of the time they are updated schema: type: string format: date-time PageNumberQueryParam: description: For list pagination. The value for this parameter is the `opc-next-page` or the `opc-prev-page` response header from the previous `List` call. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). in: query name: page schema: type: string default: 1 maxLength: 1024 minLength: 1 GetImportObjectProjection: description: This parameter allows users to specify which view of the import object response to return. SUMMARY - Summary of the import object request will be returned. This is the default option when no value is specified. DETAILS - Details of import object request will be returned. This will include details of all the objects to be exported. in: query name: projection required: false schema: type: string enum: - SUMMARY - DETAILS default: SUMMARY ConnectionKey: description: The connection key. in: path name: connectionKey required: true schema: type: string maxLength: 36 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. ' in: header name: opc-retry-token required: false schema: type: string dependentObjectKey: description: The dependent object key. in: path name: dependentObjectKey required: true schema: type: string maxLength: 36 minLength: 1 DataAssetKeyQueryParam: description: Used to filter by the data asset key of the object. in: query name: dataAssetKey required: true x-default-description: If no name filter is specified, all data assets will be processed. schema: type: string UpdateDataAssetDetails: description: The information needed to update a data asset. in: body name: UpdateDataAssetDetails required: true schema: $ref: '#/components/schemas/UpdateDataAssetDetails' NameListQueryParam: description: Used to filter by the name of the object. in: query name: nameList required: false style: form explode: true schema: type: array items: type: string default: [] GetProjection: description: This parameter allows users to specify which view of the object to return. CHILD_COUNT_STATISTICS - This option is used to get statistics on immediate children of the object by their type. in: query name: projection required: false x-default-description: If no value is specified, child count statistics will be returned. style: form explode: true schema: type: array items: enum: - CHILD_COUNT_STATISTICS type: string default: [] schemas: DataFlowValidationSummary: allOf: - $ref: '#/components/schemas/DataFlowValidation' description: The information about a data flow validation. type: object TaskRunLineageDetails: description: The task lineage object provides information on the lineage information of a task after execution. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string flow: $ref: '#/components/schemas/DataFlow' isLineageGenCompleted: default: false description: This value is used to track if lineage generation for a task is completed or not. type: boolean key: description: The object key. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The object type. maxLength: 4000 minLength: 1 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' taskExecutionStatus: description: The status of the task run. enum: - SUCCESS - ERROR - TERMINATED type: string taskKey: description: The object key. maxLength: 36 minLength: 0 type: string taskName: description: Task name maxLength: 4000 minLength: 0 type: string taskType: description: Task name maxLength: 4000 minLength: 0 type: string type: object UserDefinedFunctionValidationSummaryCollection: description: A list of UserDefinedFunction validation summaries. properties: items: description: The array of validation summaries. items: $ref: '#/components/schemas/UserDefinedFunctionValidationSummary' type: array required: - items type: object CreateCopyObjectRequestDetails: description: Details of copy object. properties: copyConflictResolution: $ref: '#/components/schemas/CopyConflictResolution' objectKeys: description: The list of the objects to be copied. items: maxLength: 36 type: string type: array sourceWorkspaceId: description: The workspace id of the source from where we need to copy object. maxLength: 1000 minLength: 1 type: string required: - sourceWorkspaceId - objectKeys - copyConflictResolution type: object CreateFolderDetails: description: The properties used in folder create operations. properties: categoryName: description: The category name. maxLength: 4000 minLength: 0 type: string description: description: A user defined description for the folder. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Currently not used on folder creation. Reserved for future. maxLength: 36 minLength: 0 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - name - identifier - registryMetadata type: object OutputPort: allOf: - $ref: '#/components/schemas/TypedObject' - discriminator: propertyName: OUTPUT_PORT properties: fields: description: An array of fields. items: $ref: '#/components/schemas/TypedObject' type: array portType: description: The port details for the data asset.Type. enum: - DATA - CONTROL - MODEL type: string description: The output port details. type: object CreateExternalPublicationDetails: description: Properties used to publish an Oracle Cloud Infrastructure Data Flow object. properties: applicationCompartmentId: description: The OCID of the compartment where the application is created in the Oracle Cloud Infrastructure Data Flow Service. maxLength: 255 minLength: 1 type: string applicationId: description: The unique OCID of the identifier that is returned after creating the Oracle Cloud Infrastructure Data Flow application. maxLength: 255 minLength: 1 type: string configurationDetails: $ref: '#/components/schemas/ConfigurationDetails' description: description: The details of the data flow or the application. maxLength: 4000 minLength: 0 type: string displayName: description: The name of the application. maxLength: 255 minLength: 1 type: string resourceConfiguration: $ref: '#/components/schemas/ResourceConfiguration' required: - applicationCompartmentId - displayName type: object CopyObjectRequestSummaryCollection: description: This is the collection of copy object requests. properties: items: description: The array of copy object requests status summaries. items: $ref: '#/components/schemas/CopyObjectRequestSummary' type: array required: - items type: object PipelineValidationSummaryCollection: description: A list of pipeline validation summaries. properties: items: description: The array of validation summaries. items: $ref: '#/components/schemas/PipelineValidationSummary' type: array required: - items type: object DisApplicationSummaryCollection: description: This is the collection of application summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of application summaries. items: $ref: '#/components/schemas/DisApplicationSummary' type: array required: - items type: object PublishedObjectSummaryCollection: description: This is the collection of published object summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of published object summaries. items: $ref: '#/components/schemas/PublishedObjectSummary' type: array required: - items type: object TaskSchedule: description: A model that holds Schedule and other information required for scheduling a task. properties: authMode: description: The authorization mode for the task. enum: - OBO - RESOURCE_PRINCIPAL - USER_CERTIFICATE type: string configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string endTimeMillis: description: The end time in milliseconds. format: int64 type: integer expectedDuration: description: The expected duration of the task execution. format: double type: number expectedDurationUnit: description: The expected duration unit of the task execution. enum: - SECONDS - MINUTES - HOURS - DAYS type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isBackfillEnabled: default: false description: Whether the backfill is enabled type: boolean isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean isEnabled: description: Whether the schedule is enabled. type: boolean key: description: Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string lastRunDetails: $ref: '#/components/schemas/LastRunDetails' metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' retryAttempts: description: The number of retry attempts. type: integer retryDelay: description: The retry delay, the unit for measurement is in the property retry delay unit. format: double type: number retryDelayUnit: description: The unit for the retry delay. enum: - SECONDS - MINUTES - HOURS - DAYS type: string scheduleRef: $ref: '#/components/schemas/Schedule' startTimeMillis: description: The start time in milliseconds. format: int64 type: integer type: object UpdateTaskRunDetails: description: Properties used in task run update operations. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' status: description: The status of the object. enum: - TERMINATING type: string taskScheduleKey: description: Optional task schedule key reference. maxLength: 36 minLength: 0 type: string type: object UpdateUserDefinedFunctionDetails: description: Properties used in user defined function update operations. properties: description: description: Detailed description for the object. type: string expr: $ref: '#/components/schemas/Expression' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' signatures: description: An array of function signature. items: $ref: '#/components/schemas/FunctionSignature' type: array type: object UpdateDataAssetDetails: description: Properties used in data asset update operations. discriminator: propertyName: modelType properties: assetProperties: additionalProperties: description: The additional properties field. maxLength: 4000 minLength: 0 type: string description: Additional properties for the data asset. type: object description: description: The user-defined description of the data asset. type: string externalKey: description: The external key for the object. type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify data asset. maxLength: 36 minLength: 0 type: string modelType: description: The type of the data asset. enum: - ORACLE_DATA_ASSET - ORACLE_OBJECT_STORAGE_DATA_ASSET - ORACLE_ATP_DATA_ASSET - ORACLE_ADWC_DATA_ASSET - MYSQL_DATA_ASSET - GENERIC_JDBC_DATA_ASSET - FUSION_APP_DATA_ASSET - AMAZON_S3_DATA_ASSET - ORACLE_PEOPLESOFT_DATA_ASSET - ORACLE_SIEBEL_DATA_ASSET - ORACLE_EBS_DATA_ASSET - HDFS_DATA_ASSET - MYSQL_HEATWAVE_DATA_ASSET - REST_DATA_ASSET type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - key - objectVersion - modelType type: object FolderSummaryCollection: description: A collection of folder summaries. The collection can be lightweight details or full definitions. properties: items: description: The array of folder summaries. items: $ref: '#/components/schemas/FolderSummary' type: array required: - items type: object DataFlowDetails: description: The information about a data flow. properties: description: description: Detailed description for the object. type: string flowConfigValues: $ref: '#/components/schemas/ConfigValues' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify data flow. On scenarios where reference to the data flow is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nodes: description: An array of nodes. items: $ref: '#/components/schemas/FlowNode' type: array objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - key - objectVersion - modelType type: object State: description: State stored in All States Map of Composite State properties: name: description: A simple name for the State. type: string parameterValue: $ref: '#/components/schemas/ParameterValue' timeValue: description: To store a date value for the State we use dateValue attribute. format: date-time type: string type: object UpdateFunctionLibraryDetails: description: The properties used in FunctionLibrary update operations. properties: categoryName: description: The category name. maxLength: 4000 minLength: 0 type: string description: description: A user defined description for the FunctionLibrary. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' type: object UpdateTaskScheduleDetails: description: The update task details. properties: authMode: description: The authorization mode for the task. enum: - OBO - RESOURCE_PRINCIPAL - USER_CERTIFICATE type: string configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string endTimeMillis: description: The end time in milliseconds. format: int64 type: integer expectedDuration: description: The expected duration of the task. format: double type: number expectedDurationUnit: description: The expected duration of the task. enum: - SECONDS - MINUTES - HOURS - DAYS type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isBackfillEnabled: default: false description: Whether the backfill is enabled. type: boolean isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean isEnabled: description: enabled type: boolean key: description: Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string numberOfRetries: description: The number of retries. type: integer objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' retryDelay: description: The retry delay, the unit for measurement is in the property retry delay unit. format: double type: number retryDelayUnit: description: The unit for the retry delay. enum: - SECONDS - MINUTES - HOURS - DAYS type: string scheduleRef: $ref: '#/components/schemas/Schedule' startTimeMillis: description: The start time in milliseconds. format: int64 type: integer required: - key - objectVersion type: object FunctionLibrarySummary: allOf: - $ref: '#/components/schemas/FunctionLibrary' description: The FunctionLibrary summary type contains the audit summary information and the definition of the Function Library. type: object ExternalPublicationValidation: description: The information about external published task validation. properties: errorMessageCount: description: Total number of validation error messages. type: integer infoMessageCount: description: Total number of validation information messages. type: integer key: description: Objects use a 36 character key as unique ID. It is system generated and cannot be modified. maxLength: 36 minLength: 0 type: string totalMessageCount: description: Total number of validation messages. type: integer validationMessages: additionalProperties: items: $ref: '#/components/schemas/ValidationMessage' type: array description: Detailed information of the data flow object validation. type: object warnMessageCount: description: Total number of validation warning messages. type: integer type: object CreateExternalPublicationValidationDetails: description: The task type contains the audit summary information and the definition of the task that is published externally. properties: key: description: Generated key that can be used in API calls to identify the task. On scenarios where reference to the task is needed, a value can be passed in the create operation. maxLength: 36 minLength: 0 type: string type: object UpdateExportRequestDetails: description: Properties used in export object request update operations. properties: status: description: The status of the object. enum: - TERMINATING type: string type: object CreateWorkspaceDetails: description: The information needed to create a new workspace. properties: compartmentId: description: The OCID of the compartment containing the workspace. maxLength: 255 minLength: 255 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user defined description for the workspace. maxLength: 1000 minLength: 0 type: string displayName: description: A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information. maxLength: 100 minLength: 1 type: string dnsServerIp: description: The IP of the custom DNS. maxLength: 15 minLength: 7 type: string dnsServerZone: description: The DNS zone of the custom DNS to use to resolve names. maxLength: 253 minLength: 1 type: string endpointCompartmentId: description: DCMS PRivate Endpoint Compartment Identifier maxLength: 255 minLength: 1 type: string endpointId: description: DCMS Private Endpoint ID associated with workspace if the pvt networking is enabled maxLength: 255 minLength: 0 type: string endpointName: description: DCMS Private Endpoint Name maxLength: 255 minLength: 0 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isPrivateNetworkEnabled: default: false description: Specifies whether the private network connection is enabled or disabled. type: boolean registryCompartmentId: description: DCMS Data Asset Registry Compartment Identifier maxLength: 255 minLength: 1 type: string registryId: description: DCMS Data Asset Registry ID to which the workspace is associated maxLength: 255 minLength: 0 type: string registryName: description: DCMS Data Asset Registry display name maxLength: 255 minLength: 0 type: string subnetId: description: The OCID of the subnet for customer connected databases. maxLength: 255 minLength: 255 type: string vcnId: description: The OCID of the VCN the subnet is in. maxLength: 255 minLength: 255 type: string required: - displayName - compartmentId type: object FunctionSignature: description: The function signature can specify function paramaters and/or function return type. properties: arguments: description: An array of function arguments. items: $ref: '#/components/schemas/TypedObject' type: array description: description: Detailed description for the object. type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. enum: - DIS_FUNCTION_SIGNATURE type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' retType: $ref: '#/components/schemas/ConfiguredType' type: object ProjectDetails: description: The details including name and description for the project, which is a container of folders, tasks, and dataflows. properties: description: description: A user defined description for the project. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify project. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - key - objectVersion - modelType type: object TaskValidation: description: The information about task validation. properties: description: description: Detailed description for the object. type: string errorMessageCount: description: Total number of validation error messages. type: integer identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string infoMessageCount: description: Total number of validation information messages. type: integer key: description: Objects use a 36 character key as unique ID. It is system generated and cannot be modified. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' totalMessageCount: description: Total number of validation messages. type: integer validationMessages: additionalProperties: items: $ref: '#/components/schemas/ValidationMessage' type: array description: Detailed information of the data flow object validation. type: object warnMessageCount: description: Total number of validation warning messages. type: integer type: object CreateTaskDetails: description: Properties used in task create operations. discriminator: propertyName: modelType properties: configProviderDelegate: $ref: '#/components/schemas/CreateConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputPorts: description: An array of input ports. items: $ref: '#/components/schemas/InputPort' type: array isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the task. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer opConfigValues: $ref: '#/components/schemas/ConfigValues' outputPorts: description: An array of output ports. items: $ref: '#/components/schemas/OutputPort' type: array parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - modelType - name - identifier - registryMetadata type: object ExternalPublication: description: The external published object contains the audit summary information and the definition of the task. properties: applicationCompartmentId: description: The OCID of the compartment where the application is created in the Oracle Cloud Infrastructure Data Flow Service. maxLength: 255 minLength: 1 type: string applicationId: description: The unique OCID of the identifier that is returned after creating the Oracle Cloud Infrastructure Data Flow application. maxLength: 255 minLength: 1 type: string configurationDetails: $ref: '#/components/schemas/ConfigurationDetails' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string displayName: description: The name of the application. maxLength: 255 minLength: 1 type: string errorMessage: description: The error of the published object in the application. type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: The object key. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The object type. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects. Other values are reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' resourceConfiguration: $ref: '#/components/schemas/ResourceConfiguration' status: description: The status of the publishing action to Oracle Cloud Infrastructure Data Flow. enum: - SUCCESSFUL - FAILED - PUBLISHING type: string type: object SchemaSummary: allOf: - $ref: '#/components/schemas/Schema' description: The schema summary object. type: object ExternalPublicationSummary: allOf: - $ref: '#/components/schemas/ExternalPublication' description: The external publication summary contains the audit summary information and the definition of the external object. type: object CountStatistic: description: A count statistics. properties: objectTypeCountList: description: The array of statistics. items: $ref: '#/components/schemas/CountStatisticSummary' type: array required: - objectTypeCountList type: object UserDefinedFunctionValidation: description: The information about a UserDefinedFunction validation. properties: description: description: Detailed description for the object. type: string errorMessageCount: description: The total number of validation error messages. minimum: 0 type: integer identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string infoMessageCount: description: The total number of validation information messages. minimum: 0 type: integer key: description: Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. maxLength: 36 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of the object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' totalMessageCount: description: The total number of validation messages. minimum: 0 type: integer validationMessages: additionalProperties: items: $ref: '#/components/schemas/ValidationMessage' type: array description: The detailed information of the UserDefinedFunction object validation. type: object warnMessageCount: description: The total number of validation warning messages. minimum: 0 type: integer type: object TypeSystem: description: The type system maps from and to a type. properties: description: description: A user defined description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' typeMappingFrom: additionalProperties: description: Additional details for an object. maxLength: 4000 minLength: 0 type: string description: The type system to map from. type: object typeMappingTo: additionalProperties: description: Additional details for an object. maxLength: 4000 minLength: 0 type: string description: The type system to map to. type: object types: description: An array of types. items: $ref: '#/components/schemas/DataType' type: array type: object CreateDetailedDescriptionDetails: description: Properties used in detailed description create operations. properties: detailedDescription: description: Base64 encoded rich text description of the object. type: string logo: description: Base64 encoded image to represent logo of the object. type: string type: object InputLink: allOf: - $ref: '#/components/schemas/FlowPortLink' - discriminator: propertyName: INPUT_LINK properties: fieldMap: $ref: '#/components/schemas/FieldMap' fromLink: description: The from link reference. type: string description: Details about the incoming data to an operator in a data flow design. type: object CountStatisticSummary: description: Details of the count statistic summary object. properties: objectCount: description: The value for the count statistic object. format: int64 type: integer objectType: description: The type of object for the count statistic object. enum: - PROJECT - FOLDER - DATA_FLOW - DATA_ASSET - CONNECTION - TASK - APPLICATION - FUNCTION_LIBRARY - USER_DEFINED_FUNCTION type: string type: object UIProperties: description: The UI properties of the object. properties: coordinateX: description: The X coordinate of the object. type: number coordinateY: description: The Y coordinate of the object. type: number type: object CreateProjectDetails: description: The properties used in project create operations. properties: description: description: A user defined description for the project. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify project. maxLength: 36 minLength: 0 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - name - identifier type: object CreateConnectionValidationDetails: description: The properties used in create connection validation operations. properties: connection: $ref: '#/components/schemas/CreateConnectionDetails' dataAsset: $ref: '#/components/schemas/CreateDataAssetDetails' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' type: object CreatePatchDetails: description: Properties used in patch create operations. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: The object's key. maxLength: 36 minLength: 0 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectKeys: description: The array of object keys to publish into application. items: type: string type: array objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer patchType: description: The type of the patch applied or being applied on the application. enum: - PUBLISH - REFRESH - UNPUBLISH type: string registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - name - identifier - patchType - objectKeys type: object ConnectionProperty: description: The connection name/value pair. properties: name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string value: description: The value for the connection name property. maxLength: 4000 minLength: 0 type: string type: object DisApplicationSummary: allOf: - $ref: '#/components/schemas/Application' description: The application summary type contains the audit summary information and the definition of the application. type: object ReferenceUsedBy: description: Referenced object information. properties: key: description: The key of the published object. maxLength: 36 minLength: 0 type: string name: description: The name of an published object. maxLength: 255 minLength: 1 type: string namePath: description: The name path of the published object. maxLength: 4000 minLength: 1 type: string type: object FlowPortLink: description: Details about the link between two data flow operators. discriminator: propertyName: modelType properties: description: description: Detailed description for the object. type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The model type of the object. enum: - CONDITIONAL_INPUT_LINK - OUTPUT_LINK - INPUT_LINK type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' port: description: Key of FlowPort reference type: string required: - modelType type: object InputPort: allOf: - $ref: '#/components/schemas/TypedObject' - discriminator: propertyName: INPUT_PORT properties: fields: description: An array of fields. items: $ref: '#/components/schemas/TypedObject' type: array portType: description: The port details for the data asset.Type. enum: - DATA - CONTROL - MODEL type: string description: The input port details. type: object Task: description: The task type contains the audit summary information and the definition of the task. discriminator: propertyName: modelType properties: configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputPorts: description: An array of input ports. items: $ref: '#/components/schemas/InputPort' type: array isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the task. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer opConfigValues: $ref: '#/components/schemas/ConfigValues' outputPorts: description: An array of output ports. items: $ref: '#/components/schemas/OutputPort' type: array parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' type: object FieldMap: description: A field map is a way to map a source row shape to a target row shape that may be different. discriminator: propertyName: modelType properties: description: description: Detailed description for the object. type: string modelType: description: The model type for the field map. enum: - DIRECT_NAMED_FIELD_MAP - COMPOSITE_FIELD_MAP - DIRECT_FIELD_MAP - RULE_BASED_FIELD_MAP - CONDITIONAL_COMPOSITE_FIELD_MAP - NAMED_ENTITY_MAP - RULE_BASED_ENTITY_MAP type: string required: - modelType type: object ConfigValues: description: Configuration values can be string, objects, or parameters. properties: configParamValues: additionalProperties: $ref: '#/components/schemas/ConfigParameterValue' description: The configuration parameter values. type: object parentRef: $ref: '#/components/schemas/ParentReference' type: object OutputLink: allOf: - $ref: '#/components/schemas/FlowPortLink' - discriminator: propertyName: OUTPUT_LINK properties: toLinks: description: The links from this output link to connect to other links in flow. items: type: string type: array description: Details about the outgoing data of an operator in a data flow design. type: object DataAssetSummary: description: The summary object for data asset. discriminator: propertyName: modelType properties: assetProperties: additionalProperties: description: The additional properties field. maxLength: 4000 minLength: 0 type: string description: Additional properties for the data asset. type: object description: description: The user-defined description of the data asset. type: string externalKey: description: The external key for the object. type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify data asset. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the data asset. enum: - ORACLE_DATA_ASSET - ORACLE_OBJECT_STORAGE_DATA_ASSET - ORACLE_ATP_DATA_ASSET - ORACLE_ADWC_DATA_ASSET - MYSQL_DATA_ASSET - GENERIC_JDBC_DATA_ASSET - FUSION_APP_DATA_ASSET - AMAZON_S3_DATA_ASSET - ORACLE_PEOPLESOFT_DATA_ASSET - ORACLE_SIEBEL_DATA_ASSET - ORACLE_EBS_DATA_ASSET - HDFS_DATA_ASSET - MYSQL_HEATWAVE_DATA_ASSET - REST_DATA_ASSET type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nativeTypeSystem: $ref: '#/components/schemas/TypeSystem' objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object ResourceConfiguration: description: Properties related to a resource. properties: driverShape: description: The VM shape of the driver used while creating an Oracle Cloud Infrastructure Data Flow application. It sets the driver cores and memory. maxLength: 200 minLength: 0 type: string executorShape: description: The shape of the executor used while creating an Oracle Cloud Infrastructure Data Flow application. It sets the executor cores and memory. maxLength: 200 minLength: 0 type: string sparkVersion: description: The version of the spark used while creating an Oracle Cloud Infrastructure Data Flow application. maxLength: 200 minLength: 0 type: string totalExecutors: description: Number of executor VMs requested while creating an Oracle Cloud Infrastructure Data Flow application. minimum: 1 type: integer required: - sparkVersion - driverShape - executorShape - totalExecutors type: object ChildReferenceDetail: description: References used in an application. properties: key: description: The child reference key. maxLength: 36 minLength: 0 type: string targetObject: description: The new reference object to use instead of the original reference. For example, this can be a connection reference. type: object type: object TypedObject: description: The `TypedObject` class is a base class for any model object that has a type. discriminator: propertyName: modelType properties: configValues: $ref: '#/components/schemas/ConfigValues' description: description: Detailed description for the object. type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the types object. enum: - SHAPE - INPUT_PORT - SHAPE_FIELD - INPUT_FIELD - DERIVED_FIELD - MACRO_FIELD - OUTPUT_FIELD - DYNAMIC_PROXY_FIELD - OUTPUT_PORT - DYNAMIC_INPUT_FIELD - PROXY_FIELD - PARAMETER - PIVOT_FIELD - MACRO_PIVOT_FIELD - CONDITIONAL_OUTPUT_PORT - INPUT_PROXY_FIELD - MATERIALIZED_DYNAMIC_FIELD - DECISION_OUTPUT_PORT type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' required: - modelType type: object ScheduleSummary: description: The schedule summary information. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string frequencyDetails: $ref: '#/components/schemas/AbstractFrequencyDetails' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isDaylightAdjustmentEnabled: description: A flag to indicate whether daylight adjustment should be considered or not. type: boolean key: description: Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' timezone: description: The timezone for the schedule. type: string type: object ApplicationSummary: allOf: - $ref: '#/components/schemas/Application' description: The application summary type contains the audit summary information and the definition of the application. type: object ExportRequestSummary: allOf: - $ref: '#/components/schemas/ExportRequest' description: Export metadata object response summary. type: object UpdateImportRequestDetails: description: Properties used in import object request update operations. properties: status: description: The status of the object. enum: - TERMINATING type: string type: object AbstractFrequencyDetails: description: The model that holds the frequency details. discriminator: propertyName: modelType properties: frequency: description: the frequency of the schedule. enum: - HOURLY - DAILY - MONTHLY - WEEKLY - CUSTOM type: string modelType: description: The type of the model enum: - HOURLY - DAILY - MONTHLY - WEEKLY - MONTHLY_RULE - CUSTOM type: string required: - modelType type: object TaskRunLineageSummaryCollection: description: List of lineage flows properties: items: description: The array of lineage flow summaries. items: $ref: '#/components/schemas/TaskRunLineageSummary' type: array required: - items type: object CreatePipelineDetails: description: Properties used in pipeline create operations properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string flowConfigValues: $ref: '#/components/schemas/ConfigValues' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nodes: description: A list of nodes attached to the pipeline items: $ref: '#/components/schemas/FlowNode' type: array objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parameters: description: A list of additional parameters required in pipeline. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' variables: description: The list of variables required in pipeline. items: $ref: '#/components/schemas/Variable' type: array required: - name - identifier - registryMetadata type: object CreateFunctionLibraryDetails: description: The properties used in FunctionLibrary create operations. properties: categoryName: description: The category name. maxLength: 4000 minLength: 0 type: string description: description: A user defined description for the FunctionLibrary. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Currently not used on FunctionLibrary creation. Reserved for future. maxLength: 36 minLength: 0 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - name - identifier - registryMetadata type: object PatchSummary: allOf: - $ref: '#/components/schemas/Patch' description: The patch summary type contains the audit summary information and the definition of the patch. type: object UpdatePipelineDetails: description: Properties used in pipeline update operations properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string flowConfigValues: $ref: '#/components/schemas/ConfigValues' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nodes: description: A list of nodes attached to the pipeline items: $ref: '#/components/schemas/FlowNode' type: array objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parameters: description: A list of additional parameters required in pipeline. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' variables: description: The list of variables required in pipeline. items: $ref: '#/components/schemas/Variable' type: array required: - key - objectVersion - modelType type: object WorkRequestSummary: allOf: - $ref: '#/components/schemas/WorkRequest' description: A work request summary object. Patch: description: The patch object contains the audit summary information and the definition of the patch. properties: applicationVersion: description: The application version of the patch. type: integer dependentObjectMetadata: description: List of dependent objects in this patch. items: $ref: '#/components/schemas/PatchObjectMetadata' type: array description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string errorMessages: additionalProperties: description: Error message detailing the issue. minLength: 0 type: string description: The errors encountered while applying the patch, if any. type: object identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: The object key. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The object type. maxLength: 4000 minLength: 1 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' patchObjectMetadata: description: List of objects that are published or unpublished in this patch. items: $ref: '#/components/schemas/PatchObjectMetadata' type: array patchStatus: description: Status of the patch applied or being applied on the application enum: - QUEUED - SUCCESSFUL - FAILED - IN_PROGRESS type: string patchType: description: The type of the patch applied or being applied on the application. enum: - PUBLISH - REFRESH - UNPUBLISH type: string timePatched: description: The date and time the patch was applied, in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string type: object TaskValidationSummary: allOf: - $ref: '#/components/schemas/TaskValidation' description: The information about task validation. type: object ImportRequestSummary: allOf: - $ref: '#/components/schemas/ImportRequest' description: Import metadata object response summary. type: object CreateDataFlowDetails: description: Properties used in data flow create operations. properties: description: description: Detailed description for the object. type: string flowConfigValues: $ref: '#/components/schemas/ConfigValues' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify data flow. On scenarios where reference to the data flow is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nodes: description: An array of nodes. items: $ref: '#/components/schemas/FlowNode' type: array objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - name - identifier - registryMetadata type: object UserDefinedFunctionSummary: allOf: - $ref: '#/components/schemas/UserDefinedFunction' description: The user defined function summary type contains the audit summary information and the definition of the user defined function. type: object TaskRunSummary: allOf: - $ref: '#/components/schemas/TaskRunDetails' description: The information about a task run. type: object ProjectSummaryCollection: description: A collection of project summaries. The collection can be lightweight details or full definitions. properties: items: description: The array of project summaries. items: $ref: '#/components/schemas/ProjectSummary' type: array required: - items type: object CreateImportRequestDetails: description: Details of import object. properties: areDataAssetReferencesIncluded: default: true description: This field controls if the data asset references will be included during import. type: boolean bucketName: description: Name of the Object Storage bucket where the object will be imported from. maxLength: 1000 minLength: 1 type: string fileName: description: Name of the zip file to be imported. maxLength: 1000 minLength: 1 type: string importConflictResolution: $ref: '#/components/schemas/ImportConflictResolution' objectKeyForImport: description: Key of the object inside which all the objects will be imported maxLength: 36 type: string x-default-description: 'null' objectStorageRegion: description: Region of the object storage (if using object storage of different region) maxLength: 255 minLength: 1 type: string x-default-description: When unspecified the region from where the import request is triggered will be used objectStorageTenancyId: description: Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) maxLength: 255 minLength: 1 type: string x-default-description: When unspecified the tenancy triggering the import request will be used required: - bucketName - fileName type: object Message: description: The details of a message. properties: code: description: The message code. maxLength: 30 minLength: 1 type: string message: description: The message text. maxLength: 4000 minLength: 1 type: string type: description: The type of message (error, warning, or info). enum: - ERROR - WARNING - INFO type: string required: - type - code - message ConnectionValidation: description: The information about connection validation. properties: description: description: Detailed description for the object. type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. maxLength: 36 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' validationMessage: $ref: '#/components/schemas/Message' type: object Schema: description: The schema object. properties: defaultConnection: description: The default connection key. type: string description: description: User-defined description for the schema. maxLength: 4000 minLength: 0 type: string externalKey: description: The external key for the object. type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string isHasContainers: description: Specifies whether the schema has containers. type: boolean key: description: The object key. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The object's type. maxLength: 4000 minLength: 1 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' resourceName: description: A resource name can have letters, numbers, and special characters. The value is editable and is restricted to 4000 characters. maxLength: 4000 minLength: 1 type: string type: object RuntimeOperatorSummaryCollection: description: List of runtimeOperator summaries properties: items: description: The array of runtimeOperator summaries items: $ref: '#/components/schemas/RuntimeOperatorSummary' type: array required: - items type: object WorkRequestLogEntry: description: The log message from executing an operation that is tracked by a work request. properties: message: description: A user friendly log message. type: string timestamp: description: The date and time the log message was written, in the timestamp format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - message - timestamp WorkRequest: description: The API operations used to create and configure Data Integration resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running asynchronous workflows. properties: compartmentId: description: 'The OCID of the compartment that contains this work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources that are not in the same compartment, then the system picks a primary resource whose compartment should be used. ' type: string id: description: The ID of the work request. type: string operationType: description: The asynchronous operation tracked by this work request. enum: - CREATE_WORKSPACE - UPDATE_WORKSPACE - DELETE_WORKSPACE - MOVE_WORKSPACE type: string percentComplete: description: The completed percentage of the operation tracked by this work request. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The status of this work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeAccepted: description: 'The date and time this work request was accepted, in the timestamp format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeFinished: description: 'The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`, in the timestamp format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, in the timestamp format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted PatchChangeSummary: allOf: - $ref: '#/components/schemas/PatchObjectMetadata' description: This is the patch report summary information. type: object FunctionLibrarySummaryCollection: description: A collection of FunctionLibrary summaries. The collection can be lightweight details or full definitions. properties: items: description: The array of FunctionLibrary summaries. items: $ref: '#/components/schemas/FunctionLibrarySummary' type: array required: - items type: object EntityShape: description: The data entity shape object. discriminator: propertyName: modelType properties: metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The data entity type. enum: - FILE_ENTITY - SQL_ENTITY - OBJECT_ENTITY type: string required: - modelType type: object FolderSummary: allOf: - $ref: '#/components/schemas/Folder' description: The folder summary type contains the audit summary information and the definition of the folder. type: object UpdateWorkspaceDetails: description: The information to be updated, the private network can be enabled and VCN and subnet set only when initially it is has been created with it off. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A user defined description for the workspace. maxLength: 1000 minLength: 0 type: string displayName: description: A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information. maxLength: 100 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object WorkRequestResource: description: The resource that is created or operated on by a work request. properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the `IN_PROGRESS` state until work is complete for that resource at which point it will transition to `CREATED`, `UPDATED`, or `DELETED`, respectively. ' enum: - CREATED - UPDATED - DELETED - MOVED - IN_PROGRESS - FAILED - STOPPED - STARTED type: string entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path that is used in a GET request to access the resource metadata. type: string identifier: description: The OCID or other unique identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier ImportObjectMetadataSummary: description: Details of the objects to imported. properties: aggregatorKey: description: Aggregator key maxLength: 36 type: string identifier: description: Object identifier maxLength: 1000 minLength: 1 type: string name: description: Name of the object maxLength: 1000 minLength: 1 type: string namePath: description: Object name path type: string newKey: description: New key of the object maxLength: 36 type: string objectType: description: Object type maxLength: 4000 minLength: 1 type: string objectVersion: description: Object version maxLength: 255 minLength: 1 type: string oldKey: description: Old key of the object maxLength: 36 type: string resolutionAction: description: Object resolution action enum: - CREATED - RETAINED - DUPLICATED - REPLACED - EXCLUDED type: string timeUpdatedInMillis: description: time at which this object was last updated. format: int64 type: integer type: object Workspace: description: A workspace is an organizational construct to keep multiple data integration solutions and their resources (data assets, data flows, tasks, and so on) separate from each other, helping you to stay organized. For example, you could have separate workspaces for development, testing, and production. properties: compartmentId: description: The OCID of the compartment containing the workspace. maxLength: 255 minLength: 255 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A detailed description for the workspace. maxLength: 1000 minLength: 0 type: string displayName: description: A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information. maxLength: 100 minLength: 1 type: string dnsServerIp: description: The IP of the custom DNS. maxLength: 15 minLength: 7 type: string dnsServerZone: description: The DNS zone of the custom DNS to use to resolve names. maxLength: 253 minLength: 1 type: string endpointId: description: OCID of the private endpoint associated with the container/workspace. maxLength: 255 minLength: 0 type: string endpointName: description: Name of the private endpoint associated with the container/workspace. maxLength: 255 minLength: 0 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: A system-generated and immutable identifier assigned to the workspace upon creation. maxLength: 255 minLength: 255 type: string isPrivateNetworkEnabled: description: Specifies whether the private network connection is enabled or disabled. type: boolean lifecycleState: description: "Lifecycle states for workspaces in Data Integration Service\nCREATING - The resource is being created and may not be usable until the entire metadata is defined\nUPDATING - The resource is being updated and may not be usable until all changes are commited\nDELETING - The resource is being deleted and might require deep cleanup of children.\nACTIVE - The resource is valid and available for access\nINACTIVE - The resource might be incomplete in its definition or might have been made unavailable for\n administrative reasons\nDELETED - The resource has been deleted and isn't available\nFAILED - The resource is in a failed state due to validation or other errors\nSTARTING - The resource is being started and may not be usable until becomes ACTIVE again\nSTOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails\nSTOPPED - The resource is in Stopped state due to stop operation.\n" enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED - STARTING - STOPPING - STOPPED type: string registryId: description: DCMS Registry ID associated with the container/workspace. maxLength: 255 minLength: 0 type: string stateMessage: description: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state. maxLength: 255 minLength: 0 type: string subnetId: description: The OCID of the subnet for customer connected databases. type: string timeCreated: description: 'The date and time the workspace was created, in the timestamp format defined by RFC3339. ' example: 2019-08-25 21:10:29.410000+00:00 format: date-time type: string timeUpdated: description: The date and time the workspace was updated, in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). example: 2019-08-25 21:10:29.410000+00:00 format: date-time type: string vcnId: description: The OCID of the VCN the subnet is in. maxLength: 255 minLength: 255 type: string required: - id - displayName type: object TaskRunLineageSummary: allOf: - $ref: '#/components/schemas/TaskRunLineageDetails' description: The information about TaskRunLineage. type: object UpdateReferenceDetails: description: Application references that need to be updated. properties: childReferences: description: The list of child references that also need to be updated. items: $ref: '#/components/schemas/ChildReferenceDetail' type: array options: additionalProperties: description: A value for options. maxLength: 4000 minLength: 0 type: string description: A list of options such as `ignoreObjectOnError`. type: object targetObject: description: The new target object to reference. This can be of type `DataAsset`, `Schema` or `Task`. In case of `DataAsset`, the child references can be of type `Connection`. type: object type: object ApplicationDetails: description: The information about the application. properties: applicationVersion: description: version type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string displayName: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify application. maxLength: 36 minLength: 0 type: string lifecycleState: description: The current state of the workspace. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The object type. maxLength: 4000 minLength: 1 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' required: - key - objectVersion - modelType type: object RuntimePipelineSummaryCollection: description: List of runtimePipeline summaries properties: items: description: The array of runtimePipeline summaries items: $ref: '#/components/schemas/RuntimePipelineSummary' type: array required: - items type: object PipelineValidationSummary: allOf: - $ref: '#/components/schemas/PipelineValidation' description: The information about a pipeline validation. type: object DataType: allOf: - $ref: '#/components/schemas/BaseType' - discriminator: propertyName: DATA_TYPE properties: configDefinition: $ref: '#/components/schemas/ConfigDefinition' dtType: description: The data type. enum: - PRIMITIVE - STRUCTURED type: string typeSystemName: description: The data type system name. type: string description: A `DataType` object is a simple primitive type that describes the type of a single atomic unit of data. For example, `INT`, `VARCHAR`, `NUMBER`, and so on. type: object CopyConflictResolution: description: Copy Object Conflict resolution. properties: duplicatePrefix: default: '' description: In case of DUPLICATE mode, this prefix will be used to disambiguate the object. type: string duplicateSuffix: default: '' description: In case of DUPLICATE mode, this suffix will be used to disambiguate the object. type: string requestType: default: RETAIN description: Copy Object Conflict Resolution Type (RETAIN/DUPLICATE/REPLACE). enum: - RETAIN - DUPLICATE - REPLACE type: string required: - requestType type: object WorkRequestError: description: The error that occured while executing an operation that is tracked by a work request. properties: code: description: 'A machine-usable code for the error that occured, as listed in [API Errors](/Content/API/References/apierrors.htm). ' type: string message: description: A user friendly description of the error that occured. type: string timestamp: description: The date and time the error occured, in the timestamp format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339). format: date-time type: string required: - code - message - timestamp ExternalPublicationValidationSummary: allOf: - $ref: '#/components/schemas/ExternalPublicationValidation' description: The external publication validation summary contains the validation summary information and the definition of the external object. type: object FieldMapWrapper: description: A wrapper for a field map. properties: fieldMap: $ref: '#/components/schemas/FieldMap' type: object PatchSummaryCollection: description: This is the collection of patch summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of patch summaries. items: $ref: '#/components/schemas/PatchSummary' type: array required: - items type: object ConnectionValidationSummaryCollection: description: A list of connection validation summaries. properties: items: description: An array of connection validation summaries. items: $ref: '#/components/schemas/ConnectionValidationSummary' type: array required: - items type: object PatchObjectMetadata: description: A summary type containing information about the object including its key, name and when/who created/updated it. properties: action: description: The patch action indicating if object was created, updated, or deleted. enum: - CREATED - DELETED - UPDATED type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string namePath: description: The fully qualified path of the published object, which would include its project and folder. maxLength: 1000 minLength: 1 type: string objectVersion: description: The object version. type: integer type: description: The type of the object in patch. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string type: object Expression: description: An expression node. properties: configValues: $ref: '#/components/schemas/ConfigValues' exprString: description: The expression string for the object. type: string key: description: The object key. maxLength: 36 minLength: 0 type: string modelType: description: The object type. maxLength: 4000 minLength: 1 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object Project: description: The project type contains the audit summary information and the definition of the project. properties: description: description: A user defined description for the project. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify project. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. maxLength: 65 minLength: 0 type: string description: A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object ConnectionSummary: description: The connection summary object. discriminator: propertyName: modelType properties: connectionProperties: description: The properties for the connection. items: $ref: '#/components/schemas/ConnectionProperty' type: array description: description: User-defined description for the connection. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string isDefault: default: false description: The default property for the connection. type: boolean key: description: Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the connection. enum: - ORACLE_ADWC_CONNECTION - ORACLE_ATP_CONNECTION - ORACLE_OBJECT_STORAGE_CONNECTION - ORACLEDB_CONNECTION - MYSQL_CONNECTION - GENERIC_JDBC_CONNECTION - BICC_CONNECTION - AMAZON_S3_CONNECTION - BIP_CONNECTION - ORACLE_PEOPLESOFT_CONNECTION - ORACLE_EBS_CONNECTION - ORACLE_SIEBEL_CONNECTION - HDFS_CONNECTION - MYSQL_HEATWAVE_CONNECTION - REST_NO_AUTH_CONNECTION - REST_BASIC_AUTH_CONNECTION - OAUTH2_CONNECTION type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' primarySchema: $ref: '#/components/schemas/Schema' required: - modelType type: object Parameter: allOf: - $ref: '#/components/schemas/TypedObject' - discriminator: propertyName: PARAMETER properties: defaultValue: description: The default value of the parameter. type: object isInput: description: Specifies whether the parameter is input value. type: boolean isOutput: description: Specifies whether the parameter is output value. type: boolean outputAggregationType: description: The output aggregation type. enum: - MIN - MAX - COUNT - SUM type: string rootObjectDefaultValue: description: The default value of the parameter which can be an object in DIS, such as a data entity. type: object type: description: This can either be a string value referencing the type or a BaseType object. type: object typeName: description: The type of value the parameter was created for. maxLength: 1000 minLength: 1 type: string usedFor: description: The param name for which parameter is created for for eg. driver Shape, Operation etc. type: string description: Parameters are created and assigned values that can be configured for each integration task. type: object CreateTaskRunDetails: description: The properties used in task run create operations. properties: configProvider: $ref: '#/components/schemas/CreateConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string reRunType: description: Supported re-run types enum: - BEGINNING - FAILED - STEP type: string refTaskRunId: description: Reference Task Run Id to be used for re-run type: string registryMetadata: $ref: '#/components/schemas/RegistryMetadata' stepId: description: Step Id for running from a certain step. type: string taskScheduleKey: description: Optional task schedule key reference. maxLength: 36 minLength: 0 type: string type: object DetailedDescription: description: The detailed description of an object. properties: detailedDescription: description: Base64 encoded rich text description of the object. type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string logo: description: Base64 encoded image to represent logo of the object. type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the published object. enum: - DETAILED_DESCRIPTION type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object ConnectionValidationSummary: allOf: - $ref: '#/components/schemas/ConnectionValidation' description: The information about connection validation. type: object CreateExportRequestDetails: description: "Details of export request. Export is supported using three ways. \nFirst, when objectKeys are provided, export of those objects take place.\nSecond, when filter are provided, all the objects based on the filter provided are exported.\nThird, when neither objectKeys nor filters are provided, we export all the design objects for the workspace.\n" properties: areReferencesIncluded: default: true description: This field controls if the references will be exported along with the objects type: boolean bucketName: description: Name of the Object Storage bucket where the object will be exported. maxLength: 1000 minLength: 1 type: string fileName: description: Name of the exported zip file. maxLength: 1000 minLength: 1 type: string x-default-description: When unspecified, this field will be set to a value in format 'ObjectsExport_' filters: description: Filters for exported objects items: type: string type: array x-default-description: 'null' isObjectOverwriteEnabled: default: false description: Flag to control whether to overwrite the object if it is already present at the provided object storage location. type: boolean objectKeys: description: Field is used to specify which object keys to export items: type: string type: array x-default-description: 'null' objectStorageRegion: description: Region of the object storage (if using object storage of different region) maxLength: 255 minLength: 1 type: string x-default-description: When unspecified the region from where the export request is triggered will be used objectStorageTenancyId: description: Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) maxLength: 255 minLength: 1 type: string x-default-description: When unspecified the tenancy triggering the export request will be used required: - bucketName type: object DataAsset: description: Represents a data source in the Data Integration service. discriminator: propertyName: modelType properties: assetProperties: additionalProperties: description: The additional properties field. maxLength: 4000 minLength: 0 type: string description: Additional properties for the data asset. type: object description: description: User-defined description of the data asset. type: string externalKey: description: The external key for the object. type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify data asset. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the data asset. enum: - ORACLE_DATA_ASSET - ORACLE_OBJECT_STORAGE_DATA_ASSET - ORACLE_ATP_DATA_ASSET - ORACLE_ADWC_DATA_ASSET - MYSQL_DATA_ASSET - GENERIC_JDBC_DATA_ASSET - FUSION_APP_DATA_ASSET - AMAZON_S3_DATA_ASSET - ORACLE_PEOPLESOFT_DATA_ASSET - ORACLE_SIEBEL_DATA_ASSET - ORACLE_EBS_DATA_ASSET - HDFS_DATA_ASSET - MYSQL_HEATWAVE_DATA_ASSET - REST_DATA_ASSET type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nativeTypeSystem: $ref: '#/components/schemas/TypeSystem' objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object UpdateProjectDetails: allOf: - $ref: '#/components/schemas/ProjectDetails' description: The properties used in project update operations. type: object Pipeline: description: A pipeline is a logical grouping of tasks that together perform a higher level operation. For example, a pipeline could contain a set of tasks that load and clean data, then execute a dataflow to analyze the data. The pipeline allows you to manage the activities as a unit instead of individually. Users can also schedule the pipeline instead of the tasks independently. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string flowConfigValues: $ref: '#/components/schemas/ConfigValues' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nodes: description: A list of nodes attached to the pipeline. items: $ref: '#/components/schemas/FlowNode' type: array objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parameters: description: A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' variables: description: The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline. items: $ref: '#/components/schemas/Variable' type: array type: object ConnectionSummaryCollection: description: This is the collection of connection summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of connection summaries. items: $ref: '#/components/schemas/ConnectionSummary' type: array required: - items type: object UpdateFolderDetails: allOf: - $ref: '#/components/schemas/FolderDetails' description: The properties used in folder update operations. type: object Application: description: The application type contains the audit summary information and the definition of the application. properties: applicationVersion: description: The application's version. type: integer compartmentId: description: OCID of the compartment that this resource belongs to. Defaults to compartment of the Workspace. maxLength: 255 minLength: 131 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object dependentObjectMetadata: description: A list of dependent objects in this patch. items: $ref: '#/components/schemas/PatchObjectMetadata' type: array description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string displayName: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OCID of the resource that is used to uniquely identify the application maxLength: 255 minLength: 131 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify application. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object lifecycleState: description: The current state of the workspace. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The object type. maxLength: 4000 minLength: 1 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' publishedObjectMetadata: additionalProperties: $ref: '#/components/schemas/PatchObjectMetadata' description: A list of objects that are published or unpublished in this patch. type: object sourceApplicationInfo: $ref: '#/components/schemas/SourceApplicationInfo' timeCreated: description: 'The date and time the application was created, in the timestamp format defined by RFC3339. ' example: 2019-08-25 21:10:29.410000+00:00 format: date-time type: string timePatched: description: 'The date and time the application was patched, in the timestamp format defined by RFC3339. ' example: 2019-08-25 21:10:29.410000+00:00 format: date-time type: string timeUpdated: description: 'The date and time the application was updated, in the timestamp format defined by RFC3339. example: 2019-08-25T21:10:29.41Z ' format: date-time type: string type: object WorkspaceSummary: description: Summary details of a workspace. properties: compartmentId: description: The OCID of the compartment that contains the workspace. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A user defined description for the workspace. maxLength: 400 minLength: 0 type: string displayName: description: A user-friendly display name that is changeable. Avoid entering confidential information. maxLength: 255 minLength: 1 type: string endpointId: description: DCMS endpoint associated with the container/workspace. Returns null if there is none. maxLength: 255 minLength: 0 type: string endpointName: description: Name of the private endpoint associated with the container/workspace. Returns null if there is none. maxLength: 255 minLength: 0 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: A system-generated and immutable identifier assigned to the workspace upon creation. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the workspace. enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED - STARTING - STOPPING - STOPPED type: string registryId: description: DCMS registry associated with the container/workspace. Returns null if there is none. maxLength: 255 minLength: 0 type: string stateMessage: description: A detailed description about the current state of the workspace. Used to provide actionable information if the workspace is in a failed state. maxLength: 255 minLength: 0 type: string timeCreated: description: 'The date and time the workspace was created, in the timestamp format defined by RFC3339. ' example: 2019-08-25 21:10:29.410000+00:00 format: date-time type: string timeUpdated: description: 'The date and time the workspace was updated, in the timestamp format defined by RFC3339. ' example: 2019-08-25 21:10:29.410000+00:00 format: date-time type: string type: object ConfigParameterValue: description: Contains the parameter configuration values. properties: intValue: description: An integer value of the parameter. type: integer objectValue: description: An object value of the parameter. type: object parameterValue: description: Reference to the parameter by its key. type: string refValue: description: The root object reference value. type: object rootObjectValue: description: The root object value, used in custom parameters. type: object stringValue: description: A string value of the parameter. maxLength: 4000 minLength: 1 type: string type: object CreateUserDefinedFunctionValidationDetails: allOf: - $ref: '#/components/schemas/UserDefinedFunction' description: The properties used in create UserDefinedFunction validation operations. type: object ParentReference: description: A reference to the object's parent. properties: parent: description: Key of the parent object. maxLength: 36 minLength: 0 type: string rootDocId: description: Key of the root document object. maxLength: 36 minLength: 0 type: string type: object CreateConnectionDetails: description: Properties used in connection create operations. discriminator: propertyName: modelType properties: connectionProperties: description: The properties for the connection. items: $ref: '#/components/schemas/ConnectionProperty' type: array description: description: User-defined description for the connection. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the connection. enum: - ORACLE_ADWC_CONNECTION - ORACLE_ATP_CONNECTION - ORACLE_OBJECT_STORAGE_CONNECTION - ORACLEDB_CONNECTION - MYSQL_CONNECTION - GENERIC_JDBC_CONNECTION - BICC_CONNECTION - AMAZON_S3_CONNECTION - BIP_CONNECTION - ORACLE_PEOPLESOFT_CONNECTION - ORACLE_EBS_CONNECTION - ORACLE_SIEBEL_CONNECTION - HDFS_CONNECTION - MYSQL_HEATWAVE_CONNECTION - REST_NO_AUTH_CONNECTION - REST_BASIC_AUTH_CONNECTION - OAUTH2_CONNECTION type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - identifier - name type: object CreateDataAssetDetails: description: Properties used in data asset update operations. discriminator: propertyName: modelType properties: assetProperties: additionalProperties: description: The additional properties field. maxLength: 4000 minLength: 0 type: string description: Additional properties for the data asset. type: object description: description: User-defined description of the data asset. type: string externalKey: description: The external key for the object. type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Currently not used on data asset creation. Reserved for future. maxLength: 36 minLength: 0 type: string modelType: description: The type of the data asset. enum: - ORACLE_DATA_ASSET - ORACLE_OBJECT_STORAGE_DATA_ASSET - ORACLE_ATP_DATA_ASSET - ORACLE_ADWC_DATA_ASSET - MYSQL_DATA_ASSET - GENERIC_JDBC_DATA_ASSET - FUSION_APP_DATA_ASSET - AMAZON_S3_DATA_ASSET - ORACLE_PEOPLESOFT_DATA_ASSET - ORACLE_SIEBEL_DATA_ASSET - ORACLE_EBS_DATA_ASSET - HDFS_DATA_ASSET - MYSQL_HEATWAVE_DATA_ASSET - REST_DATA_ASSET type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - modelType - name - identifier type: object TypedObjectWrapper: description: A wrapper for a typed object. properties: typedObject: $ref: '#/components/schemas/TypedObject' type: object ReferenceSummaryCollection: description: This is the collection of references. properties: items: description: The array of application summaries. items: $ref: '#/components/schemas/ReferenceSummary' type: array required: - items type: object ErrorDetails: description: The details of an error that occured. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/Content/API/References/apierrors.htm). ' maxLength: 30 minLength: 1 type: string message: description: A user-friendly error message. maxLength: 4000 minLength: 1 type: string required: - code - message UpdateApplicationDetails: allOf: - $ref: '#/components/schemas/ApplicationDetails' description: Properties used in application create operations. type: object ExportObjectMetadataSummary: description: Details of the exported object properties: aggregatorKey: description: Aggregator key maxLength: 36 type: string identifier: description: Object identifier maxLength: 1000 minLength: 1 type: string key: description: Key of the object maxLength: 36 type: string name: description: Name of the object maxLength: 1000 minLength: 1 type: string namePath: description: Object name path type: string objectType: description: Object type maxLength: 4000 minLength: 1 type: string objectVersion: description: Object version maxLength: 255 minLength: 1 type: string timeUpdatedInMillis: description: time at which this object was last updated. format: int64 type: integer type: object RuntimePipeline: description: Runtime pipeline model which holds the runtime metadata of the task executed. properties: parentRuntimeOperatorKey: description: The parent RuntimePipeline's RuntimeOperator key. maxLength: 36 minLength: 0 type: string pipeline: $ref: '#/components/schemas/Pipeline' runtimeOperators: description: A list of RuntimeOperators attached to the RuntimePipeline. items: $ref: '#/components/schemas/RuntimeOperator' type: array type: object DataFlowSummary: allOf: - $ref: '#/components/schemas/DataFlow' description: The data flow summary type contains the audit summary information and the definition of the data flow. type: object TemplateSummaryCollection: description: This is the collection of application template summaries. properties: items: description: The array of application template summaries. items: $ref: '#/components/schemas/TemplateSummary' type: array required: - items type: object AggregatorSummary: description: A summary type containing information about the object's aggregator including its type, key, name and description. properties: description: description: The description of the aggregator. maxLength: 4000 minLength: 0 type: string identifier: description: The identifier of the aggregator. maxLength: 1000 minLength: 1 type: string key: description: The key of the aggregator object. maxLength: 36 minLength: 0 type: string name: description: The name of the aggregator. maxLength: 1000 minLength: 1 type: string type: description: The type of the aggregator. maxLength: 4000 minLength: 1 type: string type: object RuntimePipelineSummary: allOf: - $ref: '#/components/schemas/RuntimePipeline' description: The information about RuntimePipeline. type: object RuntimeOperator: description: Runtime operator model which holds the runtime metadata of the task operator executed. properties: configProvider: $ref: '#/components/schemas/ConfigProvider' endTimeInMillis: description: The runtime operator end time. format: int64 type: integer executionState: description: status enum: - NOT_STARTED - RUNNING - TERMINATED - SUCCESS - ERROR - SKIPPED - UNKNOWN - IGNORED type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputs: additionalProperties: $ref: '#/components/schemas/ParameterValue' description: The configuration provider bindings. type: object key: description: The RuntimeOperator key. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' metrics: additionalProperties: description: The value of the metric. format: float type: number description: A map metrics for the task run. type: object modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer operator: $ref: '#/components/schemas/Operator' operatorType: description: The type of Runtime Operator enum: - BASH_OPERATOR - TASK_OPERATOR - REST_OPERATOR - START_OPERATOR - END_OPERATOR - EXPRESSION_OPERATOR - MERGE_OPERATOR - DECISION_OPERATOR - LOOP_OPERATOR - ACTUAL_END_OPERATOR type: string outputs: additionalProperties: $ref: '#/components/schemas/ParameterValue' description: The configuration provider bindings. type: object parameters: description: A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' startTimeInMillis: description: The runtime operator start time. format: int64 type: integer status: description: Status of RuntimeOperator. This field is deprecated, use RuntimeOperator's executionState field instead. enum: - NOT_STARTED - QUEUED - RUNNING - TERMINATING - TERMINATED - SUCCESS - ERROR type: string taskRunKey: description: The TaskRun key. type: string taskType: description: The type of task run. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string type: object ChangeCompartmentDetails: description: The information needed to change the workspace compartment. properties: compartmentId: description: The OCID of the compartment to move the the workspace to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ProjectSummary: allOf: - $ref: '#/components/schemas/Project' description: The project summary type contains the audit summary information and the definition of the project. type: object CreateSourceApplicationInfo: description: The information about the application. properties: applicationKey: description: The source application key to use when creating the application. maxLength: 36 minLength: 0 type: string copyType: default: CONNECTED description: Parameter to specify the link between SOURCE and TARGET application after copying. CONNECTED - Indicate that TARGET application is conneced to SOURCE and can be synced after copy. DISCONNECTED - Indicate that TARGET application is not conneced to SOURCE and can evolve independently. enum: - CONNECTED - DISCONNECTED type: string workspaceId: description: The OCID of the workspace containing the application. This allows cross workspace deployment to publish an application from a different workspace into the current workspace specified in this operation. maxLength: 36 minLength: 0 type: string type: object UpdateConnectionDetails: description: Properties used in connection update operations. discriminator: propertyName: modelType properties: connectionProperties: description: The properties for the connection. items: $ref: '#/components/schemas/ConnectionProperty' type: array description: description: User-defined description for the connection. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the connection. enum: - ORACLE_ADWC_CONNECTION - ORACLE_ATP_CONNECTION - ORACLE_OBJECT_STORAGE_CONNECTION - ORACLEDB_CONNECTION - MYSQL_CONNECTION - GENERIC_JDBC_CONNECTION - BICC_CONNECTION - AMAZON_S3_CONNECTION - BIP_CONNECTION - ORACLE_PEOPLESOFT_CONNECTION - ORACLE_EBS_CONNECTION - ORACLE_SIEBEL_CONNECTION - HDFS_CONNECTION - MYSQL_HEATWAVE_CONNECTION - REST_NO_AUTH_CONNECTION - REST_BASIC_AUTH_CONNECTION - OAUTH2_CONNECTION type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - key - objectVersion - modelType type: object TaskRunDetails: description: The task run object provides information on the execution of a task. properties: bytesProcessed: description: Number of bytes processed in task run. format: int64 type: integer description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string endTimeMillis: description: The task run end time. format: int64 type: integer identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputs: additionalProperties: $ref: '#/components/schemas/ParameterValue' description: A map of the configuration provider input bindings of the run. type: object key: description: The object key. maxLength: 36 minLength: 0 type: string lastUpdated: description: The date and time the task run was last updated. format: int64 type: integer metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The object type. maxLength: 4000 minLength: 1 type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' reRunType: description: Supported re-run types enum: - BEGINNING - FAILED - STEP type: string recordsWritten: description: Number of records processed in task run. format: int64 type: integer refTaskRunId: description: Reference Task Run Id to be used for re-run type: string startTimeMillis: description: The task run start time. format: int64 type: integer status: description: status enum: - NOT_STARTED - QUEUED - RUNNING - TERMINATING - TERMINATED - SUCCESS - ERROR type: string stepId: description: Step Id for running from a certain step. type: string taskType: description: The type of the task for the run. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string type: object FolderDetails: description: The details including name, description for the folder, which is a container of other folders, tasks and dataflows. properties: categoryName: description: The category name. maxLength: 4000 minLength: 0 type: string description: description: A user defined description for the folder. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify folder. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - key - objectVersion - modelType type: object UpdateExternalPublicationDetails: description: Properties used to update a published Oracle Cloud Infrastructure Data Flow object. properties: applicationCompartmentId: description: The OCID of the compartment where the application is created in the Oracle Cloud Infrastructure Data Flow Service. maxLength: 255 minLength: 1 type: string applicationId: description: The unique OCID of the identifier that is returned after creating the Oracle Cloud Infrastructure Data Flow application. maxLength: 255 minLength: 1 type: string configurationDetails: $ref: '#/components/schemas/ConfigurationDetails' description: description: The details of the data flow or the application. maxLength: 4000 minLength: 0 type: string displayName: description: The name of the application. maxLength: 255 minLength: 1 type: string resourceConfiguration: $ref: '#/components/schemas/ResourceConfiguration' required: - applicationCompartmentId - displayName type: object CreateScheduleDetails: description: The details for creating a schedule. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string frequencyDetails: $ref: '#/components/schemas/AbstractFrequencyDetails' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isDaylightAdjustmentEnabled: description: A flag to indicate whether daylight adjustment should be considered or not. type: boolean key: description: Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' timezone: description: The timezone for the schedule. type: string required: - name - identifier type: object UpdateScheduleDetails: description: The details for updating a schedule. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string frequencyDetails: $ref: '#/components/schemas/AbstractFrequencyDetails' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isDaylightAdjustmentEnabled: description: A flag to indicate whether daylight adjustment should be considered or not. type: boolean key: description: Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' timezone: description: The timezone for the schedule. type: string required: - key - objectVersion type: object FlowNode: description: The flow node can be connected to other nodes in a data flow with input and output links and is bound to an opertor which defines the semantics of the node. properties: configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. type: string inputLinks: description: An array of input links. items: $ref: '#/components/schemas/InputLink' type: array key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer operator: $ref: '#/components/schemas/Operator' outputLinks: description: An array of output links. items: $ref: '#/components/schemas/OutputLink' type: array parentRef: $ref: '#/components/schemas/ParentReference' uiProperties: $ref: '#/components/schemas/UIProperties' type: object RootObject: description: A base class for all model types, including First Class and its contained objects. properties: key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object UserDefinedFunctionSummaryCollection: description: This is the collection of user defined function summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of user defined function summaries. items: $ref: '#/components/schemas/UserDefinedFunctionSummary' type: array required: - items type: object DataAssetSummaryCollection: description: This is the collection of data asset summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of data asset summaries. items: $ref: '#/components/schemas/DataAssetSummary' type: array required: - items type: object ConfigProvider: description: The information about the configuration provider. properties: bindings: additionalProperties: $ref: '#/components/schemas/ParameterValue' description: The configuration provider bindings. type: object childProviders: additionalProperties: $ref: '#/components/schemas/ConfigProvider' description: The child providers. type: object type: object CreateTaskValidationDetails: description: The task type contains the audit summary information and the definition of the task. discriminator: propertyName: modelType properties: configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputPorts: description: An array of input ports. items: $ref: '#/components/schemas/InputPort' type: array key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in the create operation. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the task. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer opConfigValues: $ref: '#/components/schemas/ConfigValues' outputPorts: description: An array of output ports. items: $ref: '#/components/schemas/OutputPort' type: array parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' type: object CreateEntityShapeDetails: description: The data entity shape object. discriminator: propertyName: modelType properties: modelType: description: The data entity type. enum: - FILE_ENTITY - SQL_ENTITY - OBJECT_ENTITY type: string required: - modelType type: object ConfigParameterDefinition: description: The configurable properties of an object type. properties: classFieldName: description: The parameter class field name. maxLength: 1000 minLength: 1 type: string defaultValue: description: The default value for the parameter. type: object description: description: A user defined description for the object. maxLength: 4000 minLength: 0 type: string isClassFieldValue: description: Specifies whether the parameter is a class field or not. type: boolean isStatic: description: Specifies whether the parameter is static or not. type: boolean parameterName: description: This object represents the configurable properties for an object type. maxLength: 1000 minLength: 1 type: string parameterType: $ref: '#/components/schemas/BaseType' type: object DependentObjectSummaryCollection: description: A list of dependent object summaries. properties: items: description: An array of dependent object summaries. items: $ref: '#/components/schemas/DependentObjectSummary' type: array required: - items type: object DataFlowSummaryCollection: description: This is the collection of data flow summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of data flow summaries. items: $ref: '#/components/schemas/DataFlowSummary' type: array required: - items type: object PublishedObjectSummary: description: The published obect summary. discriminator: propertyName: modelType properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the published object. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' required: - modelType type: object Operator: description: An operator defines some data integration semantics in a data flow. It may be reading/writing data or transforming the data. discriminator: propertyName: modelType properties: description: description: Details about the operator. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputPorts: description: An array of input ports. items: $ref: '#/components/schemas/InputPort' type: array key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The model type of the operator. enum: - SOURCE_OPERATOR - FILTER_OPERATOR - JOINER_OPERATOR - AGGREGATOR_OPERATOR - PROJECTION_OPERATOR - TARGET_OPERATOR - FLATTEN_OPERATOR - DISTINCT_OPERATOR - SORT_OPERATOR - UNION_OPERATOR - INTERSECT_OPERATOR - MINUS_OPERATOR - MERGE_OPERATOR - FUNCTION_OPERATOR - SPLIT_OPERATOR - START_OPERATOR - END_OPERATOR - PIPELINE_OPERATOR - DECISION_OPERATOR - TASK_OPERATOR - EXPRESSION_OPERATOR - LOOKUP_OPERATOR - PIVOT_OPERATOR type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer opConfigValues: $ref: '#/components/schemas/ConfigValues' outputPorts: description: An array of output ports. items: $ref: '#/components/schemas/TypedObject' type: array parameters: description: An array of parameters used in the data flow. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' required: - modelType type: object TaskSummaryCollection: description: This is the collection of task summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of task summaries. items: $ref: '#/components/schemas/TaskSummary' type: array required: - items type: object Folder: description: The folder type contains the audit summary information and the definition of the folder. properties: categoryName: description: The category name. maxLength: 4000 minLength: 0 type: string description: description: A user defined description for the folder. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify folder. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. maxLength: 65 minLength: 0 type: string description: A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object DataEntitySummaryCollection: description: This is the collection of data entity summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of data entity summaries. items: $ref: '#/components/schemas/DataEntitySummary' type: array required: - items type: object ExportRequest: description: Export metadata object response. properties: areReferencesIncluded: default: true description: Controls if the references will be exported along with the objects type: boolean bucketName: description: The name of the Object Storage Bucket where the objects will be exported to type: string createdBy: description: Name of the user who initiated export request. maxLength: 255 minLength: 1 type: string errorMessages: additionalProperties: description: Contains error message if any, if the background job fails minLength: 0 type: string description: Contains key of the error type: object exportedItems: description: The array of exported object details. items: $ref: '#/components/schemas/ExportObjectMetadataSummary' type: array fileName: description: Name of the exported zip file. type: string filters: description: Export multiple objects based on filters. items: type: string type: array isObjectOverwriteEnabled: description: Flag to control whether to overwrite the object if it is already present at the provided object storage location. type: boolean key: description: Export object request key maxLength: 36 type: string name: description: Name of the export request. maxLength: 1000 minLength: 1 type: string objectKeys: description: The list of the objects to be exported items: maxLength: 36 type: string type: array objectStorageRegion: description: Region of the object storage (if using object storage of different region) type: string objectStorageTenancyId: description: Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) type: string referencedItems: description: The array of exported referenced objects. items: $ref: '#/components/schemas/ExportObjectMetadataSummary' type: string status: description: Export Objects request status. enum: - SUCCESSFUL - FAILED - IN_PROGRESS - TERMINATING - TERMINATED - QUEUED type: string timeEndedInMillis: description: Time at which the request was completely processed. format: int64 type: integer timeStartedInMillis: description: Time at which the request started getting processed. format: int64 type: integer totalExportedObjectCount: description: Number of objects that are exported. type: integer type: object TaskScheduleSummary: description: The tsk schedule summary information. properties: authMode: description: The authorization mode for the task. enum: - OBO - RESOURCE_PRINCIPAL - USER_CERTIFICATE type: string configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string endTimeMillis: description: The end time in milliseconds. format: int64 type: integer expectedDuration: description: The expected duration of the task execution. format: double type: number expectedDurationUnit: description: The expected duration unit of the task execution. enum: - SECONDS - MINUTES - HOURS - DAYS type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isBackfillEnabled: default: false description: Whether the backfill is enabled. type: boolean isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean isEnabled: description: Whether the task schedule is enabled. type: boolean key: description: Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string lastRunDetails: $ref: '#/components/schemas/LastRunDetails' metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nextRunTimeMillis: description: The time for next run in milliseconds. format: int64 type: integer numberOfRetries: description: The number of retries. type: integer objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' retryDelay: description: The retry delay, the unit for measurement is in the property retry delay unit. format: double type: number retryDelayUnit: description: The unit for the retry delay. enum: - SECONDS - MINUTES - HOURS - DAYS type: string scheduleRef: $ref: '#/components/schemas/Schedule' startTimeMillis: description: The start time in milliseconds. format: int64 type: integer type: object TemplateSummary: allOf: - $ref: '#/components/schemas/Application' description: The application template summary type contains the audit summary information and the definition of the application template. type: object UpdateDataFlowDetails: allOf: - $ref: '#/components/schemas/DataFlowDetails' description: Properties used in data flow update operations. type: object UserDefinedFunction: description: The user defined function type contains the audit summary information and the definition of the user defined function. properties: description: description: Detailed description for the object. type: string expr: $ref: '#/components/schemas/Expression' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify user defined function. On scenarios where reference to the user defined function is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. enum: - DIS_USER_DEFINED_FUNCTION type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' signatures: description: An array of function signature. items: $ref: '#/components/schemas/FunctionSignature' type: array type: object ParameterValue: description: User defined value for a parameter. properties: rootObjectValue: description: This can be any object such as a file entity, a schema, or a table. type: object simpleValue: description: A simple value for the parameter. type: object type: object TaskScheduleSummaryCollection: description: A collection of TaskSchedule summaries. The collection can be lightweight details or full definitions. properties: items: description: The array of TaskSchedule summaries items: $ref: '#/components/schemas/TaskScheduleSummary' type: array required: - items type: object LastRunDetails: description: The last run details for the task run. properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify Last run details of a task schedule. On scenarios where reference to the lastRunDetails is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string lastRunTimeMillis: description: Time in milliseconds for the pervious schedule. format: int64 type: integer modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object SchemaSummaryCollection: description: This is the collection of schema summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of schema summaries. items: $ref: '#/components/schemas/SchemaSummary' type: array required: - items type: object PipelineSummaryCollection: description: This is the collection of pipeline summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of pipeline summaries. items: $ref: '#/components/schemas/PipelineSummary' type: array required: - items type: object CreateTaskScheduleDetails: description: The create task details. properties: authMode: description: The authorization mode for the task. enum: - OBO - RESOURCE_PRINCIPAL - USER_CERTIFICATE type: string configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string endTimeMillis: description: The end time in milliseconds. format: int64 type: integer expectedDuration: description: The expected duration of the task execution. format: double type: number expectedDurationUnit: description: The expected duration unit of the task execution. enum: - SECONDS - MINUTES - HOURS - DAYS type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isBackfillEnabled: default: false description: Whether the backfill is enabled. type: boolean isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean isEnabled: description: Whether the task schedule is enabled. type: boolean key: description: Generated key that can be used in API calls to identify taskSchedule. On scenarios where reference to the taskSchedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string numberOfRetries: description: The number of retries. type: integer objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' retryDelay: description: The retry delay, the unit for measurement is in the property retry delay unit. format: double type: number retryDelayUnit: description: The unit for the retry delay. enum: - SECONDS - MINUTES - HOURS - DAYS type: string scheduleRef: $ref: '#/components/schemas/Schedule' startTimeMillis: description: The start time in milliseconds. format: int64 type: integer required: - name - identifier type: object UpdateTaskDetails: description: Properties used in task create operations. discriminator: propertyName: modelType properties: configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputPorts: description: An array of input ports. items: $ref: '#/components/schemas/InputPort' type: array isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the task. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer opConfigValues: $ref: '#/components/schemas/ConfigValues' outputPorts: description: An array of output ports. items: $ref: '#/components/schemas/OutputPort' type: array parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' required: - key - objectVersion - modelType type: object TaskRunSummaryCollection: description: A list of task run summaries. properties: items: description: The array of task run summaries. items: $ref: '#/components/schemas/TaskRunSummary' type: array required: - items type: object Reference: description: Reference contains application configuration information. properties: applicationKey: description: The application key of the reference object. maxLength: 36 minLength: 0 type: string childReferences: description: List of references that are dependent on this reference. items: $ref: '#/components/schemas/ChildReference' type: array description: description: The description of reference object. maxLength: 4000 minLength: 0 type: string identifier: description: The identifier of reference object. maxLength: 255 minLength: 1 type: string identifierPath: description: The identifier path of reference object. maxLength: 1000 minLength: 1 type: string key: description: The reference's key, key of the object that is being used by a published object or its dependents. maxLength: 36 minLength: 0 type: string name: description: The name of reference object. maxLength: 255 minLength: 1 type: string targetObject: description: The new reference object to use instead of the original reference. For example, this can be a data asset reference. type: object type: description: The type of reference object. enum: - ORACLE_DATA_ASSET - ORACLE_OBJECT_STORAGE_DATA_ASSET - ORACLE_ATP_DATA_ASSET - ORACLE_ADWC_DATA_ASSET - MYSQL_DATA_ASSET - GENERIC_JDBC_DATA_ASSET - FUSION_APP_DATA_ASSET - AMAZON_S3_DATA_ASSET - SCHEMA - INTEGRATION_TASK - DATA_LOADER_TASK - SQL_TASK - OCI_DATAFLOW_TASK - PIPELINE_TASK - REST_TASK type: string usedBy: description: List of published objects where this is used. items: $ref: '#/components/schemas/ReferenceUsedBy' type: array type: object TaskRun: description: The information about a task run. properties: authMode: description: The autorization mode for when the task was executed. enum: - OBO - RESOURCE_PRINCIPAL - USER_CERTIFICATE type: string bytesProcessed: description: The number of bytes processed in the task run. format: int64 type: integer configProvider: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string endTimeMillis: description: The end time. format: int64 type: integer errorMessage: description: Contains an error message if status is `ERROR`. maxLength: 4000 minLength: 1 type: string executionErrors: description: An array of execution errors from the run. items: maxLength: 4000 minLength: 1 type: string type: array expectedDuration: description: The expected duration for the task run. format: double type: number expectedDurationUnit: description: The expected duration unit of measure. enum: - SECONDS - MINUTES - HOURS - DAYS type: string externalId: description: The external identifier for the task run. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string isLogProcessingInProgress: default: false description: This field tells the user if there is any logs being fetched in backend for failure. Applicable only for failed pipeline tasks. type: boolean key: description: The key of the object. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object lastUpdated: description: The date and time the object was last updated. format: int64 type: integer metadata: $ref: '#/components/schemas/ObjectMetadata' metrics: additionalProperties: description: The value of the metric. format: float type: number description: A map of metrics for the run. type: object modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer opcRequestId: description: The OPC request ID of execution of the task run. maxLength: 255 minLength: 1 type: string outputs: additionalProperties: $ref: '#/components/schemas/ParameterValue' description: A map of the outputs of the run. type: object parentRef: $ref: '#/components/schemas/ParentReference' recordsWritten: description: The number of records processed in the task run. format: int64 type: integer retryAttempt: description: Holds the particular attempt number. minimum: 0 type: integer startTimeMillis: description: The start time. format: int64 type: integer status: description: The status of the task run. enum: - NOT_STARTED - QUEUED - RUNNING - TERMINATING - TERMINATED - SUCCESS - ERROR type: string taskKey: description: Task Key of the task for which TaskRun is being created. If not specified, the AggregatorKey in RegistryMetadata will be assumed to be the TaskKey type: string taskSchedule: $ref: '#/components/schemas/TaskSchedule' taskType: description: The type of task run. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string terminationErrors: description: An array of termination errors from the run. items: maxLength: 4000 minLength: 1 type: string type: array type: object Connection: description: The connection for a data asset. discriminator: propertyName: modelType properties: connectionProperties: description: The properties for the connection. items: $ref: '#/components/schemas/ConnectionProperty' type: array description: description: User-defined description for the connection. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string isDefault: default: false description: The default property for the connection. type: boolean key: description: Generated key that can be used in API calls to identify connection. On scenarios where reference to the connection is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the connection. enum: - ORACLE_ADWC_CONNECTION - ORACLE_ATP_CONNECTION - ORACLE_OBJECT_STORAGE_CONNECTION - ORACLEDB_CONNECTION - MYSQL_CONNECTION - GENERIC_JDBC_CONNECTION - BICC_CONNECTION - AMAZON_S3_CONNECTION - BIP_CONNECTION - ORACLE_PEOPLESOFT_CONNECTION - ORACLE_EBS_CONNECTION - ORACLE_SIEBEL_CONNECTION - HDFS_CONNECTION - MYSQL_HEATWAVE_CONNECTION - REST_NO_AUTH_CONNECTION - REST_BASIC_AUTH_CONNECTION - OAUTH2_CONNECTION type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' primarySchema: $ref: '#/components/schemas/Schema' required: - modelType type: object CreateConfigProvider: description: The type to create a config provider. properties: bindings: additionalProperties: $ref: '#/components/schemas/ParameterValue' description: bindings type: object type: object ImportRequest: description: Import metadata object response. properties: areDataAssetReferencesIncluded: default: true description: This field controls if the data asset references will be included during import. type: boolean bucketName: description: The name of the Object Storage Bucket where the objects will be imported from type: string createdBy: description: Name of the user who initiated import request. maxLength: 255 minLength: 1 type: string errorMessages: additionalProperties: description: Contains error message if any, if the background job fails minLength: 0 type: string description: Contains key of the error type: object fileName: description: Name of the zip file from which objects will be imported. type: string importConflictResolution: $ref: '#/components/schemas/ImportConflictResolution' importedObjects: description: The array of imported object details. items: $ref: '#/components/schemas/ImportObjectMetadataSummary' type: array key: description: Import object request key maxLength: 36 type: string name: description: Name of the import request. maxLength: 1000 minLength: 1 type: string objectKeyForImport: description: Key of the object inside which all the objects will be imported type: string objectStorageRegion: description: Region of the object storage (if using object storage of different region) type: string objectStorageTenancyId: description: Optional parameter to point to object storage tenancy (if using Object Storage of different tenancy) type: string status: description: Import Objects request status. enum: - SUCCESSFUL - FAILED - IN_PROGRESS - TERMINATING - TERMINATED - QUEUED type: string timeEndedInMillis: description: Time at which the request was completely processed. format: int64 type: integer timeStartedInMillis: description: Time at which the request started getting processed. format: int64 type: integer totalImportedObjectCount: description: Number of objects that are imported. type: integer type: object TaskSummary: description: The task summary object type contains the audit summary information and the definition of the task summary object. discriminator: propertyName: modelType properties: configProviderDelegate: $ref: '#/components/schemas/ConfigProvider' description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string inputPorts: description: An array of input ports. items: $ref: '#/components/schemas/InputPort' type: array isConcurrentAllowed: default: true description: Whether the same task can be executed concurrently. type: boolean key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of task. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer opConfigValues: $ref: '#/components/schemas/ConfigValues' outputPorts: description: An array of output ports. items: $ref: '#/components/schemas/OutputPort' type: array parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' type: object DataFlow: description: The data flow type contains the audit summary information and the definition of the data flow. properties: description: description: Detailed description for the object. type: string flowConfigValues: $ref: '#/components/schemas/ConfigValues' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify data flow. On scenarios where reference to the data flow is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. minLength: 0 type: string description: A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string nodes: description: An array of nodes. items: $ref: '#/components/schemas/FlowNode' type: array objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parameters: description: An array of parameters. items: $ref: '#/components/schemas/Parameter' type: array parentRef: $ref: '#/components/schemas/ParentReference' targetFieldMapSummary: additionalProperties: $ref: '#/components/schemas/FieldMapWrapper' description: A hash map that maps TypedObject keys to a field map that maps to the typed object as a target, for java sdk. type: object typedObjectMap: additionalProperties: $ref: '#/components/schemas/TypedObjectWrapper' description: A hash map that maps TypedObject keys to the object itself, for java sdk. type: object type: object CreateDisApplicationDetails: description: Properties used in application create operations. properties: compartmentId: description: OCID of the compartment that this resource belongs to. Defaults to compartment of the Workspace. maxLength: 255 minLength: 131 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string displayName: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Currently not used on application creation. Reserved for future. maxLength: 36 minLength: 0 type: string lifecycleState: description: The current state of the workspace. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string modelType: description: The type of the application. enum: - INTEGRATION_APPLICATION type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' sourceApplicationInfo: $ref: '#/components/schemas/CreateSourceApplicationInfo' required: - name - identifier type: object ReferenceSummary: description: This is the reference summary information. properties: aggregatorKey: description: The aggregator of reference object. maxLength: 36 minLength: 0 type: string childReferences: description: List of references that are dependent on this reference. items: $ref: '#/components/schemas/ChildReference' type: array description: description: The description of reference object. maxLength: 4000 minLength: 0 type: string identifier: description: The identifier of reference object. maxLength: 255 minLength: 1 type: string identifierPath: description: The identifier path of reference object. maxLength: 1000 minLength: 1 type: string key: description: The reference's key, key of the object that is being used by a published object or its dependents. maxLength: 36 minLength: 0 type: string name: description: The name of reference object. maxLength: 255 minLength: 1 type: string targetObject: description: The target object referenced. References are made to data assets and child references are made to connections. The type defining this reference is mentioned in the property type. type: object type: description: The type of reference object. enum: - ORACLE_DATA_ASSET - ORACLE_OBJECT_STORAGE_DATA_ASSET - ORACLE_ATP_DATA_ASSET - ORACLE_ADWC_DATA_ASSET - MYSQL_DATA_ASSET - GENERIC_JDBC_DATA_ASSET - FUSION_APP_DATA_ASSET - AMAZON_S3_DATA_ASSET - SCHEMA - INTEGRATION_TASK - DATA_LOADER_TASK - SQL_TASK - OCI_DATAFLOW_TASK - PIPELINE_TASK - REST_TASK type: string usedBy: description: List of published objects where this is used. items: $ref: '#/components/schemas/ReferenceUsedBy' type: array type: object Schedule: description: The schedule object properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string frequencyDetails: $ref: '#/components/schemas/AbstractFrequencyDetails' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string isDaylightAdjustmentEnabled: description: A flag to indicate daylight saving. type: boolean key: description: Generated key that can be used in API calls to identify schedule. On scenarios where reference to the schedule is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' timezone: description: The timezone for the schedule. type: string type: object ImportConflictResolution: description: Import Objects Conflict resolution. properties: duplicatePrefix: default: '' description: In case of DUPLICATE mode, prefix will be used to disambiguate the object. type: string duplicateSuffix: default: '' description: In case of DUPLICATE mode, suffix will be used to disambiguate the object. type: string importConflictResolutionType: default: RETAIN description: Import Objects Conflict resolution Type (RETAIN/DUPLICATE/REPLACE). enum: - DUPLICATE - REPLACE - RETAIN type: string required: - importConflictResolutionType type: object PublishedObject: description: The information about the published object. discriminator: propertyName: modelType properties: description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the published object. enum: - INTEGRATION_TASK - DATA_LOADER_TASK - PIPELINE_TASK - SQL_TASK - OCI_DATAFLOW_TASK - REST_TASK type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' required: - modelType type: object PipelineValidation: description: The information about a pipeline validation. properties: description: description: Detailed description for the object. type: string errorMessageCount: description: The total number of validation error messages. type: integer identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string infoMessageCount: description: The total number of validation information messages. type: integer key: description: Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. maxLength: 36 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' totalMessageCount: description: The total number of validation messages. type: integer validationMessages: additionalProperties: items: $ref: '#/components/schemas/ValidationMessage' type: array description: The detailed information of the pipeline object validation. type: object warnMessageCount: description: The total number of validation warning messages. type: integer type: object CreateApplicationDetails: description: Properties used in application create operations. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string displayName: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Currently not used on application creation. Reserved for future. maxLength: 36 minLength: 0 type: string lifecycleState: description: The current state of the workspace. enum: - CREATING - ACTIVE - UPDATING - DELETING - DELETED - FAILED type: string modelType: description: The type of the application. enum: - INTEGRATION_APPLICATION type: string modelVersion: description: The object's model version. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer registryMetadata: $ref: '#/components/schemas/RegistryMetadata' sourceApplicationInfo: $ref: '#/components/schemas/CreateSourceApplicationInfo' required: - name - identifier type: object ExternalPublicationValidationSummaryCollection: description: This is the collection of external publication validation summaries. It may be a collection of lightweight details or full definitions. properties: items: description: The array of external publication summaries. items: $ref: '#/components/schemas/ExternalPublicationValidationSummary' type: array required: - items type: object CompositeState: description: The composite state object provides information on the state of a task or schedule. properties: allStatesMap: additionalProperties: $ref: '#/components/schemas/State' description: Map that stores all the States for a given Task or Schedule type: object compositeStateAggregator: description: The type of the Composite State Aggregator. enum: - TASK_SCHEDULE - TASK - TASK_OPERATOR type: string description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify Composite State. maxLength: 36 minLength: 0 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' type: object FunctionLibrary: description: The FunctionLibrary type contains the audit summary information and the definition of the FunctionLibrary. properties: categoryName: description: The category name. maxLength: 4000 minLength: 0 type: string description: description: A user defined description for the Function Library. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify FunctionLibrary. maxLength: 36 minLength: 0 type: string keyMap: additionalProperties: description: The generated key. maxLength: 65 minLength: 0 type: string description: A key map. If provided, the key is replaced with generated key. This structure provides mapping between user provided key and generated key. type: object metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. enum: - FUNCTION_LIBRARY type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object PatchChangeSummaryCollection: description: This is the collection of patch report summaries,. It may be a collection of lightweight details or full definitions. properties: items: description: The array of patch summaries. items: $ref: '#/components/schemas/PatchChangeSummary' type: array required: - items type: object ExportRequestSummaryCollection: description: This is the collection of export object requests. properties: items: description: The array of export object requests status summaries. items: $ref: '#/components/schemas/ExportRequestSummary' type: array required: - items type: object CopyObjectRequest: description: Copy metadata object request. properties: copiedItems: description: The array of copy object details. items: $ref: '#/components/schemas/CopyObjectMetadataSummary' type: array copyConflictResolution: $ref: '#/components/schemas/CopyConflictResolution' copyMetadataObjectRequestStatus: description: Copy Object request status. enum: - SUCCESSFUL - FAILED - IN_PROGRESS - QUEUED - TERMINATING - TERMINATED type: string createdBy: description: OCID of the user who initiated copy request. maxLength: 255 minLength: 1 type: string createdByName: description: Name of the user who created the copy object request. maxLength: 255 minLength: 1 type: string key: description: Copy object request key. maxLength: 36 type: string name: description: Name of the copy object request. maxLength: 1000 minLength: 1 type: string objectKeys: description: The list of the objects to be copied. items: maxLength: 36 type: string type: array referencedItems: description: The array of copied referenced objects. items: $ref: '#/components/schemas/CopyObjectMetadataSummary' type: array sourceWorkspaceId: description: The workspace id of the source from where we need to copy object. type: string timeEndedInMillis: description: Time at which the request was completely processed. format: int64 type: integer timeStartedInMillis: description: Time at which the request started getting processed. format: int64 type: integer totalObjectsCopiedIntoTarget: description: Number of objects copied into the target. type: integer totalSourceObjectCount: description: Number of source objects to be copied. type: integer type: object DependentObject: allOf: - $ref: '#/components/schemas/ApplicationSummary' description: The information about a dependent object. type: object CreateDataFlowValidationDetails: allOf: - $ref: '#/components/schemas/DataFlow' description: The properties used in create dataflow validation operations. type: object ConfiguredType: allOf: - $ref: '#/components/schemas/BaseType' - discriminator: propertyName: CONFIGURED_TYPE properties: configDefinition: $ref: '#/components/schemas/ConfigDefinition' configValues: $ref: '#/components/schemas/ConfigValues' wrappedType: description: A wrapped type, may be a string or a BaseType. type: object description: A `ConfiguredType` represents a type that has built-in configuration to the type itself. An example is a `SSN` type whose basic type is `VARCHAR`, but the type itself also has a built-in configuration like length=10. type: object DataFlowValidationSummaryCollection: description: A list of data flow validation summaries. properties: items: description: The array of validation summaries. items: $ref: '#/components/schemas/DataFlowValidationSummary' type: array required: - items type: object ApplicationSummaryCollection: description: This is the collection of application summaries, it may be a collection of lightweight details or full definitions. properties: items: description: The array of application summaries. items: $ref: '#/components/schemas/ApplicationSummary' type: array required: - items type: object RegistryMetadata: description: Information about the object and its parent. properties: aggregatorKey: description: The owning object's key for this object. maxLength: 36 minLength: 0 type: string isFavorite: default: false description: Specifies whether this object is a favorite or not. type: boolean key: description: The identifying key for the object. maxLength: 36 minLength: 0 type: string labels: description: Labels are keywords or labels that you can add to data assets, dataflows etc. You can define your own labels and use them to categorize content. items: maxLength: 4000 minLength: 0 type: string type: array registryVersion: description: The registry version. type: integer type: object UpdateCopyObjectRequestDetails: description: Properties used in copy object request update operations. properties: status: description: The status of the object. enum: - TERMINATING type: string type: object DataFlowValidation: description: The information about a data flow validation. properties: description: description: Detailed description for the object. type: string errorMessageCount: description: The total number of validation error messages. type: integer identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string infoMessageCount: description: The total number of validation information messages. type: integer key: description: Objects will use a 36 character key as unique ID. It is system generated and cannot be modified. maxLength: 36 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of the object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: The version of the object that is used to track changes in the object instance. type: integer parentRef: $ref: '#/components/schemas/ParentReference' totalMessageCount: description: The total number of validation messages. type: integer validationMessages: additionalProperties: items: $ref: '#/components/schemas/ValidationMessage' type: array description: The detailed information of the data flow object validation. type: object warnMessageCount: description: The total number of validation warning messages. type: integer type: object UpdateDetailedDescriptionDetails: allOf: - $ref: '#/components/schemas/CreateDetailedDescriptionDetails' description: Properties used in detailed description update operations. type: object CopyObjectRequestSummary: allOf: - $ref: '#/components/schemas/CopyObjectRequest' description: Copy metadata object response summary. type: object DependentObjectSummary: allOf: - $ref: '#/components/schemas/ObjectMetadata' description: Details of the dependent object. type: object TaskRunLogSummary: description: A log message from the execution of a task. properties: message: description: A user-friendly log message. type: string BaseType: description: Base type for the type system. discriminator: propertyName: modelType properties: description: description: A user defined description for the object. type: string key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The property which disciminates the subtypes. enum: - DYNAMIC_TYPE - STRUCTURED_TYPE - DATA_TYPE - JAVA_TYPE - CONFIGURED_TYPE - COMPOSITE_TYPE - DERIVED_TYPE - ARRAY_TYPE - MAP_TYPE - MATERIALIZED_COMPOSITE_TYPE type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' required: - modelType type: object ScheduleSummaryCollection: description: A collection of schedule summaries. The collection can be lightweight details or full definitions. properties: items: description: An array of Schedule summaries items: $ref: '#/components/schemas/ScheduleSummary' type: array required: - items type: object UserDefinedFunctionValidationSummary: allOf: - $ref: '#/components/schemas/UserDefinedFunctionValidation' description: The information about a UserDefinedFunction validation. type: object Template: allOf: - $ref: '#/components/schemas/Application' description: Template application. type: object ImportRequestSummaryCollection: description: This is the collection of import object requests. properties: items: description: The array of import object requests status summaries. items: $ref: '#/components/schemas/ImportRequestSummary' type: array required: - items type: object ValidationMessage: description: The level, message key, and validation message. properties: level: description: The total number of validation messages. type: string messageKey: description: The validation message key. type: string validationMessage: description: The validation message. type: string type: object UpdateDisApplicationDetails: allOf: - $ref: '#/components/schemas/UpdateApplicationDetails' description: Properties used in DIS Application create operations. type: object CopyObjectMetadataSummary: description: Details of copied objects. properties: aggregatorKey: description: Aggregator key maxLength: 36 type: string identifier: description: Object identifier. maxLength: 1000 minLength: 1 type: string name: description: Name of the object. maxLength: 1000 minLength: 1 type: string namePath: description: Object name path. maxLength: 4000 minLength: 1 type: string newKey: description: New key of the object to identify the copied object. For example the new dataflow key. maxLength: 36 type: string objectType: description: Object type. maxLength: 4000 minLength: 1 type: string objectVersion: description: Object version. maxLength: 255 minLength: 1 type: string oldKey: description: Old key of the object from where the object was copied. For example a dataflow key within the project being copied. maxLength: 36 type: string resolutionAction: description: Object resolution action. enum: - CREATED - RETAINED - DUPLICATED - REPLACED type: string timeUpdatedInMillis: description: time at which this object was last updated. format: int64 type: integer type: object ExternalPublicationSummaryCollection: description: This is the collection of external publication summaries. It may be a collection of lightweight details or full definitions. properties: items: description: The array of external publication summaries. items: $ref: '#/components/schemas/ExternalPublicationSummary' type: array required: - items type: object CreateUserDefinedFunctionDetails: description: Properties used in user defined function create operations. properties: description: description: Detailed description for the object. type: string expr: $ref: '#/components/schemas/Expression' identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. maxLength: 1000 minLength: 1 type: string key: description: Generated key that can be used in API calls to identify user defined function. On scenarios where reference to the user defined function is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' registryMetadata: $ref: '#/components/schemas/RegistryMetadata' signatures: description: An array of function signature. items: $ref: '#/components/schemas/FunctionSignature' type: array required: - name - identifier - registryMetadata type: object CreatePipelineValidationDetails: allOf: - $ref: '#/components/schemas/Pipeline' description: The properties used in create pipeline validation operations. type: object TaskValidationSummaryCollection: description: A list of task validation summaries. properties: items: description: An array of validation summaries. items: $ref: '#/components/schemas/TaskValidationSummary' type: array required: - items type: object ObjectMetadata: description: A summary type containing information about the object including its key, name and when/who created/updated it. properties: aggregator: $ref: '#/components/schemas/AggregatorSummary' aggregatorKey: description: The owning object key for this object. maxLength: 36 minLength: 0 type: string countStatistics: $ref: '#/components/schemas/CountStatistic' createdBy: description: The user that created the object. maxLength: 255 type: string createdByName: description: The user that created the object. maxLength: 400 type: string identifierPath: description: The full path to identify this object. maxLength: 4000 type: string infoFields: additionalProperties: description: The additional properties field. maxLength: 4000 minLength: 0 type: string description: Information property fields. type: object isFavorite: default: false description: Specifies whether this object is a favorite or not. type: boolean labels: description: Labels are keywords or tags that you can add to data assets, dataflows and so on. You can define your own labels and use them to categorize content. items: maxLength: 4000 minLength: 0 type: string type: array registryVersion: description: The registry version of the object. type: integer timeCreated: description: The date and time that the object was created. format: date-time type: string timeUpdated: description: The date and time that the object was updated. format: date-time type: string updatedBy: description: The user that updated the object. maxLength: 255 type: string updatedByName: description: The user that updated the object. maxLength: 400 type: string type: object RuntimeOperatorSummary: allOf: - $ref: '#/components/schemas/RuntimeOperator' description: The information about RuntimeOperator. type: object DisApplication: allOf: - $ref: '#/components/schemas/Application' description: DIS Application is container for runtime objects. type: object DataEntitySummary: description: The data entity summary object. discriminator: propertyName: modelType properties: metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The data entity type. enum: - VIEW_ENTITY - TABLE_ENTITY - FILE_ENTITY - SQL_ENTITY - OBJECT_ENTITY - DATA_STORE_ENTITY type: string required: - modelType type: object ChangeDisApplicationCompartmentDetails: description: The information needed to change the DIS Application compartment. properties: compartmentId: description: The OCID of the compartment to move the the DIS Application to. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object ConfigDefinition: description: The configuration details of a configurable object. This contains one or more config param definitions. properties: configParameterDefinitions: additionalProperties: $ref: '#/components/schemas/ConfigParameterDefinition' description: The parameter configuration details. type: object isContained: description: Specifies whether the configuration is contained or not. type: boolean key: description: The key of the object. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: The model version of an object. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer parentRef: $ref: '#/components/schemas/ParentReference' type: object PipelineSummary: allOf: - $ref: '#/components/schemas/Pipeline' description: The pipeline summary type contains the audit summary information and the definition of the pipeline. type: object ChildReference: description: Child reference contains application configuration information. properties: aggregatorKey: description: The aggregator key of the child reference object. For example, this can be a data asset key. maxLength: 36 minLength: 0 type: string description: description: The description of reference object. maxLength: 4000 minLength: 0 type: string identifier: description: The identifier of reference object. maxLength: 255 minLength: 1 type: string identifierPath: description: The identifier path of reference object. maxLength: 1000 minLength: 1 type: string key: description: The reference's key, key of the object that is being used by a published object or its dependents. maxLength: 36 minLength: 0 type: string name: description: The name of reference object. maxLength: 255 minLength: 1 type: string targetObject: description: The new reference object to use instead of the original reference. For example, this can be a data asset reference. type: object type: description: The type of the reference object. enum: - ORACLEDB_CONNECTION - ORACLE_OBJECT_STORAGE_CONNECTION - ORACLE_ATP_CONNECTION - ORACLE_ADWC_CONNECTION - MYSQL_CONNECTION - GENERIC_JDBC_CONNECTION - BIP_CONNECTION - BICC_CONNECTION - AMAZON_S3_CONNECTION type: string usedBy: description: List of published objects where this is used. items: $ref: '#/components/schemas/ReferenceUsedBy' type: array type: object Variable: description: Variable definitions in the pipeline. properties: configValues: $ref: '#/components/schemas/ConfigValues' defaultValue: description: A default value for the vairable. type: object description: description: Detailed description for the object. maxLength: 4000 minLength: 0 type: string identifier: description: Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified. type: string key: description: Generated key that can be used in API calls to identify variable. On scenarios where reference to the variable is needed, a value can be passed in create. maxLength: 36 minLength: 0 type: string modelType: description: The type of the object. maxLength: 4000 minLength: 1 type: string modelVersion: description: This is a version number that is used by the service to upgrade objects if needed through releases of the service. maxLength: 255 minLength: 1 type: string name: description: Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters. maxLength: 1000 minLength: 1 type: string objectStatus: description: The status of an object that can be set to value 1 for shallow references across objects, other values reserved. minimum: 0 type: integer objectVersion: description: This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object. type: integer parentRef: $ref: '#/components/schemas/ParentReference' rootObjectDefaultValue: $ref: '#/components/schemas/RootObject' type: $ref: '#/components/schemas/BaseType' type: object ConfigurationDetails: description: A key map. If provided, key is replaced with generated key. properties: compartmentId: description: The compartment ID of the object store. type: string connection: $ref: '#/components/schemas/Connection' dataAsset: $ref: '#/components/schemas/DataAsset' schema: $ref: '#/components/schemas/Schema' type: object DataEntity: description: The data entity object. discriminator: propertyName: modelType properties: metadata: $ref: '#/components/schemas/ObjectMetadata' modelType: description: The data entity type. enum: - VIEW_ENTITY - TABLE_ENTITY - FILE_ENTITY - SQL_ENTITY - OBJECT_ENTITY - DATA_STORE_ENTITY - DERIVED_ENTITY type: string required: - modelType type: object SourceApplicationInfo: description: The information about the application. properties: applicationKey: description: The source application key to use when creating the application. maxLength: 36 minLength: 0 type: string applicationVersion: description: The source application version of the application. maxLength: 36 minLength: 0 type: string lastPatchKey: description: The last patch key for the application. maxLength: 36 minLength: 0 type: string workspaceId: description: The OCID of the workspace containing the application. This allows cross workspace deployment to publish an application from a different workspace into the current workspace specified in this operation. maxLength: 36 minLength: 0 type: string type: object responses: DefaultError: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' type: string opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: 'Total items in the entire list. ' type: integer opc-work-request-id: description: 'The [OCID](/iaas/Content/API/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' type: string retry-after: description: Indicates the number of seconds to wait before making a follow-up request. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer, and boolean types are supported. ' type: object description: 'Key-value pairs representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object x-splat: activeStoppingDeletingCompartmentId: 'workspace = downstream.getOr404(''DIS-PROD-CP'',''GetWorkspace'', request.urlPathSegments[2]); splat.getOrThrow(workspace?.lifecycleState==''ACTIVE'' ||workspace?.lifecycleState==''STOPPING'' ||workspace?.lifecycleState==''DELETING''? workspace.compartmentId : '''',''InvalidParameter'',''workspace does not exist or not valid'')' applicationKey: request.urlPathSegments[4] folderKey: '(request.body?.registryMetadata)? request.body.registryMetadata.aggregatorKey : null' functionLibraryKey: '(request.body?.registryMetadata)? request.body.registryMetadata.aggregatorKey : null' objectKey: request.urlPathSegments[4] onlyActiveCompartmentId: 'workspace = downstream.getOr404(''DIS-PROD-CP'',''GetWorkspace'', request.urlPathSegments[2]); splat.getOrThrow(workspace?.lifecycleState==''ACTIVE'' ? workspace.compartmentId : '''',''InvalidParameter'',''workspace does not exist or not valid'')' onlyActiveObjectSourceCompartmentId: 'workspace = downstream.getOr404(''DIS-PROD-CP'',''GetWorkspace'', (request.body?.sourceWorkspaceId? request.body.sourceWorkspaceId : request.urlPathSegments[2])); splat.getOrThrow(workspace?.lifecycleState==''ACTIVE'' ? workspace.compartmentId : '''',''NotAuthorizedOrNotFound'',''Authorization failed or requested resource not found.'')' onlyActiveSourceCompartmentId: 'workspace = downstream.getOr404(''DIS-PROD-CP'',''GetWorkspace'', (request.body?.sourceApplicationInfo?.workspaceId? request.body.sourceApplicationInfo.workspaceId : request.urlPathSegments[2])); splat.getOrThrow(workspace?.lifecycleState==''ACTIVE'' ? workspace.compartmentId : '''',''NotAuthorizedOrNotFound'',''Authorization failed or requested resource not found.'')' reRunType: description: Supported re-run types enum: - BEGINNING - FAILED - STEP type: string runtimeOperatorKey: request.urlPathSegments[8] runtimePipelineKey: request.urlPathSegments[6] sourceApplicationKey: '(request.body?.sourceApplicationInfo?.applicationKey)? request.body.sourceApplicationInfo.applicationKey : null' sourceObjectWorkspaceId: '(request.body?.sourceWorkspaceId)? request.body.sourceWorkspaceId : null' sourceWorkspaceId: '(request.body?.sourceApplicationInfo?.workspaceId)? request.body.sourceApplicationInfo.workspaceId : null' workspaceId: request.urlPathSegments[2] x-oracle-package: com.oracle.dis.service