{ "swagger":"2.0", "x-oracle-package":"com.oracle.datalake", "x-obmcs-splat":{ "version":"1.0", "services":{ "${service_yaml_prefix}-DP-API${service_yaml_suffix}":{ "forwardOptionsRequest":true, "allowingUnreviewedEntityType":true, "audit":{ "defaultMode":"automated", "eventSource":"aidataplatform", "requestParameterRules":[ { "resources":".*", "actions":".*", "values":".*" } ], "requestHeaderRules":[ { "resources":".*", "actions":".*", "values":".*" } ], "responseHeaderRules":[ { "resources":".*", "actions":".*", "values":".*" } ] } } } }, "info":{ "title":"REST API for Oracle AI Data Platform Workbench", "description":"

Oracle AI Data Platform Workbench provides a dedicated development environment for data professionals to design, orchestrate, and deploy data pipelines and AI models using Spark-powered notebooks.

", "version":"2026.05.08", "x-summary":"Oracle AI Data Platform Workbench provides a dedicated development environment for data professionals to design, orchestrate, and deploy data pipelines and AI models using Spark-powered notebooks." }, "schemes":[ "http", "https" ], "basePath":"/20260430", "produces":[ "application/json" ], "x-obmcs-client-retries-enabled":true, "x-obmcs-issue-routing-table":{ "default":{ "phonebookId":"datalake", "email":"manish.vaishnani@oracle.com", "jiraProject":"DATAHUB", "opsJiraProject":"DATAHUB", "githubUsers":[ "githubUser1", "githubUser2" ] } }, "x-obmcs-endpoint-template":"https://datalake.{region}.oci.{secondLevelDomain}", "x-obmcs-use-shared-work-requests-service":false, "x-anchors":{ "x-headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-next-page":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" }, "opc-prev-page":{ "description":"For list pagination. When this header appears in the response, previous pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" }, "opc-total-items":{ "description":"For list pagination. This header provides total number of items available. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"integer" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "retry-after":{ "type":"integer", "description":"A decimal number representing the number of seconds the client should wait before polling this endpoint again." } }, "x-properties":{ "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } }, "x-splat":{ "aiDataPlatformId":"request.urlPathSegments[2]", "onlyActiveAidataplatformCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "ActiveOrCreatingOrDeletingOrFailedAidataplatformCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "dataLakeId":"request.urlPathSegments[2]", "onlyActiveDataLakeCompartmentId":"dataLake = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetDataLake', request.urlPathSegments[2]); splat.getOrThrow(dataLake?.lifecycleState=='ACTIVE' ? dataLake.compartmentId : '','InvalidParameter','Data Lake does not exist or not valid')", "ActiveOrCreatingDataLakeCompartmentId":"dataLake = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetDataLake', request.urlPathSegments[2]); splat.getOrThrow(dataLake?.lifecycleState=='ACTIVE' || dataLake?.lifecycleState=='CREATING' || dataLake?.lifecycleState=='DELETING'? dataLake.compartmentId : '','InvalidParameter','Data Lake does not exist or not valid')", "ActiveOrCreatingOrDeletingOrFailedDataLakeCompartmentId":"dataLake = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetDataLake', request.urlPathSegments[2]); splat.getOrThrow(dataLake?.lifecycleState=='ACTIVE' || dataLake?.lifecycleState=='CREATING' || dataLake?.lifecycleState=='DELETING' || dataLake?.lifecycleState=='FAILED' ? dataLake.compartmentId : '','InvalidParameter','Data Lake does not exist or not valid')" } }, "paths":{ "/aiDataPlatforms/{aiDataPlatformId}/workspaces":{ "get":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformWorkspaces", "summary":"Get a list of workspaces", "description":"Gets a list of AI Data Platform Workbench workspaces.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceLifecycleStateQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/DisplayNameContainsQueryParam" }, { "$ref":"#/parameters/WorkspaceTypeQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/WorkspaceSortByQueryParam" }, { "$ref":"#/parameters/WorkspacePrivateNetworkEnabledQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/WorkspaceCollection", "responses":{ "200":{ "description":"A page of workspace summary objects is retrieved.", "schema":{ "$ref":"#/definitions/WorkspaceCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-get" }, "post":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformWorkspace", "summary":"Create a workspace", "description":"Creates an AI Data Platform Workbench workspace.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateWorkspaceDetails", "description":"Details for the new AI Data Platform Workbench workspace.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateWorkspaceDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Workspace", "responses":{ "201":{ "description":"Accepted the request. The AI Data Platform Workbench workspace is created.", "schema":{ "$ref":"#/definitions/Workspace" }, "headers":{ "location":{ "description":"URL for the created AI Data Platform Workbench workspace. The AI Data Platform Workbench workspace key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}":{ "get":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformWorkspace", "summary":"Get workspace details", "description":"Gets detailed information about an AI Data Platform Workbench workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"The AI Data Platform Workbench workspace details are retrieved.", "schema":{ "$ref":"#/definitions/Workspace" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-get" }, "put":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformWorkspace", "summary":"Update a workspace", "description":"Updates the details of an AI Data Platform Workbench workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"UpdateWorkspaceDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateWorkspaceDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Workspace", "responses":{ "202":{ "description":"Accepted the request. The AI Data Platform Workbench workspace details are updated.", "schema":{ "$ref":"#/definitions/Workspace" }, "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-put" }, "delete":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "eventGroupIdExpression":"response.headers['aidp-async-operation-key']", "resourceNameExpression":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.resourceId).displayName" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformWorkspace", "summary":"Delete a workspace", "description":"Deletes an AI Data Platform Workbench workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/TimeDeletedHeader" } ], "x-related-resource":"#/definitions/Workspace", "responses":{ "202":{ "description":"Accepted the request. The AI Data Platform Workbench workspace is deleted.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/permissions":{ "get":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformWorkspacePermissions", "summary":"Get a list of workspace permissions", "description":"Gets a list of AI Data Platform Workbench workspace permissions.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/WorkspacePermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/WorkspacePermissionCollection", "responses":{ "200":{ "description":"A page of workspace permission summary objects is retrieved.", "schema":{ "$ref":"#/definitions/WorkspacePermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/managePermission":{ "post":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true, "audit":{ "mode":"automated" } }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformWorkspacePermission", "summary":"Update permissions on a workspace", "description":"Updates permissions on a AI Data Platform Workbench workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"ManageWorkspacePermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageWorkspacePermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/WorkspacePermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"The AI Data Platform Workbench workspace permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/actions/manageCreateWorkspacePermission":{ "post":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true, "audit":{ "mode":"automated" } }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformCreateWorkspacePermission", "summary":"Update create workspace permissions on a workspace", "description":"Updates create workspace permissions on an AI Data Platform Workbench workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"ManageCreateWorkspacePermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageCreateWorkspacePermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/CreateWorkspacePermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"The AI Data Platform Workbench workspace permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-actions-manageCreateWorkspacePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-actions-managecreateworkspacepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/createWorkspacePermissions":{ "get":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformCreateWorkspacePermissions", "summary":"Get a list of create workspace permissions", "description":"Gets a list of AI Data Platform Workbench create workspace permission summary objects.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/WorkspacePermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/CreateWorkspacePermissionCollection", "responses":{ "200":{ "description":"A page of workspace permission summary objects is retrieved.", "schema":{ "$ref":"#/definitions/CreateWorkspacePermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-createWorkspacePermissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-createworkspacepermissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/asyncOperations/{asyncOperationKey}/status":{ "put":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformWorkspaceAsyncOperationStatus", "summary":"Update workspace status", "description":"Updates the status of an AI Data Platform Workbench workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/AsyncOperationKeyPathParam" }, { "name":"UpdateWorkspaceAsyncOperationStatusDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateWorkspaceAsyncOperationStatusDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Workspace", "responses":{ "202":{ "description":"Accepted the request. The workspace status is updated.", "schema":{ "$ref":"#/definitions/Workspace" }, "headers":{ "opc-work-request-id":{ "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-asyncOperations-{asyncOperationKey}-status-put", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-asyncoperations-asyncoperationkey-status-put" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitFolders":{ "post":{ "tags":[ "Workspace" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformGitFolder", "description":"Creates a git folder in the workspace", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/UserPrincipalHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"CreateGitFolderDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateGitFolderDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/GitFolder", "responses":{ "202":{ "description":"Accepted the request.The git folder will be created", "schema":{ "$ref":"#/definitions/GitFolder" }, "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "summary":"Creates a git folder in the workspace", "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitFolders-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitfolders-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters":{ "get":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformClusters", "summary":"Get clusters in a workspace", "description":"Returns a list of all clusters in a given workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterStateQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/DisplayNameContainsQueryParam" }, { "$ref":"#/parameters/ClusterTypeQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ClusterSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ClusterCollection", "responses":{ "200":{ "description":"Successful operation. List of all clusters in workspace is retrieved.", "schema":{ "$ref":"#/definitions/ClusterCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-get" }, "post":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":10, "rpmLimit":20 } } }, "operationId":"CreateAiDataPlatformCluster", "summary":"Create a cluster", "description":"Creates a new cluster with the provided details.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateClusterDetails", "description":"Details for the new cluster.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateClusterDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Cluster", "responses":{ "202":{ "description":"Request accepted. Cluster is created.", "schema":{ "$ref":"#/definitions/Cluster" }, "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}":{ "get":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformCluster", "summary":"Get cluster details", "description":"Returns detailed information about a cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/Cluster" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-get" }, "put":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformCluster", "summary":"Update cluster details", "description":"Update the details of a given cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "name":"UpdateClusterDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateClusterDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Cluster", "responses":{ "202":{ "description":"Request accepted. Cluster is updated.", "schema":{ "$ref":"#/definitions/Cluster" }, "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-put" }, "delete":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformCluster", "summary":"Delete a cluster", "description":"Deletes a cluster from a workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Cluster", "responses":{ "202":{ "description":"Request accepted. Cluster is deleted.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/permissions":{ "get":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformClusterPermissions", "summary":"Get cluster permissions", "description":"Return a list of permissions for a given cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ClusterPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ClusterPermissionCollection", "responses":{ "200":{ "description":"Successful operation. List of permissions for a cluster is retrieved.", "schema":{ "$ref":"#/definitions/ClusterPermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/managePermission":{ "post":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "operationType":"OTHER_MUTATION", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformClusterPermission", "summary":"Update cluster permissions", "description":"Updates the permissions for a given cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "name":"ManageClusterPermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageClusterPermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ClusterPermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. Cluster permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/start":{ "post":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"StartAiDataPlatformCluster", "summary":"Start a termintated cluster", "description":"Starts a cluster that has halted operation.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "name":"StartClusterDetails", "description":"Details of the cluster being started.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/StartClusterDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Cluster", "x-obmcs-terraform":{ "actionType":"START" }, "responses":{ "202":{ "description":"Request accepted. Cluster is started.", "schema":{ "$ref":"#/definitions/Cluster" }, "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-actions-start-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-actions-start-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/stop":{ "post":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"StopAiDataPlatformCluster", "summary":"Stop a Cluster", "description":"Stops an active cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "name":"StopClusterDetails", "description":"Details for stopping the cluster.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/StopClusterDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Cluster", "x-obmcs-terraform":{ "actionType":"STOP" }, "responses":{ "202":{ "description":"Request accepted. Cluster is stopped.", "schema":{ "$ref":"#/definitions/Cluster" }, "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-actions-stop-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-actions-stop-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/restart":{ "post":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"RestartAiDataPlatformCluster", "summary":"Restart running cluster", "description":"Restarts a running cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "name":"RestartClusterDetails", "description":"Details for restarting the cluster.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/RestartClusterDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Cluster", "x-obmcs-terraform":{ "actionType":"START" }, "responses":{ "202":{ "description":"Request accepted. Cluster is restarted.", "schema":{ "$ref":"#/definitions/Cluster" }, "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-actions-restart-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-actions-restart-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/libraries":{ "get":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformClusterLibraries", "summary":"Get cluster libraries", "description":"Gets a list of libraries installed on a cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ClusterLibrarySortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ClusterLibraryCollection", "responses":{ "200":{ "description":"Successful operation. List of libraries installed on a cluster is retrieved.", "schema":{ "$ref":"#/definitions/ClusterLibraryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" }, "opc-prev-page":{ "description":"For list pagination. When this header appears in the response, previous pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" }, "opc-total-items":{ "description":"For list pagination. This header provides total number of items available. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-libraries-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-libraries-get" }, "patch":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "operationType":"OTHER_MUTATION", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true, "audit":{ "mode":"automated" } }, "maximumAttemptCount":3 }, "operationId":"PatchAiDataPlatformClusterLibrary", "summary":"Patch cluster libraries", "description":"Updates libraries of a cluster with the provided patches.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "name":"PatchClusterLibraryDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/PatchClusterLibraryDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ClusterLibraryDetails", "responses":{ "202":{ "description":"Request accepted. Cluster libraries are updated.", "schema":{ "$ref":"#/definitions/ClusterLibraryCollection" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-libraries-patch", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-libraries-patch" } }, "/aiDataPlatforms/{aiDataPlatformId}/defaultCluster":{ "get":{ "tags":[ "Cluster" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformDefaultCluster", "x-related-resource":"#/definitions/DefaultCluster", "summary":"Get default cluster", "description":"Gets information about the master catalog default cluster.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Successful operation. Master catalog default cluster information is retrieved.", "schema":{ "$ref":"#/definitions/DefaultCluster" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-defaultCluster-get", "x-filename-id":"aidataplatforms-aidataplatformid-defaultcluster-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformJobs", "summary":"Get list of jobs", "description":"Returns a list of jobs for a given AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/DisplayNameContainsQueryParam" }, { "$ref":"#/parameters/JobDefinitionPathQueryParam" }, { "$ref":"#/parameters/CreatedByQueryParam" }, { "$ref":"#/parameters/UpdatedByQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/JobCollection", "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/JobCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" }, "opc-prev-page":{ "description":"For list pagination. When this header appears in the response, previous pages of results remain.", "type":"string" }, "opc-total-items":{ "description":"For list pagination. This header provides total number of items available.", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-get" }, "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformJob", "summary":"Create a job", "description":"Creates a job in an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateJobDetails", "description":"Details for the new job.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateJobDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Job", "responses":{ "201":{ "description":"Request accepted. Job is created.", "schema":{ "$ref":"#/definitions/Job" }, "headers":{ "location":{ "description":"URL for the created job. The job key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformJob", "summary":"Get job details", "description":"Returns detailed information about a given job in AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. Detailed job information is retrieved.", "schema":{ "$ref":"#/definitions/Job" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-{jobKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-jobkey-get" }, "put":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformJob", "summary":"Updates a job", "description":"Update details for a job in AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobKeyPathParam" }, { "name":"UpdateJobDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateJobDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Job", "responses":{ "200":{ "description":"Successful operation. Job details are updated.", "schema":{ "$ref":"#/definitions/Job" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-{jobKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-jobkey-put" }, "delete":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformJob", "summary":"Delete a job", "description":"Deletes a job from an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Job", "responses":{ "204":{ "description":"Job is deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-{jobKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-jobkey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformJobRuns", "summary":"Get job runs", "description":"Returns a detailed list of job runs in an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/JobKeyQueryParam" }, { "$ref":"#/parameters/StateQueryParam" }, { "$ref":"#/parameters/TimeCreatedGreaterThanOrEqualToQueryParam" }, { "$ref":"#/parameters/TimeCreatedLessThanOrEqualToQueryParam" }, { "$ref":"#/parameters/JobRunPaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/JobRunCollection", "responses":{ "200":{ "description":"Successful operation. A list of job runs is retrieved.", "schema":{ "$ref":"#/definitions/JobRunCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobRuns-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobruns-get" }, "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "eventGroupIdExpression":"response.body.key", "resourceNameExpression":"response.body.name" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformJobRun", "summary":"Create a job run", "description":"Creates a job run for an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateJobRunDetails", "description":"Details for the new job run.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateJobRunDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/JobRun", "responses":{ "201":{ "description":"Request accepted. Job run is created.", "schema":{ "$ref":"#/definitions/JobRun" }, "headers":{ "location":{ "description":"URL for the created job run. The job run key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobRuns-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobruns-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/recentJobRuns":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformRecentJobRuns", "summary":"Get latest job runs", "description":"Returns a list of the latest job runs for a given job key.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobKeyQueryMandateParam" }, { "$ref":"#/parameters/RecordCountQueryParam" }, { "$ref":"#/parameters/JobRunPaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/JobRunCollection", "responses":{ "200":{ "description":"Successful operation. A list of the latest job runs is retrieved.", "schema":{ "$ref":"#/definitions/JobRunCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-recentJobRuns-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-recentjobruns-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns/{jobRunKey}":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformJobRun", "summary":"Get job run details", "description":"Returns detailed information about a given job run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobRunKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. Detailed job information is retrieved.", "schema":{ "$ref":"#/definitions/JobRun" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobRuns-{jobRunKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobruns-jobrunkey-get" }, "delete":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformJobRun", "summary":"Delete a job run", "description":"Deletes a job run from an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobRunKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/JobRun", "responses":{ "204":{ "description":"Job run is deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobRuns-{jobRunKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobruns-jobrunkey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}/actions/cancelJobRuns":{ "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "eventGroupIdExpression":"response.headers['opc-work-request-id']", "resourceNameExpression":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.resourceId).displayName", "asyncEndAudit":{ "mode":"automated", "workRequestIdExpression":"response.body.id", "currentStateExpression":"response.body.currentState" } }, "maximumAttemptCount":3 }, "operationId":"CancelAiDataPlatformJobRuns", "summary":"Cancel job runs", "description":"Cancels all job runs for a given job.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "x-related-resource":"#/definitions/JobRun", "x-obmcs-terraform":{ "actionType":"STOP" }, "responses":{ "201":{ "description":"Request accepted. Job runs are canceled.", "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-{jobKey}-actions-cancelJobRuns-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-jobkey-actions-canceljobruns-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns/{jobRunKey}/actions/cancel":{ "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "eventGroupIdExpression":"response.headers['opc-work-request-id']", "resourceNameExpression":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.resourceId).displayName", "asyncEndAudit":{ "mode":"automated", "workRequestIdExpression":"response.body.id", "currentStateExpression":"response.body.currentState" } }, "maximumAttemptCount":3 }, "operationId":"CancelAiDataPlatformJobRun", "summary":"Cancel a job run", "description":"Cancels a job run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobRunKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/JobRun", "x-obmcs-terraform":{ "actionType":"STOP" }, "responses":{ "201":{ "description":"Request accepted. Job run is canceled.", "schema":{ "$ref":"#/definitions/JobRun" }, "headers":{ "location":{ "description":"URL for the created job run. The job run key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobRuns-{jobRunKey}-actions-cancel-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobruns-jobrunkey-actions-cancel-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobRuns/{jobRunKey}/actions/repair":{ "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "eventGroupIdExpression":"response.headers['opc-work-request-id']", "resourceNameExpression":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.resourceId).displayName", "asyncEndAudit":{ "mode":"automated", "workRequestIdExpression":"response.body.id", "currentStateExpression":"response.body.currentState" } }, "maximumAttemptCount":3 }, "operationId":"RepairAiDataPlatformJobRun", "summary":"Repair job run", "description":"Repairs and reruns a job run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobRunKeyPathParam" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"RepairJobRunDetails", "description":"Details of the job run to be repaired.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/RepairJobRunDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-obmcs-terraform":{ "actionType":"SPECIAL_UPDATE" }, "x-related-resource":"#/definitions/JobRun", "responses":{ "201":{ "description":"Request accepted. Job run is repaired and rerun.", "schema":{ "$ref":"#/definitions/JobRun" }, "headers":{ "location":{ "description":"URL for the created/repaired job run. The job run key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobRuns-{jobRunKey}-actions-repair-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobruns-jobrunkey-actions-repair-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformTaskRuns", "summary":"Get task runs", "description":"Returns a list of tasks run in an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobRunKeyQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/StateQueryParam" }, { "$ref":"#/parameters/ParentJobRunKeyQueryParam" }, { "$ref":"#/parameters/RootJobRunKeyQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/TaskRunCollection", "responses":{ "200":{ "description":"Successful operation. A list of run tasks is retrieved.", "schema":{ "$ref":"#/definitions/TaskRunCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-taskRuns-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-taskruns-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns/{taskRunKey}":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformTaskRun", "summary":"Get task run details", "description":"Returns detailed information about a task run with a given task run key.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/TaskRunKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Successful operation. Details for task run with given task run key is retrieved.", "schema":{ "$ref":"#/definitions/TaskRun" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-taskRuns-{taskRunKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-taskruns-taskrunkey-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns/{taskRunKey}/outputs/{taskRunOutputKey}/actions/export":{ "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ExportAiDataPlatformTaskRunOutput", "summary":"Export task run output", "description":"Exports task run output in HTML or ipynb format.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/TaskRunKeyPathParam" }, { "$ref":"#/parameters/TaskRunOutputKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "name":"ExportTaskRunOutputDetails", "description":"Payload to export task run output to a file.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ExportTaskRunOutputDetails" } } ], "x-related-resource":"#/definitions/ExportedTaskRunOutputContents", "responses":{ "200":{ "description":"Successful operation. Task run output is exported.", "schema":{ "$ref":"#/definitions/ExportedTaskRunOutputContents" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-taskRuns-{taskRunKey}-outputs-{taskRunOutputKey}-actions-export-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-taskruns-taskrunkey-outputs-taskrunoutputkey-actions-export-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns/{taskRunKey}/actions/fetchOutput":{ "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"FetchAiDataPlatformOutput", "summary":"Fetch task run output from runtime engine", "description":"Fetches the task run output from the runtime engine.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/TaskRunKeyPathParam" }, { "name":"FetchOutputDetails", "description":"Details for task run output retrieval.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/FetchOutputDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "x-related-resource":"#/definitions/TaskRunOutput", "responses":{ "200":{ "description":"Request accepted. Task run output is returned.", "schema":{ "$ref":"#/definitions/TaskRunOutput" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-taskRuns-{taskRunKey}-actions-fetchOutput-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-taskruns-taskrunkey-actions-fetchoutput-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}/permissions":{ "get":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformJobPermissions", "summary":"Get job permissions", "description":"Returns a list of job permissions.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/JobPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/JobPermissionCollection", "responses":{ "200":{ "description":"Successful operation. List of job permissions is retrieved.", "schema":{ "$ref":"#/definitions/JobPermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-{jobKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-jobkey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs/{jobKey}/actions/managePermission":{ "post":{ "tags":[ "Workflow" ], "x-obmcs-splat":{ "operationType":"OTHER_MUTATION", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformJobPermission", "summary":"Update job permissions", "description":"Update job permissions with the provided details.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/JobKeyPathParam" }, { "name":"ManageJobPermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageJobPermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/JobPermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Job permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-jobs-{jobKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-jobs-jobkey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects":{ "get":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformWorkspaceObjects", "summary":"Get a list of objects in the workspace", "description":"Returns a list of objects in the workspace.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/PathQueryParam" }, { "$ref":"#/parameters/WorkspaceObjectTypeQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/FileMetadataKeysQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/WorkspaceObjectSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/WorkspaceObjectCollection", "responses":{ "200":{ "description":"Successful operation. A page of workspace object summaries is retrieved.", "schema":{ "$ref":"#/definitions/WorkspaceObjectCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-get" }, "post":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"CreateAiDataPlatformWorkspaceObject", "summary":"Create a workspace object", "description":"Creates a workspace object. You can create a file or folder in the workspace.\n", "x-obmcs-large-request-payload":true, "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateWorkspaceObjectDetails", "description":"Details for the new workspace object.", "required":true, "in":"body", "schema":{ "type":"string", "format":"binary" } }, { "$ref":"#/parameters/TypeHeader" }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/IsUploadFileDetailsBase64EncodedHeader" }, { "$ref":"#/parameters/IsOverwriteHeader" }, { "$ref":"#/parameters/ObjectDescriptionParam" } ], "x-related-resource":"#/definitions/WorkspaceObject", "produces":[ "application/x-yaml" ], "responses":{ "200":{ "description":"Successful operation. The workspace object is created.", "schema":{ "type":"string", "format":"binary" }, "headers":{ "location":{ "description":"URL for the created workspace object. The workspace object key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "object-key":{ "description":"Unique key of the object.\n", "type":"string" }, "path":{ "description":"The full path of the object.\n", "type":"string" }, "type":{ "description":"Type of the object\n", "type":"string" }, "time-updated":{ "description":"The date and time when Workspace Object was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectPath}":{ "get":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseResponseBody":"disabled", "maximumAttemptCount":1 }, "operationId":"GetAiDataPlatformWorkspaceObject", "summary":"Get workspace object details", "description":"Returns detailed information about a workspace object.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/IncludeMetadataQueryParam" }, { "$ref":"#/parameters/ObjectPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/WorkspaceObject", "produces":[ "application/x-yaml" ], "responses":{ "200":{ "description":"Successful operation. The workspace object details are retrieved.", "schema":{ "type":"string", "format":"binary" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "object-key":{ "description":"Unique key of the object.\n", "type":"string" }, "path":{ "description":"The full path of the object.\n", "type":"string" }, "type":{ "description":"Type of the object\n", "type":"string" }, "time-updated":{ "description":"The date and time when Workspace Object was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-{objectPath}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-objectpath-get" }, "head":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "operationType":"OTHER_MUTATION", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"HeadAiDataPlatformWorkspaceObject", "summary":"Get workspace object summary metadata", "description":"Returns metadata about a workspace object. The contents of the file are not retrieved.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ObjectPathParam" }, { "$ref":"#/parameters/IncludeMetadataQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/WorkspaceObjectSummary", "responses":{ "200":{ "description":"The workspace object metadata was retrieved.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "object-key":{ "description":"Unique key of the object.\n", "type":"string" }, "path":{ "description":"The full path of the object.\n", "type":"string" }, "type":{ "description":"Type of the object\n", "type":"string" }, "time-updated":{ "description":"The date and time when Workspace Object was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "file-metadata":{ "description":"File metadata of the file.\n", "type":"string" }, "composite-etag":{ "description":"The file composite (data + metadata) etag.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-{objectPath}-head", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-objectpath-head" }, "put":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"UpdateAiDataPlatformWorkspaceObject", "summary":"Update a workspace object", "description":"Updates a workspace object with the provided information.", "produces":[ "application/x-yaml" ], "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ObjectPathParam" }, { "$ref":"#/parameters/ObjectDescriptionParam" }, { "name":"UpdateWorkspaceObjectDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "type":"string", "format":"binary" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/WorkspaceObject", "x-obmcs-large-request-payload":true, "responses":{ "200":{ "description":"Successful operation. The workspace object is updated.", "schema":{ "type":"string", "format":"binary" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "object-key":{ "description":"Unique key of the object.\n", "type":"string" }, "path":{ "description":"The full path of the object.\n", "type":"string" }, "type":{ "description":"Type of the object\n", "type":"string" }, "time-updated":{ "description":"The date and time when Workspace Object was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-{objectPath}-put", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-objectpath-put" }, "delete":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformWorkspaceObject", "summary":"Delete a workspace object", "description":"Deletes a workspace object.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ObjectPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/WorkspaceObject", "responses":{ "202":{ "description":"Request accepted. The workspace object is deleted.", "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-{objectPath}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-objectpath-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectKey}/permissions":{ "get":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformWorkspaceObjectPermissions", "summary":"Get a list of workspace object permissions", "description":"Returns a list of workspace object permissions.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ObjectKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/WorkspaceObjectPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/WorkspaceObjectPermissionCollection", "responses":{ "200":{ "description":"Successful operation. A page of workspace object permission summary objects.", "schema":{ "$ref":"#/definitions/WorkspaceObjectPermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-{objectKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-objectkey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/objects/{objectKey}/actions/managePermission":{ "post":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformWorkspaceObjectPermission", "summary":"Update workspace object permissions", "description":"Updates permissions on a workspace object.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ObjectKeyPathParam" }, { "name":"ManageWorkspaceObjectPermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageWorkspaceObjectPermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/WorkspaceObjectPermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"The workspace object permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-objects-{objectKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-objects-objectkey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/moveObject":{ "post":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"MoveAiDataPlatformWorkspaceObject", "summary":"Move a workspace object", "description":"Moves a workspace object to different location.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"MoveWorkspaceObjectDetails", "description":"Details for moving the workspace object to a different path.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/MoveWorkspaceObjectDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/WorkspaceObject", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. The workspace object is moved to the new location.", "schema":{ "$ref":"#/definitions/WorkspaceObjectDetails" }, "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-actions-moveObject-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-actions-moveobject-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/renameObject":{ "post":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"RenameAiDataPlatformWorkspaceObject", "summary":"Rename a workspace object", "description":"Renames a workspace object.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"RenameWorkspaceObjectDetails", "description":"Details for renaming the workspace object.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/RenameWorkspaceObjectDetails" } }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/WorkspaceObject", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. The workspace object is renamed.", "schema":{ "$ref":"#/definitions/WorkspaceObjectDetails" }, "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-actions-renameObject-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-actions-renameobject-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/copyObject":{ "post":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CopyAiDataPlatformWorkspaceObject", "summary":"Copy a workspace object", "description":"Copy a workspace object to different location.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CopyWorkspaceObjectDetails", "description":"Details for copying the workspace object to a different path.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CopyWorkspaceObjectDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/WorkspaceObject", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. The workspace object is copied to the new location.", "schema":{ "$ref":"#/definitions/WorkspaceObjectDetails" }, "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-actions-copyObject-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-actions-copyobject-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/uploadFileMeta":{ "post":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"UploadAiDataPlatformWorkspaceObjectWithPar", "summary":"Upload a workspace file by generating PAR", "description":"Creates a workspace file by generating PAR or updates the metadata by close file. If file exists, then it will be updated.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/IsOverwriteQueryParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UploadFileWithParDetails", "description":"Contents of the file to upload.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UploadFileWithParDetails" } }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/TypeHeader" }, { "$ref":"#/parameters/ObjectDescriptionParam" } ], "x-related-resource":"#/definitions/WorkspaceObject", "responses":{ "200":{ "description":"Successful operation. The file is uploaded to workspace and generates a PAR.", "schema":{ "$ref":"#/definitions/UploadFileWithParResult" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "object-key":{ "description":"Unique key of the object\n", "type":"string" }, "path":{ "description":"The full path of the object\n", "type":"string" }, "type":{ "description":"Type of the object\n", "type":"string" }, "time-updated":{ "description":"The date and time when Workspace Object was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-actions-uploadFileMeta-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-actions-uploadfilemeta-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/actions/downloadFileMeta":{ "post":{ "tags":[ "WorkspaceObject" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]).compartmentId", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"DownloadAiDataPlatformWorkspaceObjectWithPar", "summary":"Download a workspace file by generating PAR", "description":"Downloads a workspace file by providing the PAR info for downloading the file for given path.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/TypeHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/WorkspaceObject", "responses":{ "200":{ "description":"Successful operation. A PAR for downloading the file is generated.", "schema":{ "$ref":"#/definitions/DownloadFileWithParResult" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "object-key":{ "description":"Unique key of the object\n", "type":"string" }, "path":{ "description":"The full path of the object\n", "type":"string" }, "type":{ "description":"Type of the object\n", "type":"string" }, "time-updated":{ "description":"The date and time when Workspace Object was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-actions-downloadFileMeta-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-actions-downloadfilemeta-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions":{ "get":{ "tags":[ "Notebook" ], "operationId":"ListAiDataPlatformSessions", "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "summary":"Get available sessions", "description":"Returns a list of all available sessions.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterIdentifierQueryParam" }, { "$ref":"#/parameters/NotebookPathIdentifierQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/AgentFlowIdentifierQueryParam" } ], "x-related-resource":"#/definitions/SessionCollection", "responses":{ "200":{ "description":"Successful operation. List of available sessions is retrieved.", "schema":{ "$ref":"#/definitions/SessionCollection" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-sessions-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-sessions-get" }, "post":{ "tags":[ "Notebook" ], "operationId":"CreateAiDataPlatformSession", "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.name" }, "maximumAttemptCount":3 }, "summary":"Create a new session", "description":"Creates a new session or returns an existing session if a session for the given path already exists.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateSessionDetails", "description":"Details to create a new session.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/CreateSessionDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/DataLakeTenantIdHeader" } ], "x-related-resource":"#/definitions/Session", "responses":{ "201":{ "description":"Session created or returned.", "schema":{ "$ref":"#/definitions/Session" }, "headers":{ "Location":{ "description":"URL for session commands.", "type":"string", "format":"url" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-sessions-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-sessions-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions/{sessionId}":{ "get":{ "summary":"Get session details", "description":"Returns session details for a given session ID.", "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "tags":[ "Notebook" ], "operationId":"GetAiDataPlatformSession", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/SessionIdentifierPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Session", "responses":{ "200":{ "description":"Successful operation. Session details are retrieved.", "schema":{ "$ref":"#/definitions/Session" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-sessions-{sessionId}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-sessions-sessionid-get" }, "patch":{ "tags":[ "Notebook" ], "operationId":"PatchAiDataPlatformSession", "summary":"Patch a session", "description":"Patches a session with a given ID with the provided details. You can use this to rename a session.", "x-obmcs-splat":{ "operationType":"OTHER_MUTATION", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/SessionIdentifierPathParam" }, { "name":"PatchSessionDetails", "description":"Details to patch for an existing session.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/PatchSessionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Session", "responses":{ "200":{ "description":"Successful operation. Session is patched.", "schema":{ "$ref":"#/definitions/Session" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-sessions-{sessionId}-patch", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-sessions-sessionid-patch" }, "delete":{ "tags":[ "Notebook" ], "operationId":"DeleteAiDataPlatformSession", "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "summary":"Delete a session", "description":"Delete a session with given session ID.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/SessionIdentifierPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/Session", "responses":{ "204":{ "description":"Session and kernel are deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-sessions-{sessionId}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-sessions-sessionid-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/contents/{contentPath}":{ "get":{ "tags":[ "Notebook" ], "operationId":"GetAiDataPlatformContent", "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "summary":"Get file or directory content", "description":"Returns a list of contents for a given file or directory. You can optionally specify a type and/or format argument via URL parameter.\nWhen given, the Content service returns a model in the requested type and/or format. If the request cannot be satisfied, for example if type=text\nis requested, but the file is binary, then the request returns a 400 message and a JSON response with a Reason field identifying the issue. The value\nof the Reason field is ???bad format??? or ???bad type???, depending on what was requested.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ContentPathPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/ContentTypeQueryParam" }, { "$ref":"#/parameters/ContentFormatQueryParam" }, { "$ref":"#/parameters/IncludeContentQueryParam" }, { "$ref":"#/parameters/ContentHashQueryParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Content", "responses":{ "200":{ "description":"Successful operation. File or directory contents are retrieved.", "schema":{ "$ref":"#/definitions/Content" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "Last-Modified":{ "description":"Last modified date for file.", "type":"string", "format":"date-time" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-contents-{contentPath}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-contents-contentpath-get" }, "post":{ "tags":[ "Notebook" ], "operationId":"CreateAiDataPlatformContent", "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.name" }, "maximumAttemptCount":3 }, "summary":"Create a new notebook file or directory", "description":"Creates a new, untitled, empty file or directory, or copies an existing notebook to a specified path. For example, a POST call to /api/contents/path with body containing copy_from set to /path/to/OtherNotebook.ipynb creates a new copy of OtherNotebook at the specified path.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ContentPathPathParam" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"CreateContentDetails", "description":"Notebook content to create a new notebook.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateContentDetails" } }, { "$ref":"#/parameters/DataLakeTenantIdHeader" } ], "x-related-resource":"#/definitions/Content", "responses":{ "201":{ "description":"Directory or file is successfully created.", "headers":{ "Location":{ "description":"URL for the new file.", "type":"string", "format":"url" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Content" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-contents-{contentPath}-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-contents-contentpath-post" }, "patch":{ "tags":[ "Notebook" ], "operationId":"ModifyAiDataPlatformContent", "x-obmcs-splat":{ "operationType":"OTHER_MUTATION", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "summary":"Rename a file or directory", "description":"Renames a file or directory without re-uploading content.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ContentPathPathParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"ModifyContentDetails", "description":"New path for file or directory.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ModifyContentDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Content", "responses":{ "200":{ "description":"Successful operation. Directory or file path is updated.", "headers":{ "Location":{ "description":"Updated URL for the file or directory.", "type":"string", "format":"url" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Content" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-contents-{contentPath}-patch", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-contents-contentpath-patch" }, "put":{ "tags":[ "Notebook" ], "operationId":"UpdateAiDataPlatformContent", "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true, "audit":{ "mode":"automated" } }, "maximumAttemptCount":3 }, "summary":"Update notebook contents", "description":"Updates the contents of an existing notebook with the provided details or saves a new notebook.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ContentPathPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UpdateContentDetails", "description":"Details to update the notebook content model file.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/UpdateContentDetails" } }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Content", "responses":{ "200":{ "description":"Successful operation. Notebook contents are updated.", "headers":{ "Location":{ "description":"URL for the new file.", "type":"string", "format":"url" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Content" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-contents-{contentPath}-put", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-contents-contentpath-put" }, "delete":{ "tags":[ "Notebook" ], "operationId":"DeleteAiDataPlatformContent", "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "summary":"Delete a notebook file or directory", "description":"Deletes a notebook file or directory.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ContentPathPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/Content", "responses":{ "204":{ "description":"Directory or file successfully deleted.", "headers":{ "Location":{ "description":"URL for the deleted file.", "type":"string", "format":"url" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-contents-{contentPath}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-contents-contentpath-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/actions/export/contents/{contentPath}":{ "post":{ "tags":[ "Notebook" ], "operationId":"ExportAiDataPlatformContents", "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "summary":"Export notebook file contents", "description":"Exports the notebook file contents. You can optionally specify HTML or ipynb format through the request payload. If no format is specified, ipynb is used by default.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ContentPathPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "name":"ExportContentsDetails", "description":"Payload to export contents of a file.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ExportContentsDetails" } } ], "x-related-resource":"#/definitions/ExportedContents", "responses":{ "200":{ "description":"Successful operation. File contents are exported in the specified format.", "schema":{ "$ref":"#/definitions/ExportedContents" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-notebook-api-actions-export-contents-{contentPath}-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-notebook-api-actions-export-contents-contentpath-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/searchLogs":{ "post":{ "tags":[ "Wrapper" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "x-obmcs-terraform":{ "actionType":"READ" }, "operationId":"SearchAiDataPlatformClusterLogs", "summary":"Search cluster logs", "description":"Searches logs within the specified cluster and time range. Supports pagination and filtering.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "name":"SearchClusterLogsDetails", "in":"body", "description":"Request body containing the search parameters for cluster logs.", "required":true, "schema":{ "$ref":"#/definitions/SearchClusterLogsDetails" } } ], "x-related-resource":"#/definitions/ClusterLogCollection", "responses":{ "200":{ "description":"Successful operation. A collection of logs for the specified parameters is retrieved.", "schema":{ "$ref":"#/definitions/ClusterLogCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-actions-searchLogs-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-actions-searchlogs-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/summarizeMetricsData":{ "post":{ "tags":[ "Wrapper" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "x-obmcs-terraform":{ "actionType":"READ" }, "operationId":"SummarizeAiDataPlatformMetricsData", "summary":"Summarize compute metrics data", "description":"Provides summarized compute metrics for a compute cluster in the given workspace.\nThis API aggregates metric data points based on a specified namespace, metric name, \nand aggregation type. The response contains computed metric summaries.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "name":"SummarizeMetricsDataDetails", "in":"body", "required":true, "description":"Request body containing metric parameters.", "schema":{ "$ref":"#/definitions/SummarizeMetricsDataDetails" } } ], "x-related-resource":"#/definitions/SummarizeMetricsResponse", "responses":{ "200":{ "description":"Successful operation. Summarized metrics data for the specified parameters is retrieved.", "schema":{ "$ref":"#/definitions/SummarizeMetricsResponse" }, "headers":{ "etag":{ "type":"string", "description":"The ETag for optimistic concurrency control." }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-actions-summarizeMetricsData-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-actions-summarizemetricsdata-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/clusters/{clusterKey}/actions/downloadLogs":{ "post":{ "tags":[ "Wrapper" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "x-obmcs-terraform":{ "actionType":"READ" }, "operationId":"DownloadAiDataPlatformClusterLogs", "summary":"Download cluster logs", "description":"Downloads logs within the specified cluster and time range.\nThe logs can be filtered by severity (`logLevel`), type (`logContentTypeContains`),\nand other parameters such as execution context and thread identifiers.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ClusterKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "name":"DownloadClusterLogsDetails", "in":"body", "description":"Request payload containing the parameters for filtering cluster logs.", "required":true, "schema":{ "$ref":"#/definitions/DownloadClusterLogsDetails" } } ], "x-related-resource":"#/definitions/ClusterLogCollection", "responses":{ "202":{ "description":"Request accepted. Log download is initiated.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "datalake-cluster-log-par-url":{ "description":"This string represents the PAR URL for the compute log file. The `datalake-cluster-log-par-url` should be used only after the\n`aidp-async-operation-key` status reaches the SUCCEEDED state. If accessed before the operation completes, the file may be incomplete.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-clusters-{clusterKey}-actions-downloadLogs-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-clusters-clusterkey-actions-downloadlogs-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/catalogs":{ "get":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformCatalogs", "summary":"Get a list of catalogs", "description":"Get a list of catalogs in an AI Data Platform Workbench with a given ID.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/CatalogStateQueryParam" }, { "$ref":"#/parameters/CatalogTypeQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/CatalogSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/CatalogCollection", "responses":{ "200":{ "description":"Successful operation. A list of catalogs is retrieved.", "schema":{ "$ref":"#/definitions/CatalogCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-get", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-get" }, "post":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformCatalog", "summary":"Create a catalog", "description":"Create a catalog in the AI Data Platform Workbench with the given ID.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateCatalogDetails", "description":"Details for the new AI Data Platform Workbench catalog.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateCatalogDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Catalog", "responses":{ "202":{ "description":"Request accepted. The AI Data Platform Workbench catalog is created.", "headers":{ "location":{ "description":"URL for the created catalog. The AI Data Platform Workbench catalog key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-post", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}":{ "get":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformCatalog", "summary":"Get catalog details", "description":"Gets detailed information about an AI Data Platform Workbench catalog with a given catalog key.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyPathParam" }, { "$ref":"#/parameters/IsCatalogGuidQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. Catalog details are retrieved.", "schema":{ "$ref":"#/definitions/Catalog" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-{catalogKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-catalogkey-get" }, "put":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformCatalog", "summary":"Update catalog details", "description":"Update the details of an AI Data Platform Workbench catalog with the given information.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyPathParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UpdateCatalogDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateCatalogDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Catalog", "responses":{ "202":{ "description":"Request accepted. The AI Data Platform Workbench catalog is updated.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-{catalogKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-catalogkey-put" }, "delete":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformCatalog", "summary":"Delete a catalog", "description":"Deletes the specified catalog from an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyPathParam" }, { "$ref":"#/parameters/isForcedHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Catalog", "responses":{ "202":{ "description":"Request accepted. The AI Data Platform Workbench catalog is deleted.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-{catalogKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-catalogkey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}/permissions":{ "get":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformCatalogPermissions", "summary":"Get list of catalog permissions", "description":"Gets a list of all permissions in the specified catalog of an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/CatalogPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/CatalogPermissionCollection", "responses":{ "200":{ "description":"A page of catalog permission summary objects is retrieved.", "schema":{ "$ref":"#/definitions/CatalogPermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-{catalogKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-catalogkey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}/actions/managePermission":{ "post":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformCatalogPermission", "summary":"Update permissions for a catalog", "description":"Update permission details for a catalog in an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyPathParam" }, { "name":"ManageCatalogPermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageCatalogPermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/CatalogPermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. Permissions in the AI Data Platform Workbench catalog are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-{catalogKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-catalogkey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}/actions/refresh":{ "post":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"RefreshAiDataPlatformCatalog", "summary":"Refresh catalog through crawler", "description":"Refresh a catalog in an AI Data Platform Workbench through a crawler.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "x-related-resource":"#/definitions/Catalog", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "202":{ "description":"Request accepted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-catalogs-{catalogKey}-actions-refresh-post", "x-filename-id":"aidataplatforms-aidataplatformid-catalogs-catalogkey-actions-refresh-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/actions/testConnection":{ "post":{ "tags":[ "Catalog" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CatalogAiDataPlatformTestConnection", "summary":"Test external catalog connection", "description":"Test the connection of an AI Data Platform Workbench to an external catalog.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CatalogTestConnectionDetails", "description":"Details for the AI Data Platform Workbench catalog to be tested for connection.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CatalogTestConnectionDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Catalog", "x-obmcs-terraform":{ "actionType":"SPECIAL_UPDATE" }, "responses":{ "202":{ "description":"Request accepted. AI Data Platform Workbench external connection is checked.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-actions-testConnection-post", "x-filename-id":"aidataplatforms-aidataplatformid-actions-testconnection-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes":{ "get":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformVolumes", "summary":"Get volumes", "description":"Returns a list of volumes.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyQueryParam" }, { "$ref":"#/parameters/SchemaKeyQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/VolumeSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumeCollection", "responses":{ "200":{ "description":"Successful operation. A page of volume summary objects is retrieved.", "schema":{ "$ref":"#/definitions/VolumeCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-get", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-get" }, "post":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformVolume", "summary":"Create a volume", "description":"Creates a volume in AI Data Platform Workbench.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateVolumeDetails", "description":"Details for the new volume.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateVolumeDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Volume", "responses":{ "201":{ "description":"Request accepted. Volume is created.", "schema":{ "$ref":"#/definitions/Volume" }, "headers":{ "location":{ "description":"URL for the created volume. The volume key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-post", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}":{ "get":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformVolume", "summary":"Get volume details", "description":"Returns detailed information about a volume.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. Volume details are retrieved.", "schema":{ "$ref":"#/definitions/Volume" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-get" }, "put":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformVolume", "summary":"Update a volume", "description":"Updates a volume with the provided information.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UpdateVolumeDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateVolumeDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Volume", "responses":{ "200":{ "description":"Successful operation. The volume is updated.", "schema":{ "$ref":"#/definitions/Volume" }, "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-put" }, "delete":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformVolume", "summary":"Delete a volume", "description":"Deletes a volume.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Volume", "responses":{ "204":{ "description":"Request accepted. Volume is deleted.", "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/permissions":{ "get":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformVolumePermissions", "summary":"Get volume permissions", "description":"Returns a list of volume permissions.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/VolumePermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumePermissionCollection", "responses":{ "200":{ "description":"Successful operation. A page of volume permission summary objects is retrieved.", "schema":{ "$ref":"#/definitions/VolumePermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/managePermission":{ "put":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformVolumePermission", "summary":"Update volume permissions", "description":"Updates the permissions on a volume.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "name":"ManageVolumePermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageVolumePermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumePermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. Volume permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-managePermission-put", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-managepermission-put" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/files":{ "get":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformFiles", "summary":"Get files in volume", "description":"Returns a list of files in a volume.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/IsListRecursiveQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PathQueryParam" }, { "$ref":"#/parameters/FileMetadataKeysQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/VolumeFileSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/VolumeFileCollection", "responses":{ "200":{ "description":"Successful operation. A page of volume file summary objects is retrieved.", "schema":{ "$ref":"#/definitions/VolumeFileCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-files-get", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-files-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/uploadFile":{ "post":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"UploadAiDataPlatformFile", "summary":"Upload a file to volume", "description":"Uploads a file to volume. If the file already exists, it is updated.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/IsOverwriteQueryParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/IsUploadFileDetailsBase64EncodedHeader" }, { "name":"UploadFileDetails", "description":"Contents of the file to upload.", "required":true, "in":"body", "schema":{ "type":"string", "format":"binary" } }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumeFile", "responses":{ "200":{ "description":"Successful operation. The file is uploaded to the volume.", "headers":{ "location":{ "description":"URL for the uploaded volume file.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-uploadFile-post", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-uploadfile-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/uploadFileMeta":{ "post":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"UploadAiDataPlatformFileWithPar", "summary":"Upload a file to volume by generating PAR", "description":"Uploads a volume file by generating PAR. If file exists, then it will be updated.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/IsOverwriteQueryParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UploadFileWithParDetails", "description":"Contents of the file to upload.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UploadFileWithParDetails" } }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumeFile", "responses":{ "200":{ "description":"Successful operation. The file is uploaded to volume and generates a PAR.", "schema":{ "$ref":"#/definitions/UploadFileWithParResult" }, "headers":{ "location":{ "description":"URL for the uploaded volume file.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-uploadFileMeta-post", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-uploadfilemeta-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/downloadFile":{ "post":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DownloadAiDataPlatformFile", "summary":"Download file from volume", "description":"Downloads a file from a volume.", "x-related-resource":"#/definitions/VolumeFile", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. The volume file is downloaded.", "schema":{ "type":"string", "format":"binary" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-downloadFile-post", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-downloadfile-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/downloadFileMeta":{ "post":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"DownloadAiDataPlatformFileWithPar", "summary":"Download a file to Volume by generating par", "description":"provide the par info for downloading the file for given path.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumeFile", "responses":{ "200":{ "description":"Successful operation. PAR to download the file is generated.", "schema":{ "$ref":"#/definitions/DownloadFileWithParResult" }, "headers":{ "location":{ "description":"URL for the uploaded volume file.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-downloadFileMeta-post", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-downloadfilemeta-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/deleteFile":{ "delete":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" } }, "operationId":"DeleteAiDataPlatformFile", "summary":"Delete a volume file", "description":"Deletes a file or folder in a volume.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumeFile", "responses":{ "204":{ "description":"Request accepted. The file is deleted.", "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-deleteFile-delete", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-deletefile-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/mkdir":{ "post":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "maximumAttemptCount":3 }, "operationId":"MakeAiDataPlatformDir", "summary":"Create directory in volume", "description":"Creates a directory in a volume.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/DescriptionQueryParam" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/VolumeFile", "responses":{ "201":{ "description":"Request accepted. The folder is created in the volume.", "headers":{ "location":{ "description":"URL for the created folder.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-mkdir-post", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-mkdir-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/deleteDir":{ "delete":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformDir", "summary":"Delete volume directory", "description":"Deletes a directory in a volume.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/VolumeFile", "responses":{ "204":{ "description":"Request accepted. The directory is deleted.", "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-deleteDir-delete", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-deletedir-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/volumes/{volumeKey}/actions/updateDir":{ "put":{ "tags":[ "Volume" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.header.displayName" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformDir", "summary":"Update volume directory", "description":"Updates a directory in volume with the provided information.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/VolumeKeyPathParam" }, { "name":"UpdateDirDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateDirDetails" } }, { "$ref":"#/parameters/PathHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/VolumeFile", "responses":{ "200":{ "description":"Successful operation. The volume directory is updated.", "headers":{ "location":{ "description":"URL for the deleted folder.", "type":"string", "format":"uri-reference" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-volumes-{volumeKey}-actions-updateDir-put", "x-filename-id":"aidataplatforms-aidataplatformid-volumes-volumekey-actions-updatedir-put" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformSchemas", "summary":"Get schemas", "description":"Returns a list of schemas in a given AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SchemaSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/SchemaCollection", "responses":{ "200":{ "description":"Successful operation. List of schemas is retrieved.", "schema":{ "$ref":"#/definitions/SchemaCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-get", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-get" }, "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformSchema", "summary":"Create a schema", "description":"Creates a schema.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateSchemaDetails", "description":"Details for the new schema.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateSchemaDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Schema", "responses":{ "202":{ "description":"Request accepted. Schema is created.", "headers":{ "location":{ "description":"URL for the created schema. The schema key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-post", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformSchema", "summary":"Get schema details", "description":"Returns detailed information about a specified schema.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. Schema details are retrieved.", "schema":{ "$ref":"#/definitions/Schema" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-get" }, "put":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformSchema", "summary":"Update schema", "description":"Updates a schema.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UpdateSchemaDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateSchemaDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Schema", "responses":{ "202":{ "description":"Requested accepted. Schema is updated.", "schema":{ "$ref":"#/definitions/Schema" }, "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-put" }, "delete":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformSchema", "summary":"Delete schema", "description":"Deletes a schema from an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "$ref":"#/parameters/isForcedHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Schema", "responses":{ "202":{ "description":"Request accepted. Schema is deleted.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/permissions":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformSchemaPermissions", "summary":"Get schema permissions", "description":"Returns a list of permissions for a given schema.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SchemaPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/SchemaPermissionCollection", "responses":{ "200":{ "description":"Successful operation. List of schema permissions is retrieved.", "schema":{ "$ref":"#/definitions/SchemaPermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/managePermission":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformSchemaPermission", "summary":"Update schema permissions", "description":"Updates the permissions for a given schema.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "name":"ManageSchemaPermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageSchemaPermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/SchemaPermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. Schema permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/generateTempFileUploadTarget":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GenerateAiDataPlatformTempFileUploadTarget", "summary":"Generate URI for uploading a sample file to a temporary folder in a schema", "description":"Generates a URI for uploading a sample file to a temporary folder in a schema.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Schema", "responses":{ "200":{ "description":"Successful operation. URI is generated.", "schema":{ "$ref":"#/definitions/GenerateTempFileUploadTargetResponseDetails" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-actions-generateTempFileUploadTarget-post", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-actions-generatetempfileuploadtarget-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/inferSchema":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"PerformAiDataPlatformInferSchema", "summary":"Get table schema details", "description":"Returns details of a table schema from the specified location.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "name":"PerformInferSchemaDetails", "description":"Details of the location from which the table schema can be inferred.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/PerformInferSchemaDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/PerformInferSchemaDetails", "responses":{ "200":{ "description":"Successful operation. Table schema details are retrieved.", "schema":{ "$ref":"#/definitions/InferSchema" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-actions-inferSchema-post", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-actions-inferschema-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/inferSchemaWithPreview":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"PerformAiDataPlatformInferSchemaWithPreview", "summary":"Get table schema and data", "description":"Returns table schema and data from the specified location.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "name":"PerformInferSchemaDetails", "description":"Details of the location from which the table schema and data can be inferred.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/PerformInferSchemaDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/PerformInferSchemaDetails", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. Table schema and data are retrieved.", "schema":{ "$ref":"#/definitions/InferSchemaWithPreview" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-actions-inferSchemaWithPreview-post", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-actions-inferschemawithpreview-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}/actions/refresh":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"RefreshAiDataPlatformSchema", "summary":"Refresh schema", "description":"Refreshes schema in an AI Data Platform Workbench through the crawler.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SchemaKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "x-related-resource":"#/definitions/Schema", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "202":{ "description":"Request accepted. Schema are refreshed.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-schemas-{schemaKey}-actions-refresh-post", "x-filename-id":"aidataplatforms-aidataplatformid-schemas-schemakey-actions-refresh-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/dataTables":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformDataTable", "summary":"Create a managed table from sample file", "description":"Creates a managed table with data loaded from a sample file.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateDataTableDetails", "description":"Details for the new managed table with data.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateDataTableDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Table", "responses":{ "202":{ "description":"Request accepted. Managed table is created.", "headers":{ "opc-work-request-id":{ "description":"The OCID of the asynchronous work request.\nUse GetWorkRequest with this ID to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-dataTables-post", "x-filename-id":"aidataplatforms-aidataplatformid-datatables-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/tables":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformTables", "summary":"Get tables in schema", "description":"Returns a list of tables in a schema.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyQueryParam" }, { "$ref":"#/parameters/SchemaKeyQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/TableSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/TableCollection", "responses":{ "200":{ "description":"Successful operation. List of tables in a schema is retrieved.", "schema":{ "$ref":"#/definitions/TableCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-get", "x-filename-id":"aidataplatforms-aidataplatformid-tables-get" }, "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformTable", "summary":"Create a table", "description":"Creates a table.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateTableDetails", "description":"Details for the new table.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateTableDetails" } }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Table", "responses":{ "202":{ "description":"Request accepted. Table is created.", "headers":{ "location":{ "description":"URL for the created Table. The table key is generated after this request is sent.", "type":"string", "format":"uri-reference" }, "content-location":{ "description":"Same as location.", "type":"string", "format":"uri-reference" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-post", "x-filename-id":"aidataplatforms-aidataplatformid-tables-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformTable", "summary":"Get table details", "description":"Returns detailed information about a table.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/TableKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. Table details are retrieved.", "schema":{ "$ref":"#/definitions/Table" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-{tableKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-tables-tablekey-get" }, "put":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformTable", "summary":"Update a table", "description":"Updates a table with provided details.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/TableKeyPathParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UpdateTableDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateTableDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Table", "responses":{ "202":{ "description":"Request accepted. Table is updated.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-{tableKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-tables-tablekey-put" }, "delete":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformTable", "summary":"Delete a table", "description":"Deletes a table from an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/TableKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Table", "responses":{ "202":{ "description":"Request accepted. Table is deleted.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-{tableKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-tables-tablekey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/permissions":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformTablePermissions", "summary":"Get table permissions", "description":"Returns a list of permissions for a given table.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/TableKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SchemaPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/TablePermissionCollection", "responses":{ "200":{ "description":"Successful operation. List of table permissions is retrieved.", "schema":{ "$ref":"#/definitions/TablePermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-{tableKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-tables-tablekey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/actions/managePermission":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformTablePermission", "summary":"Update table permissions", "description":"Updates the permissions for a given table.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/TableKeyPathParam" }, { "name":"ManageTablePermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageTablePermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/TablePermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. Table permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-{tableKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-tables-tablekey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/actions/refresh":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "apiType":"Asynchronous", "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"RefreshAiDataPlatformTable", "summary":"Refresh table", "description":"Refreshes a table in an AI Data Platform Workbench through the crawler.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/TableKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "x-related-resource":"#/definitions/Table", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "202":{ "description":"Request accepted. Table is refreshed.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-{tableKey}-actions-refresh-post", "x-filename-id":"aidataplatforms-aidataplatformid-tables-tablekey-actions-refresh-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}/actions/getPar":{ "post":{ "tags":[ "Schema" ], "x-obmcs-terraform":{ "actionType":"READ" }, "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"RetrieveAiDataPlatformPar", "summary":"Retrieve PAR for created entities", "description":"Retrieve PAR for the entities created in AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/TableKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Table", "responses":{ "200":{ "description":"Successful operation. PAR for created entities is retrieved.", "schema":{ "$ref":"#/definitions/ParDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-tables-{tableKey}-actions-getPar-post", "x-filename-id":"aidataplatforms-aidataplatformid-tables-tablekey-actions-getpar-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/views":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformViews", "summary":"Get schema views", "description":"Returns a list of views in a schema.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CatalogKeyQueryParam" }, { "$ref":"#/parameters/SchemaKeyQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ViewSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ViewCollection", "responses":{ "200":{ "description":"Successful operation. A page of view summary objects is retrieved.", "schema":{ "$ref":"#/definitions/ViewCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-views-get", "x-filename-id":"aidataplatforms-aidataplatformid-views-get" }, "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformView", "summary":"Create a view", "description":"Creates a view.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateViewDetails", "description":"Details for the new view.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateViewDetails" } }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/View", "responses":{ "200":{ "description":"Successful operation. View is created.", "schema":{ "$ref":"#/definitions/View" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-views-post", "x-filename-id":"aidataplatforms-aidataplatformid-views-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformView", "summary":"Get view details", "description":"Returns information about a view.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ViewKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"Successful operation. View details are retrieved.", "schema":{ "$ref":"#/definitions/View" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-views-{viewKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-views-viewkey-get" }, "put":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformView", "summary":"Update a view", "description":"Updates a view with given information.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ViewKeyPathParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "name":"UpdateViewDetails", "description":"The update mode and information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateViewDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/View", "responses":{ "200":{ "description":"Successful operation. View is updated with the given information.", "schema":{ "$ref":"#/definitions/View" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-views-{viewKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-views-viewkey-put" }, "delete":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformView", "summary":"Delete a view", "description":"Deletes a view from AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ViewKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/View", "responses":{ "204":{ "description":"Request accepted. View is deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-views-{viewKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-views-viewkey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}/permissions":{ "get":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformViewPermissions", "summary":"Get view permissions", "description":"Returns a list of view permissions.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ViewKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ViewPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/ViewPermissionCollection", "responses":{ "200":{ "description":"Successful operation. A page of view permission summary objects is retrieved.", "schema":{ "$ref":"#/definitions/ViewPermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-views-{viewKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-views-viewkey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}/actions/managePermission":{ "post":{ "tags":[ "Schema" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformViewPermission", "summary":"Update view permissions", "description":"Updates permissions on a view.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ViewKeyPathParam" }, { "name":"ManageViewPermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageViewPermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/ViewPermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. View permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-views-{viewKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-views-viewkey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/roles":{ "get":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformRoles", "summary":"Get list of roles", "description":"Returns a list of roles.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RoleLifecycleStateQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/RoleSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/RoleCollection", "responses":{ "200":{ "description":"Successful opeartion. A page of role summary objects is retrieved.", "schema":{ "$ref":"#/definitions/RoleCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-get", "x-filename-id":"aidataplatforms-aidataplatformid-roles-get" }, "post":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformRole", "summary":"Create a role", "description":"Creates a role.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateRoleDetails", "description":"Details for the new role.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateRoleDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Role", "responses":{ "200":{ "description":"Successful operation. The role is created.", "schema":{ "$ref":"#/definitions/Role" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-post", "x-filename-id":"aidataplatforms-aidataplatformid-roles-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}":{ "get":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformRole", "summary":"Get role details", "description":"Returns detailed information about a role.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RoleKeyPathParam" }, { "$ref":"#/parameters/GetRoleScopeTypeQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Successful operation. Detailed role information is retrieved.", "schema":{ "$ref":"#/definitions/Role" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-{roleKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-roles-rolekey-get" }, "put":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformRole", "summary":"Update a role", "description":"Updates a role with the provided information.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RoleKeyPathParam" }, { "name":"UpdateRoleDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateRoleDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Role", "responses":{ "200":{ "description":"Successful operation. The role is updated.", "schema":{ "$ref":"#/definitions/Role" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-{roleKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-roles-rolekey-put" }, "delete":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "eventGroupIdExpression":"response.headers['opc-work-request-id']", "resourceNameExpression":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.resourceId).displayName" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformRole", "summary":"Delete a role", "description":"Deletes a role.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RoleKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Role", "responses":{ "204":{ "description":"Request accepted. The role is deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-{roleKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-roles-rolekey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}/permissions":{ "get":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformRolePermissions", "summary":"Get list of role permissions", "description":"Returns a list of permissions for a given role.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RoleKeyPathParam" }, { "$ref":"#/parameters/ListRolePermissionScopeQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/RoleSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/RoleCollection", "responses":{ "200":{ "description":"Successful operation. A list of all permissions for a given role is retrieved.", "schema":{ "$ref":"#/definitions/RolePermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-{roleKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-roles-rolekey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}/actions/addMember":{ "post":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"AddAiDataPlatformMemberToRole", "summary":"Add member to role", "description":"Assigns a given user/group/principal to a role.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RoleKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "name":"AddMemberToRoleDetails", "description":"The details of the assignee(s) to which a role is assigned.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/AddMemberToRoleDetails" } } ], "x-related-resource":"#/definitions/Role", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful operation. Role is assigned to given user/principal.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-{roleKey}-actions-addMember-post", "x-filename-id":"aidataplatforms-aidataplatformid-roles-rolekey-actions-addmember-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/roles/{roleKey}/actions/removeMember":{ "post":{ "tags":[ "Role" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"RemoveAiDataPlatformMemberFromRole", "summary":"Remove member from role", "description":"Revoke a role from a given user or group.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RoleKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "name":"RemoveMemberFromRoleDetails", "description":"The details of the user or group from which the role is to be revoked.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/RemoveMemberFromRoleDetails" } } ], "x-related-resource":"#/definitions/Role", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Successful opeartion. Role is revoked from given user/principal when scope is USER.\nIf ADMIN, assignee stops being an Admin for the role.\n", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-roles-{roleKey}-actions-removeMember-post", "x-filename-id":"aidataplatforms-aidataplatformid-roles-rolekey-actions-removemember-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares":{ "post":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformShare", "summary":"Create a Delta Share", "description":"Create a Delta Share protocol in AI Data Platform Workbench.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateShareDetails", "description":"Details for the new share for Delta Share protocol in AI Data Platform Workbench.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateShareDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Recipient", "responses":{ "200":{ "description":"Delta Share is created.", "schema":{ "$ref":"#/definitions/Share" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-post", "x-filename-id":"aidataplatforms-aidataplatformid-shares-post" }, "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformShares", "summary":"Get a list of Delta Shares", "description":"Gets a list of Delta Shares in an AI Data Platform Workbench instance.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ShareSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ShareCollection", "responses":{ "200":{ "description":"A page of Share Summary objects is retrieved.", "schema":{ "$ref":"#/definitions/ShareCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-get", "x-filename-id":"aidataplatforms-aidataplatformid-shares-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}":{ "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformShare", "summary":"Get Delta Share details", "description":"Gets detailed information about a Delta Share.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Share", "responses":{ "200":{ "description":"Detailed information about Delta Share is retrieved.", "schema":{ "$ref":"#/definitions/Share" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-get" }, "put":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformShare", "summary":"Update a Delta Share", "description":"Update a Delta Share with the provided metadata.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "name":"UpdateShareDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateShareDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Share", "responses":{ "200":{ "description":"The Delta Share metadata is updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-put" }, "delete":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "eventGroupIdExpression":"response.headers['opc-work-request-id']", "resourceNameExpression":"downstream.invoke('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.resourceId).displayName" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformShare", "summary":"Delete a Delta Share", "description":"Deletes a Delta Share from an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Share", "responses":{ "204":{ "description":"The share identified by the shareKey is deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/permissions":{ "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformSharePermissions", "summary":"Get a list of Delta Share access for a recipient", "description":"Returns a list of Delta Shares that the specified recipient has been granted access to.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SharePermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/SchemaPermissionCollection", "responses":{ "200":{ "description":"A list of Delta Shares that the specified recipient has been granted access to is retrieved.", "schema":{ "$ref":"#/definitions/SharePermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/recipients":{ "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformShareRecipients", "summary":"Get a list of recipients specific to a Delta Share", "description":"Gets a list of recipients that have been given access on the specified Delta Share.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/RecipientSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/RecipientCollection", "responses":{ "200":{ "description":"A list of recipients that have been given access on the specified Delta Share is retrieved.", "schema":{ "$ref":"#/definitions/RecipientCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-recipients-get", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-recipients-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/dataAssets":{ "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformShareDataAssets", "summary":"Gets a list of Delta Share assets", "description":"Gets a list of Delta Shares assets in an AI Data Platform Workbench instance.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ShareSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/ShareDataAssetCollection", "responses":{ "200":{ "description":"A page of Share Summary data assets objects is retrieved.", "schema":{ "$ref":"#/definitions/ShareDataAssetCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-dataAssets-get", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-dataassets-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/actions/managePermission":{ "post":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformSharePermission", "summary":"Update Delta Share permissions", "description":"Updates permissions on a Delta Share.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "name":"ManageSharePermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageSharePermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/SharePermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"The Delta Share permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/actions/manageDataAsset":{ "post":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformShareDataAsset", "summary":"Updates Delta Share data assets", "description":"Updates data assets on a Delta Share with the provided information.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "name":"ManageShareDataAssetDetails", "description":"The Delta Share data asset information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageShareDataAssetDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Share", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"The Delta Share data assets are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-actions-manageDataAsset-post", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-actions-managedataasset-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/shares/{shareKey}/actions/manageAccess":{ "post":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformShareAccess", "summary":"Update consumer-side access on a share for a recipient", "description":"Updates consumer-side access on a share for a recipient. A provider user can grant or revoke access on a particular share for a given recipient.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ShareKeyPathParam" }, { "name":"ManageShareAccessDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageShareAccessDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Share", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"Consumer-side access on a share for is updated for the recipient.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-shares-{shareKey}-actions-manageAccess-post", "x-filename-id":"aidataplatforms-aidataplatformid-shares-sharekey-actions-manageaccess-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/recipients":{ "post":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformRecipient", "summary":"Create a Delta Share recipient", "description":"Creates a recipient for a Delta Share protocol in AI Data Platform Workbench.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateRecipientDetails", "description":"Details for the new recipient for Delta Share protocol in AI Data Platform Workbench.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateRecipientDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Recipient", "responses":{ "200":{ "description":"A Delta Share recipient is created.", "schema":{ "$ref":"#/definitions/Recipient" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-post", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-post" }, "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformRecipients", "summary":"Get a list of Delta Share recipients", "description":"Gets a list of Delta Share recipients in a AI Data Platform Workbench instance.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/RecipientSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/RecipientCollection", "responses":{ "200":{ "description":"A page of Recipient Summary objects is retrieved.", "schema":{ "$ref":"#/definitions/RecipientCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-get", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}":{ "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformRecipient", "summary":"Get Delta Share recipient details", "description":"Gets detailed information about a Delta Share recipient in an AI Data Platform Workbench instance.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RecipientKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "responses":{ "200":{ "description":"The recipient information is retrieved.", "schema":{ "$ref":"#/definitions/Recipient" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-{recipientKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-recipientkey-get" }, "put":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformRecipient", "summary":"Update a Delta Share recipient", "description":"Updates the metadata of a Delta Share recipient in a AI Data Platform Workbench instance.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RecipientKeyPathParam" }, { "name":"UpdateRecipientDetails", "description":"The information to be updated for a recipient.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateRecipientDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Recipient", "responses":{ "200":{ "description":"The recipient metadata is updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-{recipientKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-recipientkey-put" }, "delete":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"delete", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformRecipient", "summary":"Delete a recipient", "description":"Deletes a Delta Share recipient from an AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RecipientKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Recipient", "responses":{ "204":{ "description":"Recipient resource is deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-{recipientKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-recipientkey-delete" } }, "/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}/permissions":{ "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformRecipientPermissions", "summary":"Get list of Delta Share recipient permissions", "description":"Gets a detailed list of Delta Share recipient permissions.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RecipientKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/RecipientPermissionSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/RecipientPermissionCollection", "responses":{ "200":{ "description":"A page of Recipient Permission Summary objects is retrieved.", "schema":{ "$ref":"#/definitions/RecipientPermissionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-{recipientKey}-permissions-get", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-recipientkey-permissions-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}/actions/managePermission":{ "post":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformRecipientPermission", "summary":"Update recipient permissions", "description":"Updates the permissions of a Delta Share recipient in AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RecipientKeyPathParam" }, { "name":"ManageRecipientPermissionDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageRecipientPermissionDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/RecipientPermissionSummary", "x-obmcs-terraform":{ "actionType":"UPDATE_FIELD" }, "responses":{ "200":{ "description":"The Delta Share recipient permissions are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-{recipientKey}-actions-managePermission-post", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-recipientkey-actions-managepermission-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/recipients/{recipientKey}/shares":{ "get":{ "tags":[ "DeltaShare" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformRecipientShares", "summary":"Get a list of Delta Share access for a recipient", "description":"Returns a list of Delta Shares that the specified recipient has been granted access to.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RecipientKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ShareSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/ShareCollection", "responses":{ "200":{ "description":"A list of Delta Shares that the specified recipient has been granted access to is retrieved.", "schema":{ "$ref":"#/definitions/ShareCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-recipients-{recipientKey}-shares-get", "x-filename-id":"aidataplatforms-aidataplatformid-recipients-recipientkey-shares-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/actions/searchAuditLogs":{ "post":{ "tags":[ "Audit" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"SearchAiDataPlatformAuditLogs", "summary":"Search audit logs", "description":"Searches audit logs for AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"SearchAuditLogsDetails", "description":"Details for the audit log search.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/SearchAuditLogsDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" } ], "x-related-resource":"#/definitions/AuditLogSearchResultSummary", "responses":{ "200":{ "description":"Successful operation. Audit log search is retrieved.", "schema":{ "$ref":"#/definitions/AuditLogSearchResultCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-actions-searchAuditLogs-post", "x-filename-id":"aidataplatforms-aidataplatformid-actions-searchauditlogs-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/actions/manageAuditLogs":{ "post":{ "tags":[ "Audit" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"ManageAiDataPlatformAuditLogs", "summary":"Manage audit logs", "description":"Manages audit logs for AI Data Platform Workbench.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"ManageAuditLogsDetails", "description":"Details to update in an audit log.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ManageAuditLogsDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AuditLogSearchResultSummary", "responses":{ "200":{ "description":"Successful operation. Audit logs are updated with provided details.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-actions-manageAuditLogs-post", "x-filename-id":"aidataplatforms-aidataplatformid-actions-manageauditlogs-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}":{ "get":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformGitRepository", "summary":"(Preview) Get connected Git repository", "description":"(Preview) Returns repository metadata, credential references, and workspace linkage for a specific AI Data Platform Git repository.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "$ref":"#/parameters/IncludeCredKeyQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/GitRepository", "responses":{ "200":{ "description":"Successful operation. A Git repository object is retrieved.", "schema":{ "$ref":"#/definitions/GitRepository" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-get" }, "put":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformGitRepository", "summary":"(Preview) Update Git repository metadata", "description":"(Preview) Updates stored repository details???such as credentials or default branches???so automation stays aligned with your source control.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"UpdateGitRepositoryDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateGitRepositoryDetails" } }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/GitRepository", "responses":{ "202":{ "description":"Request accepted. The Git repository is updated.", "headers":{ "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-put" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/gitBranches":{ "get":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformGitBranches", "summary":"(Preview) Get a list of Git branches", "description":"(Preview) Returns branch summaries with optional display-name filters and pagination, so UIs can show branch pickers and search results.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/DisplayNameContainsQueryParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/GitBranchCollection", "responses":{ "200":{ "description":"Successful operation. A page of Git branch summary objects is retrieved.", "schema":{ "$ref":"#/definitions/GitBranchCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" }, "opc-total-items":{ "description":"For list pagination. This header provides total number of items available.", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-gitBranches-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-gitbranches-get" }, "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"CreateAiDataPlatformGitBranch", "summary":"(Preview) Create a Git branch", "description":"(Preview) Creates a new branch in the connected repo so teams can stage changes in isolated workspaces.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"CreateGitBranchDetails", "description":"Details for the new Workspace Object.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateGitBranchDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/CreateGitBranch", "responses":{ "202":{ "description":"Requested accepted. The Git folder is created.", "schema":{ "$ref":"#/definitions/CreateGitBranch" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-gitBranches-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-gitbranches-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/checkOutBranch":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"CheckoutAiDataPlatformBranch", "summary":"(Preview) Check out a Git branch", "description":"(Preview) Checks out a remote branch into the specified workspace folder, ensuring the worktree tracks the requested branch HEAD.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"CheckoutBranchDetails", "description":"Details for the new branch.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CheckoutBranchDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/GitBranch", "responses":{ "202":{ "description":"Request accepted. The Git branch is checked out.", "schema":{ "$ref":"#/definitions/GitBranch" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-checkOutBranch-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-checkoutbranch-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/commitPush":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"CommitPushAiDataPlatformGitRepository", "summary":"(Preview) Commit and push Git changes", "description":"(Preview) Stages selected workspace updates, creates a commit, and pushes it upstream so automation can sync with Git providers.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"CommitPushDetails", "description":"Commit details.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CommitPushDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/CommitPushDetails", "responses":{ "202":{ "description":"The commit/push request is accepted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-commitPush-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-commitpush-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/resolveConflicts":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ResolveAiDataPlatformGitConflicts", "summary":"(Preview) Resolve Git conflicts", "description":"(Preview) Accepts conflict resolution instructions???choose source or target versions???and records the resolution back to the repo.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"ConflictResolveDetails", "description":"Conflict resolution details.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ConflictResolveDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/ConflictResolveDetails", "responses":{ "200":{ "description":"The conflict resolution request is accepted.", "schema":{ "$ref":"#/definitions/GitBranch" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-resolveConflicts-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-resolveconflicts-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/resetState":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ResetAiDataPlatformGitFolderState", "summary":"(Preview) Reset workspace Git state", "description":"(Preview) Halts in-progress Git operations and discards local changes in the workspace folder to regain a clean state.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"ResetGitFolderStateDetails", "description":"Merge conflict resolution details.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ResetGitFolderStateDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/ResetGitFolderStateDetails", "responses":{ "202":{ "description":"The reset of Git folder state request is accepted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-resetState-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-resetstate-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/pull":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"PullAiDataPlatformGitRepository", "summary":"(Preview) Pull Git changes", "description":"(Preview) Performs a Git pull for the workspace branch so developers can sync local files with the latest upstream commits.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"GitPullDetails", "description":"Folder/branch details to pull.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/GitPullDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/GitPullDetails", "responses":{ "202":{ "description":"The pull request is accepted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-pull-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-pull-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/merge":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"MergeAiDataPlatformGitRepository", "summary":"(Preview) Merge Git branch", "description":"(Preview) Applies the requested branch or commit onto the workspace branch to preview integration changes before pushing.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"GitMergeDetails", "description":"Folder/branch details to merge.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/GitMergeDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/GitMergeDetails", "responses":{ "202":{ "description":"The merge request is accepted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-merge-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-merge-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/rebase":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"RebaseAiDataPlatformGitRepository", "summary":"(Preview) Rebase Git branch", "description":"(Preview) Rebases the workspace branch on top of another commit or branch to linearize history and resolve drift.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"GitRebaseDetails", "description":"Details needed to perform rebase operation.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/GitRebaseDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/GitRebaseDetails", "responses":{ "202":{ "description":"The merge request is accepted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-rebase-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-rebase-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/reset":{ "post":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "parseRequestBody":"disabled", "maximumAttemptCount":1 }, "operationId":"ResetAiDataPlatformGitRepository", "summary":"(Preview) Reset Git branch", "description":"(Preview) Performs a Git reset so the workspace branch matches the specified commit, discarding newer local commits.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"GitResetDetails", "description":"Details needed to perform Git reset operation.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/GitResetDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/GitResetDetails", "responses":{ "202":{ "description":"The merge request is accepted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-reset-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-reset-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/gitOperationState":{ "get":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformGitOperationState", "summary":"(Preview) Get Git operation state", "description":"(Preview) Returns the current Git worktree status???including in-progress operations or detached HEAD indicators???for the workspace folder.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "name":"operationName", "in":"query", "required":false, "default":null, "type":"string", "description":"Optional operation the caller intends to perform (for example PULL, PUSH, RESET, CHECKOUT)." }, { "name":"branchName", "in":"query", "required":false, "default":null, "type":"string", "description":"Expected branch name for the folder context." }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/GitOperationState", "responses":{ "200":{ "description":"Current operation state of the Git repository folder context.", "schema":{ "$ref":"#/definitions/GitOperationState" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-gitOperationState-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-gitoperationstate-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/gitDiff":{ "get":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformGitDiffs", "summary":"(Preview) Get list of file-level Git diffs", "description":"(Preview) Returns file-level diff summaries for the workspace branch, enabling UI views of changed files or conflicts without heavy payloads.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "$ref":"#/parameters/FolderPathQueryParam" }, { "name":"branchName", "in":"query", "required":true, "type":"string", "description":"Expected branch name for the folder context." }, { "name":"compareTo", "in":"query", "required":false, "type":"string", "description":"Determines which reference is used for computing diffs.", "enum":[ "HEAD", "UPSTREAM", "INDEX", "WORKTREE", "MERGE_BASE" ], "default":"UPSTREAM" }, { "name":"filter", "in":"query", "required":false, "type":"string", "description":"Filter which files are returned.", "enum":[ "ALL", "DIFF_ONLY", "CONFLICTS_ONLY" ], "default":"ALL" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/GitSortByQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" } ], "x-related-resource":"#/definitions/GitDiffSummaryCollection", "responses":{ "200":{ "description":"Successful operation. A page of Git diff summary objects is retrieved.", "schema":{ "$ref":"#/definitions/GitDiffSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" }, "opc-total-items":{ "description":"For list pagination. This header provides total number of items available.", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-gitDiff-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-gitdiff-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/gitRepositories/{gitRepositoryKey}/actions/gitDiffDetails":{ "get":{ "tags":[ "GitService" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformGitDiffDetail", "summary":"(Preview) Get Git file diff", "description":"(Preview) Returns a unified diff patch for a specific file so editors and review panes can render inline changes.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GitRepositoryKeyPathParam" }, { "$ref":"#/parameters/FolderPathQueryParam" }, { "name":"branchName", "in":"query", "required":true, "type":"string", "description":"Expected branch name for the folder context." }, { "name":"gitFilePath", "in":"query", "required":true, "type":"string", "description":"File path relative to repository root." }, { "name":"contextLines", "in":"query", "required":false, "type":"integer", "format":"int32", "default":3, "description":"Number of context lines to include in the diff." }, { "name":"maxPatchBytes", "in":"query", "required":false, "type":"integer", "format":"int32", "default":262144, "description":"Maximum number of bytes of diff output to return." }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/GitDiffDetail", "responses":{ "200":{ "description":"Successful operation. Git diff patch for the requested file is retrieved.", "schema":{ "$ref":"#/definitions/GitDiffDetail" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-gitRepositories-{gitRepositoryKey}-actions-gitDiffDetails-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-gitrepositories-gitrepositorykey-actions-gitdiffdetails-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/credentials":{ "x-aidp-datalake-path":"/dataLakes/{dataLakeId}/credentialsV2", "post":{ "tags":[ "credentialStore" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformCredential", "summary":"(Preview) Create new credential", "description":"(Preview) Creates a new credential object with the provided details. The operation completes synchronously; callers can invoke list or get to retrieve the resource payload.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateDataLakeCredentialDetails", "description":"Details for the new credential object. When the internal flag is enabled, callers must supply a `namespace` value of `default` or `user_settings` in the payload.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateDataLakeCredentialDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Credential", "responses":{ "200":{ "description":"Successful operation. Credentials are created.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-credentials-post", "x-filename-id":"aidataplatforms-aidataplatformid-credentials-post" }, "get":{ "tags":[ "credentialStore" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"ListAiDataPlatformCredentials", "summary":"(Preview) Get list of credentials", "description":"(Preview) Returns a list of credentials.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/CredentialDisplayNameContainsQueryParam" }, { "$ref":"#/parameters/CredentialLifecycleStateQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/CredentialSortByQueryParam" }, { "$ref":"#/parameters/CredentialTypeQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/CredentialCollection", "responses":{ "200":{ "description":"Successful operation. A list of credentials is retrieved.", "schema":{ "$ref":"#/definitions/CredentialCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-credentials-get", "x-filename-id":"aidataplatforms-aidataplatformid-credentials-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/credentials/{credentialKey}":{ "x-aidp-datalake-path":"/dataLakes/{dataLakeId}/credentialsV2/{credentialV2Key}", "get":{ "tags":[ "credentialStore" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "actionKind":"read", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"GetAiDataPlatformCredential", "summary":"(Preview) Get credential details", "description":"(Preview) Gets detailed information about credential with a given credential key.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CredentialKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Credential", "responses":{ "200":{ "description":"Successful operation. Credential details are retrieved.", "schema":{ "$ref":"#/definitions/Credential" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-credentials-{credentialKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-credentials-credentialkey-get" }, "delete":{ "tags":[ "credentialStore" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "resourceOcid":"request.urlPathSegments[2]", "actionKind":"delete", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeleteAiDataPlatformCredential", "summary":"(Preview) Delete credentials", "description":"(Preview) Deletes a credential object. The operation completes synchronously without a response body.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/CredentialKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RecentResourceUsageHeader" } ], "x-related-resource":"#/definitions/Credential", "responses":{ "204":{ "description":"Request accepted. Credentials are deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-credentials-{credentialKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-credentials-credentialkey-delete" }, "put":{ "tags":[ "credentialStore" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "resourceOcid":"request.urlPathSegments[2]", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated", "resourceNameExpression":"request.body.displayName" }, "maximumAttemptCount":3 }, "operationId":"UpdateAiDataPlatformCredential", "summary":"(Preview) Update credentials", "description":"(Preview) Updates a credential object. The operation completes synchronously; callers can invoke get to confirm the latest state.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RecentResourceUsageHeader" }, { "$ref":"#/parameters/CredentialKeyPathParam" }, { "name":"UpdateDataLakeCredentialDetails", "description":"The information to be updated.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateDataLakeCredentialDetails" } }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Credential", "responses":{ "200":{ "description":"Successful operation. Credentials are updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "405":{ "$ref":"#/responses/405" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-credentials-{credentialKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-credentials-credentialkey-put" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/get":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"GetAiDataPlatformExperimentById", "summary":"(Preview) Get experiment metadata by ID", "description":"(Preview) Returns metadata for an experiment by ID. This method works on deleted experiments.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/Experiment_id" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentResponse", "responses":{ "200":{ "description":"Successful operation. Experiment metadata by experiment ID is retrieved.", "schema":{ "$ref":"#/definitions/ExperimentResponse" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-get-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-get-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/get-by-name":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"GetAiDataPlatformExperimentByName", "summary":"(Preview) Get metadata for an experiment by name", "description":"(Preview) Returns experiment metadata for a given name. Returns deleted experiments, but prefers the active experiment if an active and deleted experiment share the same name. If multiple deleted experiments share the same name, the API will return one of them.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/Experiment_name" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentResponse", "responses":{ "200":{ "description":"Successful operation. Experiment metadata by experiment name is retrieved.", "schema":{ "$ref":"#/definitions/ExperimentResponse" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-get-by-name-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-get-name-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/create":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"CreateAiDataPlatformExperiment", "summary":"(Preview) Create an experiment", "description":"(Preview) Creates an experiment in a workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateExperimentDetails", "description":"Details for the new experiment.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateExperimentDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/Experiment", "responses":{ "200":{ "description":"Successful operation. Experiment is created.", "schema":{ "$ref":"#/definitions/CreateExperimentResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-create-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-create-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/delete":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformExperiment", "summary":"(Preview) Delete an experiment", "description":"(Preview) Deletes an experiment.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"DeleteExperimentDetails", "description":"Details of the experiment.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteExperimentDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/Experiment", "responses":{ "200":{ "description":"Successful operation. Experiment is deleted.", "schema":{ "$ref":"#/definitions/DeleteExperimentResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-delete-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-delete-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/update":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformExperiment", "summary":"(Preview) Update an experiment", "description":"(Preview) Updates an experiment.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"UpdateExperimentDetails", "description":"Update experiment metadata.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateExperimentDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/Experiment", "responses":{ "200":{ "description":"Successful operation. Experiment is updated.", "schema":{ "$ref":"#/definitions/UpdateExperimentResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-update-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-update-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/search":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"ListAiDataPlatformExperiments", "summary":"(Preview) List experiments", "description":"(Preview) Returns a list of experiments with the given details.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"ListExperimentsDetails", "description":"Details of experiments to fetch.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ListExperimentsDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentCollection", "responses":{ "200":{ "description":"Successful operation. List of experiments is retrieved.", "schema":{ "$ref":"#/definitions/ExperimentCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-search-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-search-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/restore":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"RestoreAiDataPlatformExperiment", "summary":"(Preview) Restore an experiment", "description":"(Preview) Restores an experiment.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"RestoreExperimentDetails", "description":"Restore experiment details.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/RestoreExperimentDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/Experiment", "responses":{ "200":{ "description":"Successful operation. Experiment is restored.", "schema":{ "$ref":"#/definitions/RestoreExperimentResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-restore-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-restore-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/set-experiment-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"SetAiDataPlatformExperimentTag", "summary":"(Preview) Set an experiment tag", "description":"(Preview) Sets a tag on an experiment.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"SetExperimentTagDetails", "description":"Tag details to set on an experiment.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/SetExperimentTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/Experiment", "responses":{ "200":{ "description":"Successful operation. Tag is set.", "schema":{ "$ref":"#/definitions/SetExperimentTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-set-experiment-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-set-experiment-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/delete-experiment-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformExperimentTag", "summary":"(Preview) Delete an experiment tag", "description":"(Preview) Deletes a tag on an experiment.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"DeleteExperimentTagDetails", "description":"Tag details to delete on an experiment.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteExperimentTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/Experiment", "responses":{ "200":{ "description":"Successful operation. Tag is deleted.", "schema":{ "$ref":"#/definitions/DeleteExperimentTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-experiments-delete-experiment-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-experiments-delete-experiment-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/internal/experiments/update-experiment-tags":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformExperimentTags", "summary":"(Preview) Update experiment tags", "description":"(Preview) Updates tags on experiment.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"UpdateExperimentTagsDetails", "description":"Details of Experiment tags.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateExperimentTagsDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/Experiment", "responses":{ "200":{ "description":"Experiment tags updated.", "schema":{ "$ref":"#/definitions/UpdateExperimentTagsResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-internal-experiments-update-experiment-tags-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-internal-experiments-update-experiment-tags-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/create":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"CreateAiDataPlatformExperimentRun", "summary":"(Preview) Create a new experiment run", "description":"(Preview) Creates a new run within an experiment.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateExperimentRunDetails", "description":"Details for the new run.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateExperimentRunDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Run is created within an experiment.", "schema":{ "$ref":"#/definitions/CreateExperimentRunResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-create-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-create-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/get":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"GetAiDataPlatformExperimentRunById", "summary":"(Preview) Get experiment run details by ID", "description":"(Preview) Returns details of an experiment run by ID.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ExperimentRunIdQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run details are retrieved.", "schema":{ "$ref":"#/definitions/GetExperimentRunResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-get-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-get-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/delete":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformExperimentRun", "summary":"(Preview) Delete an experiment run", "description":"(Preview) Deletes an experiment run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"DeleteExperimentRunDetails", "description":"Details of the Experiment Run.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteExperimentRunDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run is deleted.", "schema":{ "$ref":"#/definitions/DeleteExperimentRunResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-delete-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-delete-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/restore":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"RestoreAiDataPlatformExperimentRun", "summary":"(Preview) Restore an experiment run", "description":"(Preview) Restores an experiment run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"RestoreExperimentRunDetails", "description":"Restore experiment run details.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/RestoreExperimentRunDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run is restored.", "schema":{ "$ref":"#/definitions/RestoreExperimentRunResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-restore-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-restore-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/set-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"SetAiDataPlatformExperimentRunTag", "summary":"(Preview) Set an experiment run tag", "description":"(Preview) Sets a tag on an experiment run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"SetExperimentRunTagDetails", "description":"Tag details to set on an experiment run.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/SetExperimentRunTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Tag is set.", "schema":{ "$ref":"#/definitions/SetExperimentRunTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-set-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-set-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/delete-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformExperimentRunTag", "summary":"(Preview) Delete an experiment run tag", "description":"(Preview) Deletes a tag on an experiment run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"DeleteExperimentRunTagDetails", "description":"Tag details to delete on an experiment run.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteExperimentRunTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Tag is deleted.", "schema":{ "$ref":"#/definitions/DeleteExperimentRunTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-delete-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-delete-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/internal/runs/update-tags":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformExperimentRunTags", "summary":"(Preview) Update experiment run tags", "description":"(Preview) Updates tags on an experiment run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"UpdateExperimentRunTagsDetails", "description":"Details of ExperimentRun tags.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateExperimentRunTagsDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run tags updated.", "schema":{ "$ref":"#/definitions/UpdateExperimentRunTagsResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-internal-runs-update-tags-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-internal-runs-update-tags-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/update":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformExperimentRun", "summary":"(Preview) Update an experiment run", "description":"(Preview) Updates an experiment run.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"UpdateExperimentRunDetails", "description":"Update experiment run details.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateExperimentRunDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run is updated.", "schema":{ "$ref":"#/definitions/UpdateExperimentRunResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-update-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-update-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-metric":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"LogAiDataPlatformExperimentRunMetric", "summary":"(Preview) Log an experiment run metric", "description":"(Preview) Logs an experiment run metric.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"LogExperimentRunMetricDetails", "description":"Details of an experiment run metric.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/LogExperimentRunMetricDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run metric is logged.", "schema":{ "$ref":"#/definitions/LogExperimentRunMetricResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-log-metric-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-log-metric-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-model":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"LogAiDataPlatformExperimentRunModel", "summary":"(Preview) Log an experiment run model", "description":"(Preview) Logs an experiment run model.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"LogExperimentRunModelDetails", "description":"Details of an experiment run model.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/LogExperimentRunModelDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run model is logged.", "schema":{ "$ref":"#/definitions/LogExperimentRunModelResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-log-model-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-log-model-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-parameter":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"LogAiDataPlatformExperimentRunParam", "summary":"(Preview) Log an experiment run parameter", "description":"(Preview) Logs an experiment run parameter.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"LogExperimentRunParamDetails", "description":"Details of an experiment run parameter.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/LogExperimentRunParamDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run parameter is logged.", "schema":{ "$ref":"#/definitions/LogExperimentRunParamResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-log-parameter-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-log-parameter-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-inputs":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"LogAiDataPlatformExperimentRunInputs", "summary":"(Preview) Log experiment run inputs", "description":"(Preview) Logs experiment run inputs.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"LogExperimentRunInputsDetails", "description":"Details of experiment run inputs.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/LogExperimentRunInputsDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run inputs are logged.", "schema":{ "$ref":"#/definitions/LogExperimentRunInputsResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-log-inputs-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-log-inputs-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/log-batch":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"LogAiDataPlatformExperimentRunBatch", "summary":"(Preview) Log an experiment run batch", "description":"(Preview) Logs an experiment run batch.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"LogExperimentRunBatchDetails", "description":"Details of an experiment run batch.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/LogExperimentRunBatchDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRun", "responses":{ "200":{ "description":"Successful operation. Experiment run batch is logged.", "schema":{ "$ref":"#/definitions/LogExperimentRunBatchResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-log-batch-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-log-batch-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/runs/search":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"ListAiDataPlatformExperimentRuns", "summary":"(Preview) List experiment runs", "description":"(Preview) Returns a list of experiment runs in a workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"ListExperimentRunsDetails", "description":"Details of experiment runs to fetch.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ListExperimentRunsDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRunCollection", "responses":{ "200":{ "description":"Successful operation. List of experiment runs is retrieved.", "schema":{ "$ref":"#/definitions/ExperimentRunCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-runs-search-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-runs-search-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/artifacts/list":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"ListAiDataPlatformArtifacts", "summary":"(Preview) List artifacts", "description":"(Preview) Returns a list of artifacts.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/ListArtifactsRunIdQueryParam" }, { "$ref":"#/parameters/ListArtifactsPathQueryParam" }, { "$ref":"#/parameters/ListArtifactsPageTokenQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ArtifactList", "responses":{ "200":{ "description":"Successful operation. List of artifacts is retrieved.", "schema":{ "$ref":"#/definitions/ArtifactList" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-artifacts-list-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-artifacts-list-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/create":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"CreateAiDataPlatformRegisteredModel", "summary":"(Preview) Create a registered model", "description":"(Preview) Creates a registered model in a workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateRegisteredModelDetails", "description":"Details for the new registered model.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateRegisteredModelDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"Successful operation. Registered model is created.", "schema":{ "$ref":"#/definitions/CreateRegisteredModelResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-create-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-create-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/get":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"GetAiDataPlatformRegisteredModel", "summary":"(Preview) Get registered model details", "description":"(Preview) Returns details for a specified registered model.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/RegisteredModelNameQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"Successful operation. Registered model details are retrieved.", "schema":{ "$ref":"#/definitions/GetRegisteredModelResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-get-get", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-get-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/update":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformRegisteredModel", "summary":"(Preview) Update a registered model", "description":"(Preview) Updates a registered model with the provided details.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"UpdateRegisteredModelDetails", "description":"Details to update the registered model.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateRegisteredModelDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"Successful operation. Registered model is updated.", "schema":{ "$ref":"#/definitions/UpdateRegisteredModelResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-update-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-update-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/rename":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"RenameAiDataPlatformRegisteredModel", "summary":"(Preview) Rename a registered model", "description":"(Preview) Renames a registered model.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"RenameRegisteredModelDetails", "description":"Details of a registered model rename.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/RenameRegisteredModelDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"Successful operation. Registered model is renamed.", "schema":{ "$ref":"#/definitions/RenameRegisteredModelResponseDetails" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-rename-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-rename-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/delete":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformRegisteredModel", "summary":"(Preview) Delete a registered model", "description":"(Preview) Deletes a registered model.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"DeleteRegisteredModelDetails", "description":"Details of the registered model to delete.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteRegisteredModelDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"Successful operation. Registered model is deleted.", "schema":{ "$ref":"#/definitions/DeleteRegisteredModelResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-delete-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-delete-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/set-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"SetAiDataPlatformRegisteredModelTag", "summary":"(Preview) Set registered model tag", "description":"(Preview) Sets a tag on a registered model.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"SetRegisteredModelTagDetails", "description":"Details of a registered model tag.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/SetRegisteredModelTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"Successful operation. Registered model is tagged.", "schema":{ "$ref":"#/definitions/SetRegisteredModelTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-set-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-set-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/delete-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformRegisteredModelTag", "summary":"(Preview) Delete registered model tag", "description":"(Preview) Deletes a tag on a registered model.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"DeleteRegisteredModelTagDetails", "description":"Details of a registered model tag.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteRegisteredModelTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"RegisteredModel tag is deleted.", "schema":{ "$ref":"#/definitions/DeleteRegisteredModelTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-delete-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-delete-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/internal/registered-models/update-tags":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformRegisteredModelTags", "summary":"(Preview) Update registered model tags", "description":"(Preview) Updates tags on a registered model.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"UpdateRegisteredModelTagsDetails", "description":"Details of registered model tags.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateRegisteredModelTagsDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModel", "responses":{ "200":{ "description":"Successful operation. Registered model tags updated.", "schema":{ "$ref":"#/definitions/UpdateRegisteredModelTagsResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-internal-registered-models-update-tags-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-internal-registered-models-update-tags-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/registered-models/search":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"ListAiDataPlatformRegisteredModels", "summary":"(Preview) List registered models", "description":"(Preview) Returns a list of registered models in a workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ListRegisteredModelsFilterQueryParam" }, { "$ref":"#/parameters/ListRegisteredModelsMaxResultsQueryParam" }, { "$ref":"#/parameters/ListRegisteredModelsPageTokenQueryParam" }, { "$ref":"#/parameters/ListRegisteredModelsOrderByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/RegisteredModelCollection", "responses":{ "200":{ "description":"Successful operation. List of registered models is retrieved.", "schema":{ "$ref":"#/definitions/RegisteredModelCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-registered-models-search-get", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-registered-models-search-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/create":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"CreateAiDataPlatformModelVersion", "summary":"(Preview) Create a model version", "description":"(Preview) Creates a model version.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateModelVersionDetails", "description":"Details for the new model version.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateModelVersionDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version is created.", "schema":{ "$ref":"#/definitions/CreateModelVersionResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-create-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-create-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/model-versions/create":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"CreateAiDataPlatformWorkspaceModelVersion", "summary":"(Preview) Create a model version in a workspace", "description":"(Preview) Creates a new model version in a specified workspace.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateModelVersionDetails", "description":"Details for the new model version.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateModelVersionDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version is created.", "schema":{ "$ref":"#/definitions/CreateModelVersionResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-model-versions-create-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-model-versions-create-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/get":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"GetAiDataPlatformModelVersion", "summary":"(Preview) Get model version details", "description":"(Preview) Returns detailed information for a model version.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ModelVersionNameQueryParam" }, { "$ref":"#/parameters/ModelVersionNumberQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version details are retrieved.", "schema":{ "$ref":"#/definitions/GetModelVersionResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-get-get", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-get-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/update":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformModelVersion", "summary":"(Preview) Update a model version", "description":"(Preview) Updates a model version", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"UpdateModelVersionDetails", "description":"Details to update model version.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateModelVersionDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Registered model is updated.", "schema":{ "$ref":"#/definitions/UpdateModelVersionResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-update-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-update-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/delete":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"delete", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformModelVersion", "summary":"(Preview) Delete a model version", "description":"(Preview) Deletes a model version.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"DeleteModelVersionDetails", "description":"Details of the model version to delete.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteModelVersionDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version is deleted.", "schema":{ "$ref":"#/definitions/DeleteModelVersionResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-delete-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-delete-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/transition-stage":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"TransitionAiDataPlatformModelVersionStage", "summary":"(Preview) Transition a model version stage", "description":"(Preview) Transitions a model version stage.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"TransitionModelVersionStageDetails", "description":"Details to transition a model version stage.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/TransitionModelVersionStageDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version stage is transitioned.", "schema":{ "$ref":"#/definitions/TransitionModelVersionStageResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-transition-stage-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-transition-stage-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/search":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"ListAiDataPlatformModelVersions", "summary":"(Preview) List model versions", "description":"(Preview) Returns a list of model versions.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/ListModelVersionsFilterQueryParam" }, { "$ref":"#/parameters/ListModelVersionsMaxResultsQueryParam" }, { "$ref":"#/parameters/ListModelVersionsPageTokenQueryParam" }, { "$ref":"#/parameters/ListModelVersionsOrderByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersionCollection", "responses":{ "200":{ "description":"Successful operation. List of model versions is retrieved.", "schema":{ "$ref":"#/definitions/ModelVersionCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-search-get", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-search-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/set-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"SetAiDataPlatformModelVersionTag", "summary":"(Preview) Set model version tag", "description":"(Preview) Sets a tag on a model version.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"SetModelVersionTagDetails", "description":"Details of a model version tag.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/SetModelVersionTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version is tagged.", "schema":{ "$ref":"#/definitions/SetModelVersionTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-set-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-set-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/model-versions/delete-tag":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformModelVersionTag", "summary":"(Preview) Delete model version tag", "description":"(Preview) Deletes a tag on a model version.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"DeleteModelVersionTagDetails", "description":"Details of a model version tag to delete.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/DeleteModelVersionTagDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version tag is deleted.", "schema":{ "$ref":"#/definitions/DeleteModelVersionTagResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-model-versions-delete-tag-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-model-versions-delete-tag-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/mlops/api/2.0/mlflow/internal/model-versions/update-tags":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "reconciliationCanStartAfterSecs":30, "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformModelVersionTags", "summary":"(Preview) Update model version tags", "description":"(Preview) Updates tags on a model version.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"UpdateModelVersionTagsDetails", "description":"Details of model version tags to update.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateModelVersionTagsDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ModelVersion", "responses":{ "200":{ "description":"Successful operation. Model version tags updated.", "schema":{ "$ref":"#/definitions/UpdateModelVersionTagsResponseDetails" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-mlops-api-2.0-mlflow-internal-model-versions-update-tags-post", "x-filename-id":"aidataplatforms-aidataplatformid-mlops-api-2.0-mlflow-internal-model-versions-update-tags-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/logged-models/search":{ "post":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"ListAiDataPlatformLoggedModels", "summary":"(Preview) List logged models", "description":"(Preview) Returns a list of logged models.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"ListLoggedModelsDetails", "description":"Details of logged models to fetch.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ListLoggedModelsDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/LoggedModelCollection", "responses":{ "200":{ "description":"Successful operation. List of logged models is retrieved.", "schema":{ "$ref":"#/definitions/LoggedModelCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-logged-models-search-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-logged-models-search-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/metrics/get-history":{ "get":{ "tags":[ "MLOps" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"GetAiDataPlatformExperimentRunMetricHistory", "summary":"(Preview) Get experiment run metric history", "description":"(Preview) Returns a history of experiment run metrics.", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "$ref":"#/parameters/GetExperimentRunMetricHistoryRunIdQueryParam" }, { "$ref":"#/parameters/GetExperimentRunMetricHistoryMetricKeyQueryParam" }, { "$ref":"#/parameters/GetExperimentRunMetricHistoryPageTokenQueryParam" }, { "$ref":"#/parameters/GetExperimentRunMetricHistoryMaxResultsQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/UserPrincipalHeader" } ], "x-related-resource":"#/definitions/ExperimentRunMetricHistoryCollection", "responses":{ "200":{ "description":"Successful operation. History of experiment run metrics is retrieved.", "schema":{ "$ref":"#/definitions/ExperimentRunMetricHistoryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-mlops-api-2.0-mlflow-metrics-get-history-get", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-mlops-api-2.0-mlflow-metrics-get-history-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles":{ "post":{ "tags":[ "Bundle" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"CreateAiDataPlatformBundle", "summary":"(Preview) Create a new bundle in a workspace folder", "description":"(Preview) Creates a new bundle.\n\nA bundle is a self-contained, portable representation of selected workspace assets, such as jobs\nand agent flows, along with their dependencies and associated code artifacts. It captures both\nthe resource configurations and the supporting assets required to recreate those resources in\nanother workspace or environment.\n\nThe bundle manifest is named `aidp_workbench.yaml`. The bundle preserves the workspace folder\nstructure for code artifacts from the location where it was created, so the generated bundle\nmirrors the source layout.\n\nDependencies are tracked inside the bundle under each asset type:\n - job and agent flow dependencies are added under the `dependencies` folder inside the\n`jobs` and `agentflows` folders\n- code dependencies are added under the `artifacts` directory in the bundle\n\nGit integration and promotion:\n - bundles can only be created inside Git-backed workspace folders\n - bundles are self-contained packages that include resource definitions, dependency references,\n and associated code artifacts required to recreate the bundled resources\n - the entire bundle folder can be committed and pushed to a Git repository\n - bundles can be pulled into another workspace via Git and deployed there\n - bundles can be promoted across environments (for example, dev ??? test ??? prod) using Git workflows\n - because the bundle includes both resource configuration and code dependencies, it can be used\n to reliably replicate assets across workspaces\n\nThis operation is asynchronous. The service validates the request, starts bundle\ncreation, and returns an async operation key in the response headers. Use the async\noperation APIs to track completion.\n\nTypical use cases:\n- capture selected workspace resources into a version-controlled bundle\n- prepare a bundle for later deployment or promotion\n- establish a bundle root that can later be inspected, updated, or deployed\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"CreateBundleDetails", "in":"body", "required":true, "description":"Request payload for bundle creation.", "schema":{ "$ref":"#/definitions/CreateBundleDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Bundle", "x-example":"POST /aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles\nHost: aidp.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"name\": \"customer_churn_bundle\",\n \"description\": \"Bundle for churn scoring workflow\",\n \"path\": \"/Workspace/git/demo-team\",\n \"bundledResources\": [\n {\"resourceType\": \"JOB\", \"resourceKey\": \"job_ocid_or_key_1\"},\n {\"resourceType\": \"AGENTFLOW\", \"resourceKey\": \"aflow_ocid_or_key_1\"}\n ]\n}\n", "responses":{ "202":{ "description":"Accepted. Bundle creation initiated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-bundles-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-bundles-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/deploy":{ "post":{ "tags":[ "Bundle" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"DeployAiDataPlatformBundle", "summary":"(Preview) Deploy all bundle resources", "description":"(Preview) Deploys the specified bundle, creating or updating jobs and agent flows according to the bundle manifest.\nReturns an async job key for tracking deployment progress.\n\nThis operation is asynchronous. The request is accepted for background execution and\nreturns an async operation key in the response headers.\n\nDeployment typically uses:\n- the bundle manifest at the bundle root\n- top-level resource descriptors in the bundle\n- dependency descriptors referenced by those top-level resources\n- default or override variable values when present\n\nUse this operation when you want to apply the bundle contents into the target\nworkspace state.\n\nRequest notes:\n- `path` identifies the bundle root folder in the workspace volume\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"DeployBundleDetails", "in":"body", "required":true, "description":"Request payload for bundle deploy.", "schema":{ "$ref":"#/definitions/DeployBundleDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Bundle", "x-example":"POST /aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/deploy\nHost: aidp.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"path\": \"/Workspace/git/demo-team/customer_churn_bundle\"\n}\n", "responses":{ "202":{ "description":"Accepted. Bundle deployment initiated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-bundles-actions-deploy-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-bundles-actions-deploy-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/purge":{ "post":{ "tags":[ "Bundle" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3 }, "operationId":"PurgeAiDataPlatformBundle", "summary":"(Preview) Destroy all deployed bundle resources", "description":"(Preview) Tears down all resources deployed by the specified bundle in the workspace.\n\nThis operation is intended to tear down resources that were created or managed through\nbundle deployment. It does not delete the bundle files themselves from the workspace\nvolume.\n\nThis operation is asynchronous. The service accepts the purge request, starts the\nbackground teardown workflow, and returns async operation headers.\n\nTypical use cases:\n- remove resources that were previously deployed from a bundle\n- clean up a workspace before re-deploying or retiring a bundle\n\nRequest notes:\n- `path` identifies the bundle root folder in the workspace volume\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"PurgeBundleDetails", "in":"body", "required":true, "description":"Request payload for bundle purge.", "schema":{ "$ref":"#/definitions/PurgeBundleDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Bundle", "x-example":"POST /aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/purge\nHost: aidp.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"path\": \"/Workspace/git/demo-team/customer_churn_bundle\"\n}\n", "responses":{ "202":{ "description":"Accepted. Purge operation initiated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "aidp-async-operation-key":{ "description":"The key of the asynchronous operations associated with an AI Data Platform instance.\nUse GetAsyncOperation with this key to track the status of the request.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-bundles-actions-purge-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-bundles-actions-purge-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/getDeploymentStatus":{ "post":{ "tags":[ "Bundle" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_INSPECT", "DATA_LAKE_INSPECT" ] } }, "authorization":{ "mode":"automated", "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_INSPECT') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_INSPECT')", "allowCrossTenancy":true }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "operationType":"GET" }, "operationId":"FetchAiDataPlatformBundleDeploymentStatus", "summary":"(Preview) Return the latest known deployment summary for a bundle", "description":"(Preview) Returns a high-level summary of the most recent deployment activity recorded for the\nspecified bundle.\n\nThis operation is useful after deploy or purge requests when you want the latest\nbundle-level deployment outcome rather than raw async operation details.\n\nThe response can include:\n- overall deployment status\n- start and completion timestamps\n- summary message\n- resources associated with the last recorded deployment result\n\nTypical status values include:\n- `IN_PROGRESS`\n- `SUCCEEDED`\n- `FAILED`\n- `NOT_DEPLOYED`\n\nRequest notes:\n- `path` identifies the bundle root folder in the workspace volume\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/WorkspaceKeyPathParam" }, { "name":"FetchBundleDeploymentStatusDetails", "in":"body", "required":true, "description":"Request payload for FetchBundleDeploymentStatusDetails.", "schema":{ "$ref":"#/definitions/FetchBundleDeploymentStatusDetails" } }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Bundle", "x-example":"POST /aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/bundles/actions/getDeploymentStatus\nHost: aidp.us-phoenix-1.oci.oraclecloud.com\n<authorization and other headers>\n{\n \"path\": \"/Workspace/git/demo-team/customer_churn_bundle\"\n}\n", "responses":{ "200":{ "description":"Last deployment summary for the bundle.", "schema":{ "$ref":"#/definitions/BundleDeploymentStatus" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-workspaces-{workspaceKey}-bundles-actions-getDeploymentStatus-post", "x-filename-id":"aidataplatforms-aidataplatformid-workspaces-workspacekey-bundles-actions-getdeploymentstatus-post" } }, "/aiDataPlatforms/{aiDataPlatformId}/userSettings":{ "post":{ "tags":[ "UserSetting" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"create", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"CreateAiDataPlatformUserSetting", "summary":"(Preview) Manage user credentials and integrations", "description":"(Preview) The User Settings API allows you to manage user-specific configurations and credentials within an AI Data Platform instance.\nWhat you can do\n-> Store user credentials and integrations, including:\n-> IAM user credentials\n-> Git account configurations (e.g., GitHub PAT)\n-> Create and manage multiple settings\n-> Mark a setting as default for a given type\n-> Retrieve and filter settings by type or default status\nSupported setting types\n-> IAM_USER_CREDENTIAL ??? OCI user credentials for API access\n-> GIT_ACCOUNT ??? Git provider configuration (e.g., GitHub personal access token)\nCore operations\n-> Create a user setting\n-> List all user settings (with filtering and pagination)\n-> Get a specific setting by key\n-> Update an existing setting\n-> Delete a setting\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "name":"CreateUserSettingDetails", "description":"Details for the new setting.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateUserSettingDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" } ], "x-related-resource":"#/definitions/UserSetting", "responses":{ "200":{ "description":"Successful operation. Settings are created or updated.", "schema":{ "$ref":"#/definitions/UserSetting" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-userSettings-post", "x-filename-id":"aidataplatforms-aidataplatformid-usersettings-post" }, "get":{ "tags":[ "UserSetting" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"ListAiDataPlatformUserSettings", "summary":"(Preview) Get list of user settings by type or default status", "description":"(Preview) Returns a list of all user-specific configurations, with filters for setting type, default flag, and pagination when needed.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SettingTypeQueryParam" }, { "$ref":"#/parameters/IsDefaultQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SettingSortByQueryParam" }, { "$ref":"#/parameters/DisplayNameQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Successful operation. List of user settings is retrieved.", "schema":{ "$ref":"#/definitions/UserSettingCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-userSettings-get", "x-filename-id":"aidataplatforms-aidataplatformid-usersettings-get" } }, "/aiDataPlatforms/{aiDataPlatformId}/userSettings/{settingKey}":{ "get":{ "tags":[ "UserSetting" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' || aiDataPlatform?.lifecycleState=='CREATING' || aiDataPlatform?.lifecycleState=='DELETING' || aiDataPlatform?.lifecycleState=='FAILED' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"read", "permissions":[ "AI_DATA_PLATFORM_READ", "DATA_LAKE_READ" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_READ') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_READ')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"GetAiDataPlatformUserSetting", "summary":"(Preview) Get user settings", "description":"(Preview) Returns the full definition of user settings identified by its key, including type-specific payload and default flag.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SettingKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "responses":{ "200":{ "description":"Successful operation. User setting details are retrieved.", "schema":{ "$ref":"#/definitions/UserSetting" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-userSettings-{settingKey}-get", "x-filename-id":"aidataplatforms-aidataplatformid-usersettings-settingkey-get" }, "put":{ "tags":[ "UserSetting" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"update", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"UpdateAiDataPlatformUserSetting", "summary":"(Preview) Update a stored user setting", "description":"(Preview) Updates the metadata or payload of an existing user setting, letting you rotate credentials or change defaults.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SettingKeyPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "name":"UpdateUserSettingDetails", "description":"Details for the user setting to be updated.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/UpdateUserSettingDetails" } } ], "x-related-resource":"#/definitions/UserSetting", "responses":{ "200":{ "description":"Successful operation. Setting updated.", "schema":{ "$ref":"#/definitions/UserSetting" }, "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-userSettings-{settingKey}-put", "x-filename-id":"aidataplatforms-aidataplatformid-usersettings-settingkey-put" }, "delete":{ "tags":[ "UserSetting" ], "x-obmcs-splat":{ "routing":{ "strategy":"route-to-any-ad" }, "serviceList":[ "${service_yaml_prefix}-DP-API${service_yaml_suffix}" ], "resources":{ "aiDataPlatform":{ "serviceResourceName":"AiDataPlatform", "targetCompartmentId":"aiDataPlatform = downstream.getOr404('${service_yaml_cp_prefix}-CP${service_yaml_suffix}', 'GetAiDataPlatform', request.urlPathSegments[2]); splat.getOrThrow(aiDataPlatform?.lifecycleState=='ACTIVE' ? aiDataPlatform.compartmentId : '','InvalidParameter','AI DataPlatform does not exist or not valid')", "actionKind":"delete", "permissions":[ "AI_DATA_PLATFORM_UPDATE", "DATA_LAKE_UPDATE" ] } }, "authorization":{ "mode":"automated", "allowCrossTenancy":true, "check":"resources['aiDataPlatform'].grantedPermissions.contains('AI_DATA_PLATFORM_UPDATE') || resources['aiDataPlatform'].grantedPermissions.contains('DATA_LAKE_UPDATE')" }, "audit":{ "mode":"automated" }, "maximumAttemptCount":3, "throttling":{ "perTenantLimit":{ "rpsLimit":50, "rpmLimit":1000 } } }, "operationId":"DeleteAiDataPlatformUserSetting", "summary":"(Preview) Delete a user setting", "description":"(Preview) Deletes a user setting and its credentials from this AI Data Platform instance, freeing the default slot for that type.\n", "parameters":[ { "$ref":"#/parameters/AiDataPlatformIdentifierPathParam" }, { "$ref":"#/parameters/SettingKeyPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/UserSetting", "responses":{ "204":{ "description":"Request accepted. Setting deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"aiDataPlatforms-{aiDataPlatformId}-userSettings-{settingKey}-delete", "x-filename-id":"aidataplatforms-aidataplatformid-usersettings-settingkey-delete" } } }, "definitions":{ "DataLake":{ "description":"A DataLake is a description of a DataLake.\n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n", "type":"object", "x-obmcs-splat":{ "resourceKind":"dataLake", "ocidEntityType":"${datalake_entity_type}", "adLocality":"regional", "activeLifecycleStates":[ "active" ], "deletedLifecycleStates":[ "deleted" ], "workRequestDetails":{ "workRequestEntityType":"${datalake_workrequest_entity_type}", "workRequestGetOperationId":"GetWorkRequest", "successfulLifecycleStates":[ "SUCCEEDED" ], "failedLifecycleStates":[ "FAILED", "CANCELED" ] } } }, "AiDataPlatform":{ "description":"An AiDataPlatform is a unified platform for lifecycle management and governance of data and AI objects.\n", "type":"object", "x-obmcs-splat":{ "resourceKind":"aiDataPlatform", "ocidEntityType":"${aidataplatform_entity_type}", "adLocality":"regional", "activeLifecycleStates":[ "active" ], "deletedLifecycleStates":[ "deleted" ], "workRequestDetails":{ "workRequestEntityType":"${aidataplatform_workrequest_entity_type}", "workRequestGetOperationId":"GetWorkRequest", "successfulLifecycleStates":[ "SUCCEEDED" ], "failedLifecycleStates":[ "FAILED", "CANCELED" ] } } }, "Error":{ "description":"Error information.", "required":[ "code", "message" ], "properties":{ "code":{ "description":"A short error code that defines the error, meant for programmatic parsing.", "type":"string" }, "message":{ "description":"A human-readable error message.", "type":"string" } } }, "SortOrder":{ "type":"string", "description":"The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `displayName`\nsort order is case sensitive.\n", "enum":[ "ASC", "DESC" ] }, "GranteeType":{ "description":"The information about the Grantee Type.", "type":"string", "minLength":1, "maxLength":255, "enum":[ "USER", "ROLE", "GROUP" ] }, "PermissionAssignees":{ "type":"object", "description":"The information about the assignees", "required":[ "type", "targets" ], "properties":{ "type":{ "type":"string", "description":"Grantee type.", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "targets":{ "type":"array", "description":"The names/ocids of the users, groups or roles.", "items":{ "type":"string" } } } }, "PrincipalsWithWorkspaceAccessSummary":{ "description":"This is a object containing the user and the type of permission they have\n", "required":[ "grantee", "granteeName", "granteeType" ], "properties":{ "grantee":{ "type":"string", "description":"The OCID of user/group and name in case of role." }, "granteeName":{ "type":"string", "description":"The simplified name of the grantee." }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] } } }, "PrincipalsWithWorkspaceAccessCollection":{ "type":"object", "description":"Returns a list of users with particular AI Data Platform Workbench RBAC permissions across workspaces.", "required":[ "items" ], "properties":{ "items":{ "description":"List of users with particular AI Data Platform Workbench RBAC permissions across workspaces.", "type":"array", "items":{ "$ref":"#/definitions/PrincipalsWithWorkspaceAccessSummary" } } } }, "Workspace":{ "description":"A AI Data Platform Workbench Workspace is a logical container that provides users with a collaborative development and runtime environment.\nWorkspace organizes and manages resources such as compute clusters, motebooks, and data orchestration workflows. \nWorkspace provides shared file system areas to allow for storage of notebooks, SQL scripts, and other files. \nCollaboration features such as version control integration (e.g. GitHub) as well as CI/CD tools integration.\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see \nIAM Policies for Oracle AI Data Platform Workbench.\n", "type":"object", "required":[ "key", "lifecycleState", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The key of the AI Data Platform Workbench workspace.", "type":"string" }, "displayName":{ "description":"A user-friendly name that has to be unique in a AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"Description of the workspace.", "type":"string" }, "type":{ "description":"Workspace type. Type is DEFAULT for workspace created at AI Data Platform Workbench creation, type is USER for workspace created by AI Data Platform Workbench user.", "type":"string", "enum":[ "DEFAULT", "USER" ] }, "timeCreated":{ "description":"The date and time the AI Data Platform Workbench workspace was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the AI Data Platform Workbench workspace was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "lifecycleState":{ "description":"The current state of the AI Data Platform Workbench workspace.", "type":"string", "enum":[ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ] }, "lifecycleDetails":{ "description":"A message that describes the current state of the workspace in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } }, "createdBy":{ "description":"OCID of the user who created this record.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record.", "type":"string" }, "updatedBy":{ "description":"OCID of the user who updated this record.", "type":"string" }, "updatedByName":{ "description":"Name of the user who updated this record.", "type":"string" }, "defaultCatalogKey":{ "description":"The key of the catalog to be used as the default catalog for this workspace.\nA default catalog in the workspace will allow users to use that\ncatalog without the need to refer it in the notebook. For example, if default catalog is iCat1, and it has\nschema1 and table1, you can refer to the table in a notebook using: schema1.table1.\n", "type":"string" }, "isPrivateNetworkEnabled":{ "type":"boolean", "description":"A flag to display whether workspace is private network enabled or not." }, "networkConfigurationDetails":{ "$ref":"#/definitions/WorkspaceNetworkConfigurationDetails" }, "logGroupId":{ "type":"string", "description":"The OCID of the log group that contains the logs.\nThis uniquely identifies a collection of logs within OCI Logging Service.\n", "example":"ocid1.loggroup.oc1.iad.aaaaaaaaxxxxxx" }, "aicUserSchemaName":{ "type":"string", "description":"The name of the AIC user schema if created." } } }, "WorkspaceNetworkConfigurationDetails":{ "description":"Private network configuration details.", "type":"object", "properties":{ "subnetId":{ "type":"string", "description":"The OCID of a subnet.\n", "minLength":1, "maxLength":255 }, "nsgIds":{ "type":"array", "items":{ "type":"string" }, "description":"An array of network security group OCIDs.\n", "minLength":1, "maxLength":255 }, "scanDetails":{ "type":"array", "items":{ "$ref":"#/definitions/Scan" }, "maxItems":15, "description":"An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value.\n[ { fqdn: \"scan1.oracle.com\", port: \"1521\"}, { fqdn: \"scan2.oracle.com\", port: \"1521\" } ]\n" } } }, "WorkspaceSummary":{ "description":"Summary information about a Workspace.", "type":"object", "required":[ "key", "type", "lifecycleState", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The key of the AI Data Platform Workbench workspace.", "type":"string" }, "displayName":{ "description":"A user-friendly name that has to be unique in a AI Data Platform Workbench instance.", "type":"string" }, "type":{ "description":"Workspace type. Type is DEFAULT for workspace created at AI Data Platform Workbench creation, type is USER for workspace created by AI Data Platform Workbench user.", "type":"string", "enum":[ "DEFAULT", "USER" ] }, "description":{ "description":"Description of the workspace.", "type":"string" }, "timeCreated":{ "description":"The date and time the AI Data Platform Workbench workspace was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the AI Data Platform Workbench workspace was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "lifecycleState":{ "type":"string", "description":"The current state of the AI Data Platform Workbench workspace.", "x-obmcs-enumref":"#/definitions/Workspace/lifecycleState" }, "lifecycleDetails":{ "description":"A message that describes the current state of the workspace in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } }, "createdBy":{ "description":"OCID of the user who created this record.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record.", "type":"string" }, "updatedBy":{ "description":"OCID of the user who updated this record.", "type":"string" }, "updatedByName":{ "description":"Name of the user who updated this record.", "type":"string" }, "defaultCatalogKey":{ "description":"The key of the catalog to be used as the default catalog for this workspace.\nA default catalog in the workspace will allow users to use that\ncatalog without the need to refer it in the notebook. For example, if default catalog is iCat1, and it has\nschema1 and table1, you can refer to the table in a notebook using: schema1.table1.\n", "type":"string" }, "isPrivateNetworkEnabled":{ "type":"boolean", "description":"A flag to display whether workspace is private network enabled or not." }, "aicUserSchemaName":{ "type":"string", "description":"The name of the AIC user schema if created." } } }, "CreateWorkspaceDetails":{ "description":"The data to create a workspace.", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "description":"A user-friendly name that has to be unique in a AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"Description of the workspace.", "type":"string" }, "defaultCatalogKey":{ "description":"The key of the catalog to be used as the default catalog for this workspace.\nA default catalog in the workspace will allow users to use that\ncatalog without the need to refer it in the notebook. For example, if default catalog is iCat1, and it has\nschema1 and table1, you can refer to the table in a notebook using: schema1.table1.\n", "type":"string" }, "networkConfigurationDetails":{ "$ref":"#/definitions/WorkspaceNetworkConfigurationDetails" } } }, "UpdateWorkspaceDetails":{ "description":"The data to update a workspace.", "type":"object", "properties":{ "displayName":{ "description":"A user-friendly name that has to be unique in a AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"Description of the workspace.", "type":"string" }, "defaultCatalogKey":{ "description":"The key of the catalog to be used as the default catalog for this workspace.\nA default catalog in the workspace will allow users to use that\ncatalog without the need to refer it in the notebook. For example, if default catalog is iCat1, and it has\nschema1 and table1, you can refer to the table in a notebook using: schema1.table1.\n", "type":"string" }, "networkConfigurationDetails":{ "$ref":"#/definitions/WorkspaceNetworkConfigurationDetails" } } }, "WorkspaceCollection":{ "type":"object", "description":"Results of a workspace search. Contains summary information of workspaces.", "required":[ "items" ], "properties":{ "items":{ "description":"List of workspaces.", "type":"array", "items":{ "$ref":"#/definitions/WorkspaceSummary" } } } }, "WorkspacePrivilege":{ "description":"The privilege for a workspace.", "type":"string", "enum":[ "USER", "PRIVILEGED_USER", "ADMINISTRATOR" ] }, "WorkspacePermissionCollection":{ "type":"object", "description":"List of workspace permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of workspace permissions.", "type":"array", "items":{ "$ref":"#/definitions/WorkspacePermissionSummary" } } } }, "WorkspacePermissionSummary":{ "description":"Information about a workspace permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a workspace.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/WorkspacePrivilege", "enum":[ "USER", "PRIVILEGED_USER", "ADMINISTRATOR" ] } } } }, "CreateWorkspacePermissionCollection":{ "type":"object", "description":"List of Create Workspace permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Create Workspace permissions.", "type":"array", "items":{ "$ref":"#/definitions/CreateWorkspacePermissionSummary" } } } }, "CreateWorkspacePermissionSummary":{ "description":"Information about a Create Workspace permission.", "type":"object", "required":[ "grantee", "granteeType" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] } } }, "AssignWorkspacePermissionDetails":{ "description":"The details of the permissions assigned on the workspace to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/WorkspacePrivilege", "enum":[ "USER", "PRIVILEGED_USER", "ADMINISTRATOR" ] } } } }, "AssignCreateWorkspacePermissionDetails":{ "description":"The details of the permissions assigned on the workspace to assignee.", "type":"object", "required":[ "assignees" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" } } }, "RevokeWorkspacePermissionDetails":{ "description":"The details of the permissions revoked from assignees for a workspace.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/WorkspacePrivilege", "enum":[ "USER", "PRIVILEGED_USER", "ADMINISTRATOR" ] } } } }, "RevokeCreateWorkspacePermissionDetails":{ "description":"The details of the permissions revoked from assignees for a workspace.", "type":"object", "required":[ "assignees" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" } } }, "ManageWorkspacePermissionDetails":{ "description":"Information to update permissions on a workspace.", "type":"object", "properties":{ "assignWorkspacePermissionDetails":{ "$ref":"#/definitions/AssignWorkspacePermissionDetails" }, "revokeWorkspacePermissionDetails":{ "$ref":"#/definitions/RevokeWorkspacePermissionDetails" } } }, "ManageCreateWorkspacePermissionDetails":{ "description":"Information to update permissions on a workspace.", "type":"object", "properties":{ "assignCreateWorkspacePermissionDetails":{ "$ref":"#/definitions/AssignCreateWorkspacePermissionDetails" }, "revokeCreateWorkspacePermissionDetails":{ "$ref":"#/definitions/RevokeCreateWorkspacePermissionDetails" } } }, "RecentResourceItem":{ "description":"The list of the recent resources accessed by a user\n", "type":"object", "properties":{ "workspaceKey":{ "type":"string", "description":"Key of the workspace. Null in the case of a global resource." }, "resourceType":{ "type":"string", "enum":[ "NOTEBOOK", "FILE", "CATALOG", "SCHEMA", "TABLE", "VOLUME", "JOB", "JOB_RUN", "LAKE_FLOW", "AGENT_LAKE_FLOW", "CLUSTER", "AI_COMPUTE", "FOLDER", "VOLUME_DIR", "VOLUME_FILE", "VIEW", "SHARE", "RECIPIENT", "EXTRACTOR", "AGENT_FLOW" ], "description":"Type of the resource." }, "resourceId":{ "type":"string", "description":"Unique identifier of the resource or path." }, "resourceName":{ "type":"string", "description":"Resource name associated with the resourceId field." }, "timeAccessed":{ "type":"string", "format":"date-time", "description":"Timestamp of when the resource was created, read, or updated." } } }, "RecentlyAccessed":{ "description":"The resources which were recently accessed by a user.\n", "type":"object", "required":[ "workspaceLevelResources", "globalLevelResources" ], "properties":{ "globalLevelResources":{ "type":"array", "items":{ "$ref":"#/definitions/RecentResourceItem" }, "description":"List of recent resources that are global, meaning not contained to workspace example catalog and its subresoruces." }, "workspaceLevelResources":{ "type":"array", "items":{ "$ref":"#/definitions/RecentResourceItem" }, "description":"List of recent resources that are contained in workspace, like clusters." } } }, "RecentlyAccessedResource":{ "description":"The resources which were recently accessed by a user.\n", "type":"object", "required":[ "lastAccessedWorkspaceKey", "lastAccessedWorkspaceDisplayName" ], "properties":{ "lastAccessedWorkspaceKey":{ "type":"string", "description":"Last active workspaceKey." }, "lastAccessedWorkspaceDisplayName":{ "type":"string", "description":"Last active workspace display name." } } }, "Scan":{ "type":"object", "description":"Single Client Access Name (SCAN) is the object with a fully-qualified domain name and a port number.", "properties":{ "fqdn":{ "description":"A fully-qualified domain name (FQDN).", "type":"string" }, "port":{ "description":"Port number of the FQDN.", "type":"string" } } }, "UpdateWorkspaceAsyncOperationStatusDetails":{ "description":"The data to update workspace async operation status.", "type":"object", "required":[ "state" ], "properties":{ "stateMessage":{ "description":"A descriptive message of the current state.", "type":"string" }, "state":{ "description":"Common lifecycle states for resources in a Compute Cluster:\nNETWORK_CONFIGURATION_CREATED - The network configuration has been created.\nNETWORK_CONFIGURATION_UPDATED - The network configuration has been updated.\nNETWORK_CONFIGURATION_DELETED - The network configuration has been deleted.\nNETWORK_CONFIGURATION_FAILED - The network configuration has been failed.\n", "type":"string", "enum":[ "NETWORK_CONFIGURATION_CREATED", "NETWORK_CONFIGURATION_UPDATED", "NETWORK_CONFIGURATION_DELETED", "NETWORK_CONFIGURATION_FAILED" ] }, "externalId":{ "description":"The external work-request-id if applicable.", "type":"string" }, "properties":{ "description":"The properties of operation on workspace.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "CreateGitFolderDetails":{ "description":"The data to create a Git folder in a workspace.", "type":"object", "required":[ "folderPath", "gitRepositoryUrl", "branchName", "credentialKey" ], "properties":{ "folderPath":{ "description":"The absolute path of the Git folder user wants to create.", "type":"string" }, "gitProviderKey":{ "description":"key corresponding to Git service provider in git provider table.", "type":"string", "default":"GIT" }, "gitRepositoryUrl":{ "description":"Git repository url used to clone.", "type":"string" }, "branchName":{ "description":"Git branch name that is cloned.", "type":"string" }, "credentialKey":{ "description":"Credential key of the stored git credentials.", "type":"string" }, "description":{ "description":"Short description about the git repository.", "type":"string" } } }, "GitFolder":{ "description":"Represents a Git folder object.", "type":"object", "required":[ "folderPath" ], "properties":{ "folderPath":{ "description":"The absolute path of the Git folder user wants to create.", "type":"string" }, "gitProviderKey":{ "description":"key corresponding to Git service provider in git provider table.", "type":"string", "default":"GIT" }, "gitRepositoryUrl":{ "description":"Git repository url used to clone.", "type":"string" }, "description":{ "description":"Short description about the git repository.", "type":"string" }, "branchName":{ "description":"Git branch name that is cloned.", "type":"string" }, "folderMetadata":{ "description":"The metadata about the folder, like branchName.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "NotifyClusterEventHandlerDetails":{ "description":"Notifier API during cluster patching.", "type":"object", "required":[ "clusterName" ], "properties":{ "clusterName":{ "description":"A unique name for the job cluster.", "type":"string", "minLength":1, "maxLength":100 }, "phase":{ "description":"Phase", "type":"string", "enum":[ "STARTED", "COMPLETED" ] }, "state":{ "description":"State of cluster.", "type":"string", "enum":[ "ACCEPTED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "STOPPING", "STOPPED", "UPDATING", "RESTARTING", "STARTING", "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS", "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL", "NETWORK_CONFIGURATION_ATTACH_FAILED", "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS", "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL", "NETWORK_CONFIGURATION_DETACH_FAILED" ] }, "clusterEvent":{ "$ref":"#/definitions/ClusterEvent" } } }, "ClusterEvent":{ "description":"Properties of a event provided by the cluster.", "type":"object", "discriminator":"type", "required":[ "type" ], "properties":{ "type":{ "description":"The type of the cluster event", "type":"string", "enum":[ "CLUSTER_PATCH_EVENT", "CLUSTER_EXECUTION_CONTEXT_AVAILABILITY_EVENT", "CLUSTER_STATE_EVENT" ] } } }, "ClusterPatchEvent":{ "type":"object", "description":"The information about the cluster patch event.", "allOf":[ { "$ref":"#/definitions/ClusterEvent" }, { "discriminator":"CLUSTER_PATCH_EVENT", "properties":{ "phase":{ "description":"Phase", "type":"string", "enum":[ "STARTED", "COMPLETED" ] }, "state":{ "description":"State of cluster.", "type":"string", "enum":[ "ACCEPTED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "STOPPING", "STOPPED", "UPDATING", "RESTARTING", "STARTING", "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS", "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL", "NETWORK_CONFIGURATION_ATTACH_FAILED", "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS", "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL", "NETWORK_CONFIGURATION_DETACH_FAILED" ] } } } ] }, "ClusterExecutionContextAvailabilityEvent":{ "type":"object", "description":"The information about the cluster execution context availability event.", "allOf":[ { "$ref":"#/definitions/ClusterEvent" }, { "discriminator":"CLUSTER_EXECUTION_CONTEXT_AVAILABILITY_EVENT", "required":[ "numberOfExecutionContexts" ], "properties":{ "numberOfExecutionContexts":{ "description":"Number of available execution contexts for this cluster.", "type":"integer", "format":"int32", "minimum":1 } } } ] }, "ClusterStateEvent":{ "type":"object", "description":"The information about the cluster state event. Workflow will use it to obtain the terminal state.", "allOf":[ { "$ref":"#/definitions/ClusterEvent" }, { "discriminator":"CLUSTER_STATE_EVENT", "properties":{ "state":{ "description":"State of cluster.", "type":"string", "enum":[ "ACCEPTED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "STOPPING", "STOPPED", "UPDATING", "RESTARTING", "STARTING", "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS", "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL", "NETWORK_CONFIGURATION_ATTACH_FAILED", "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS", "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL", "NETWORK_CONFIGURATION_DETACH_FAILED" ] } } } ] }, "GitConfig":{ "description":"Git configuration used when source is GIT_PROVIDER.", "type":"object", "properties":{ "provider":{ "description":"Git provider.", "type":"string", "enum":[ "GITHUB", "BITBUCKET", "GITLAB", "OCI_DEVOPS" ] }, "credential":{ "description":"Git credential to access the repository.", "type":"string" }, "repositoryUrl":{ "description":"Git repository URL.", "type":"string" }, "branch":{ "description":"Git branch path.", "type":"string" } } }, "Job":{ "description":"A description of a Job.\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n", "type":"object", "required":[ "key", "createdBy", "name" ], "properties":{ "key":{ "description":"The OCID of the job.", "type":"string" }, "createdBy":{ "description":"The OCID of the IAM user.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record", "type":"string" }, "updatedBy":{ "description":"The username of the latest updater. The OCID of the IAM user.", "type":"string" }, "updatedByName":{ "description":"Name of the user who updated this record.", "type":"string" }, "runAs":{ "description":"The id with which the job run as.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "description":{ "description":"A description for the job.", "type":"string", "maxLength":1024 }, "schedule":{ "$ref":"#/definitions/Schedule" }, "continuous":{ "$ref":"#/definitions/Continuous" }, "maxConcurrentRuns":{ "description":"Indicates the number of executions for the same job that can be run concurrently. The maximum value cannot exceed 1000.", "type":"integer", "format":"int32", "minimum":0, "maximum":1000, "default":1 }, "gitConfig":{ "$ref":"#/definitions/GitConfig" }, "queue":{ "$ref":"#/definitions/Queue" }, "path":{ "description":"The path to store the job definition in.", "type":"string" }, "jobClusters":{ "description":"List of job cluster configurations.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/JobCluster" } }, "tasks":{ "description":"List of tasks in a job.", "type":"array", "items":{ "$ref":"#/definitions/Task" } }, "timeCreated":{ "description":"The date and time the DataLake was created, in the format defined by RFC 3339.\nExample: `2025-05-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the DataLake was updated, in the format defined by RFC 3339.\nExample: `2025-05-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 } } }, "CreateJobDetails":{ "description":"The data to create a job.", "type":"object", "required":[ "name" ], "properties":{ "runAs":{ "description":"The id with which the job run as.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "description":{ "description":"A description for the job.", "type":"string", "maxLength":1024 }, "schedule":{ "$ref":"#/definitions/Schedule" }, "continuous":{ "$ref":"#/definitions/Continuous" }, "maxConcurrentRuns":{ "description":"Indicates the number of executions for the same job that can be run concurrently. The maximum value cannot exceed 1000.", "type":"integer", "format":"int32", "minimum":0, "maximum":1000, "default":1 }, "gitConfig":{ "$ref":"#/definitions/GitConfig" }, "queue":{ "$ref":"#/definitions/Queue" }, "jobClusters":{ "description":"List of job cluster configurations.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/JobCluster" } }, "path":{ "description":"The path to store the job definition in.", "type":"string" }, "tasks":{ "description":"List of tasks in a job.", "type":"array", "items":{ "$ref":"#/definitions/Task" } }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 } } }, "UpdateJobDetails":{ "description":"The data to update a job.", "type":"object", "required":[ "name" ], "properties":{ "runAs":{ "description":"The id with which the job run as.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "description":{ "description":"A description for the job.", "type":"string", "maxLength":1024 }, "schedule":{ "$ref":"#/definitions/Schedule" }, "continuous":{ "$ref":"#/definitions/Continuous" }, "maxConcurrentRuns":{ "description":"Indicates the number of executions for the same job that can be run concurrently. The maximum value cannot exceed 1000.", "type":"integer", "format":"int32", "minimum":0, "maximum":1000, "default":1 }, "gitConfig":{ "$ref":"#/definitions/GitConfig" }, "queue":{ "$ref":"#/definitions/Queue" }, "jobClusters":{ "description":"List of job cluster configurations.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/JobCluster" } }, "path":{ "description":"The path to store the job definition in.", "type":"string" }, "tasks":{ "description":"List of tasks in a job.", "type":"array", "items":{ "$ref":"#/definitions/Task" } }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 } } }, "Schedule":{ "description":"The schedule configuration for the job.", "type":"object", "required":[ "quartzCronExpression", "timezoneId" ], "properties":{ "quartzCronExpression":{ "description":"A cron expression using Quartz syntax that describes the schedule for a job.", "type":"string" }, "timezoneId":{ "description":"A Java timezone ID. The schedule of the job is resolved with respect to this timezone. Example - US/Pacific.", "type":"string" }, "pauseStatus":{ "description":"Indicates whether the schedule is paused or not.", "type":"string", "enum":[ "PAUSED", "UNPAUSED" ], "default":"UNPAUSED" } } }, "Continuous":{ "description":"The continuous property ensures that there is always one execution for this job.", "type":"object", "properties":{ "pauseStatus":{ "description":"Indicates whether the continuous execution of this job is paused or not.", "type":"string", "enum":[ "PAUSED", "UNPAUSED" ], "default":"UNPAUSED" } } }, "JobCluster":{ "description":"The cluster configuration that can be shared by tasks in the job.", "type":"object", "properties":{ "clusterKey":{ "description":"A unique identifier for the job cluster.", "type":"string", "minLength":1, "maxLength":100 }, "clusterName":{ "description":"A unique name for the job cluster.", "type":"string", "minLength":1, "maxLength":100 }, "newCluster":{ "$ref":"#/definitions/NewClusterConfiguration" } } }, "NewClusterConfiguration":{ "description":"The cluster configuration to create a new cluster.", "type":"object", "properties":{ "numWorkers":{ "description":"Number of worker nodes configured for this cluster.", "type":"integer", "format":"int32" }, "autoScale":{ "$ref":"#/definitions/AutoScale" }, "clusterName":{ "description":"A unique name for the job cluster.", "type":"string", "minLength":1, "maxLength":100 }, "sparkVersion":{ "description":"The Spark version used to run the application.", "type":"string" }, "sparkConf":{ "description":"The spark configuration in key-value pairs.", "type":"string" } } }, "AutoScale":{ "description":"Properties required to automatically scale the clusters up and down based on load.", "type":"object", "properties":{ "minWorkers":{ "description":"The minimum number of workers to which the cluster can scale down when underused.", "type":"integer", "format":"int32" }, "maxWorkers":{ "description":"The maximum number of workers to which the cluster can scale up when overloaded.", "type":"integer", "format":"int32" } } }, "Task":{ "description":"Properties of a task provided by the user.", "type":"object", "discriminator":"type", "required":[ "type", "taskKey", "runIf" ], "properties":{ "type":{ "description":"The type of the task.", "type":"string", "enum":[ "NOTEBOOK_TASK", "PYTHON_TASK", "SPARK_SUBMIT_TASK", "IF_ELSE_TASK", "JOB_TASK", "JAR_TASK" ] }, "taskKey":{ "description":"The display name of the task. User can specify a value for this.", "minLength":1, "maxLength":100, "type":"string" }, "dependsOn":{ "description":"Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.", "type":"array", "items":{ "$ref":"#/definitions/DependsOn" } }, "runIf":{ "description":"The trigger rule based on which the current task execution is determined.", "type":"string", "enum":[ "ALL_SUCCESS", "ALL_DONE", "NONE_FAILED", "AT_LEAST_ONE_SUCCESS", "ALL_FAILED", "AT_LEAST_ONE_FAILED" ], "default":"ALL_SUCCESS" }, "maxRetries":{ "description":"The maximum number of times to retry an unsuccessful run. \nA run is considered to be unsuccessful if it fails with status FAILED or INTERNAL_ERROR. Maximum value is 300.\n", "type":"integer", "format":"int32", "minimum":0, "maximum":300, "default":0 }, "minRetryIntervalMillis":{ "description":"An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. \nIf value is not provided, the run would be immediately retried. Maximum value is 10 mins (600000)\n", "type":"integer", "format":"int32", "minimum":0, "default":0, "maximum":600000 }, "isRetryOnTimeout":{ "description":"An optional policy to specify whether to retry a task when it times out. The default behavior is to not retry on timeout.", "type":"boolean", "default":false } } }, "NotebookTask":{ "type":"object", "description":"The information about the notebook task.", "allOf":[ { "$ref":"#/definitions/Task" }, { "discriminator":"NOTEBOOK_TASK", "required":[ "cluster", "notebookPath" ], "properties":{ "notebookPath":{ "description":"The path where the notebook exists.", "type":"string" }, "source":{ "description":"Source selected for a task. Either workspace or Git provider.", "type":"string", "enum":[ "WORKSPACE", "GIT_PROVIDER" ], "default":"WORKSPACE" }, "gitConfig":{ "$ref":"#/definitions/GitConfig" }, "cluster":{ "$ref":"#/definitions/JobCluster" }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 }, "isStreaming":{ "description":"An optional property to enable or disable the streaming capability for a task.", "type":"boolean", "default":false } } } ] }, "PythonTask":{ "type":"object", "description":"The information about the Notebook task.", "allOf":[ { "$ref":"#/definitions/Task" }, { "discriminator":"PYTHON_TASK", "required":[ "cluster", "filePath" ], "properties":{ "filePath":{ "description":"The path where the Python file exists.", "type":"string" }, "source":{ "description":"Source selected for a task. Either workspace or Git provider.", "type":"string", "enum":[ "WORKSPACE", "GIT_PROVIDER" ], "default":"WORKSPACE" }, "gitConfig":{ "$ref":"#/definitions/GitConfig" }, "cluster":{ "$ref":"#/definitions/JobCluster" }, "commandLineArguments":{ "description":"The command line arguments to pass to Python task.", "type":"string" }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 }, "isStreaming":{ "description":"An optional property to enable or disable the streaming capability for a task.", "type":"boolean", "default":false } } } ] }, "IfElseTask":{ "type":"object", "description":"The information about the If Else task.", "allOf":[ { "$ref":"#/definitions/Task" }, { "discriminator":"IF_ELSE_TASK", "required":[ "expressions", "condition" ], "properties":{ "expressions":{ "description":"List of expressions.", "type":"array", "items":{ "$ref":"#/definitions/Expression" } }, "condition":{ "description":"The condition string which binds expressions from expressions list using AND, OR or NOT operator. Expression key should be used to bind the expressions.", "type":"string" }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } } } } ] }, "JobTask":{ "type":"object", "description":"The information about the job task.", "allOf":[ { "$ref":"#/definitions/Task" }, { "discriminator":"JOB_TASK", "required":[ "jobKey" ], "properties":{ "jobKey":{ "description":"The OCID of the job.", "type":"string" }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 } } } ] }, "JarTask":{ "type":"object", "description":"The information about the Jar task.", "allOf":[ { "$ref":"#/definitions/Task" }, { "discriminator":"JAR_TASK", "required":[ "cluster", "mainClass" ], "properties":{ "mainClass":{ "description":"Name of the main class.", "type":"string" }, "dependentLibraries":{ "description":"The list of dependent jars", "type":"array", "items":{ "type":"string" } }, "source":{ "description":"Source selected for a task. Either workspace or Git provider.", "type":"string", "enum":[ "WORKSPACE", "GIT_PROVIDER" ], "default":"WORKSPACE" }, "gitConfig":{ "$ref":"#/definitions/GitConfig" }, "cluster":{ "$ref":"#/definitions/JobCluster" }, "commandLineArguments":{ "description":"The command line arguments to pass to Python task.", "type":"string" }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 }, "isStreaming":{ "description":"An optional property to enable or disable the streaming capability for a task.", "type":"boolean", "default":false } } } ] }, "Expression":{ "description":"Map of expressions with key as unique string and value as single expression.", "type":"object", "required":[ "key", "value" ], "properties":{ "key":{ "description":"A unique character to map the expression. This character is used to refer the expression string in condition field of the task. May only contain alphanumeric characters.", "type":"string", "minLength":1, "maxLength":1, "pattern":"^[A-Za-z0-9]+$" }, "value":{ "description":"Expression string.", "type":"string" } } }, "DependsOn":{ "description":"Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.", "type":"object", "required":[ "taskKey" ], "properties":{ "taskKey":{ "description":"The name of the task that it depends on.", "type":"string" }, "outcome":{ "description":"Specified on condition task dependencies. The outcome of the dependent task should be met for this task to be executed.", "type":"string" } } }, "Parameter":{ "description":"Specifies the name and value of the defined parameter.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"The name of the defined parameter. May only contain alphanumeric characters, '_', '-', and '.'", "type":"string", "pattern":"^[\\w\\-.]+$" }, "value":{ "description":"Value of the defined parameter.", "type":"string" } } }, "OutputParameter":{ "description":"Specifies the name and value of the output parameter.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"The name of the parameter defined by user.", "type":"string" }, "value":{ "description":"Value of the output parameter.", "type":"string" } } }, "JobCollection":{ "description":"List of jobs.", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"List of jobs.", "type":"array", "items":{ "$ref":"#/definitions/JobSummary" } } } }, "JobSummary":{ "description":"Summary information about a job.", "type":"object", "required":[ "key" ], "properties":{ "key":{ "description":"The OCID of the job.", "type":"string" }, "createdBy":{ "description":"The OCID of the IAM user.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record", "type":"string" }, "updatedBy":{ "description":"The OCID of the IAM user.", "type":"string" }, "updatedByName":{ "description":"The username of the latest updater.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "path":{ "description":"The path to store the job definition in.", "type":"string" }, "schedule":{ "$ref":"#/definitions/Schedule" }, "runAs":{ "description":"The id with which the job run as.", "type":"string" }, "timeCreated":{ "description":"The date and time the DataLake was created, in the format defined by RFC 3339.\nExample: `2025-05-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the DataLake was updated, in the format defined by RFC 3339.\nExample: `2025-05-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "clusters":{ "description":"List of job cluster keys.", "type":"array", "items":{ "type":"string" } }, "jobClusters":{ "description":"List of job cluster configurations.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/JobCluster" } } } }, "JobRunCollection":{ "description":"List of job runs.", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"List of job runs.", "type":"array", "items":{ "$ref":"#/definitions/JobRunSummary" } } } }, "JobRun":{ "description":"Description of a job run.", "type":"object", "required":[ "key", "name", "jobKey" ], "properties":{ "key":{ "description":"The OCID of the job.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "jobKey":{ "description":"The OCID of the job.", "type":"string" }, "jobName":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "parentJobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "rootJobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "parentTaskRunKey":{ "description":"The OCID of the task run.", "type":"string" }, "tasks":{ "description":"List of tasks in a job.", "type":"array", "items":{ "$ref":"#/definitions/Task" } }, "createdBy":{ "description":"The OCID of the IAM user.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record", "type":"string" }, "maxConcurrentRuns":{ "description":"Indicates the number of executions for the same job that can be run concurrently. The maximum value cannot exceed 1000.", "type":"integer", "format":"int32", "minimum":0, "maximum":1000, "default":1 }, "gitConfig":{ "$ref":"#/definitions/GitConfig" }, "queue":{ "$ref":"#/definitions/Queue" }, "originalAttemptRunId":{ "description":"The OCID of the job.", "type":"string" }, "state":{ "$ref":"#/definitions/State" }, "schedule":{ "$ref":"#/definitions/Schedule" }, "clusterSpec":{ "$ref":"#/definitions/ClusterSpec" }, "clusterInstance":{ "$ref":"#/definitions/ClusterInstance" }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "unifiedJobAndJobRunParameters":{ "description":"Unified List of job and job run parameters after resolving dynamic value references and parameter resolution as per precedence.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "repairHistory":{ "description":"Array of repaired runs.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/RepairHistory" } }, "systemParameters":{ "description":"Map of system parameters with their values for this job run.", "type":"object", "additionalProperties":{ "type":"string" } }, "startTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "setupDuration":{ "description":"The time (in milliseconds) taken to setup the cluster.", "type":"integer", "format":"int64" }, "executionDuration":{ "description":"The time (in milliseconds) taken to complete the job execution.", "type":"integer", "format":"int64" }, "cleanupDuration":{ "description":"The time (in milliseconds) taken to terminate the cluster and to clean up any associated artifacts.", "type":"integer", "format":"int64" }, "runDuration":{ "description":"The time (in milliseconds) taken to complete the job execution and all its repairs to finish.", "type":"integer", "format":"int64" }, "timeCreated":{ "description":"The time at which the job execution started.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time at which the job execution was updated.", "type":"string", "format":"date-time" }, "launched":{ "description":"Identify job run launched by schedule or manually.", "type":"string", "enum":[ "SCHEDULED", "MANUAL" ], "default":"MANUAL" }, "version":{ "description":"Current version of job run object in repository.", "type":"integer", "format":"int32" }, "taskToTaskRunMap":{ "description":"Task to TaskRun map for given job run.", "type":"object", "additionalProperties":{ "type":"string" } }, "taskRunSummaryMap":{ "description":"TaskRun to TaskRunSummary map for given job run.", "type":"object", "additionalProperties":{ "type":"object" } }, "timeoutSeconds":{ "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.", "type":"integer", "format":"int32", "minimum":60, "maximum":172800, "default":0 }, "repairedTasks":{ "type":"array", "description":"A list of repaired tasks.", "items":{ "type":"string" } }, "lifecycleStates":{ "type":"array", "description":"The collection of lifecycle states.", "items":{ "$ref":"#/definitions/LifecycleState" } } } }, "JobRunSummary":{ "description":"Summary information about a job run.", "type":"object", "required":[ "key" ], "properties":{ "key":{ "description":"The OCID of the job run.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "state":{ "$ref":"#/definitions/State" }, "jobKey":{ "description":"The OCID of the job.", "type":"string" }, "jobName":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "executionDuration":{ "description":"The time (in milliseconds) taken to complete the job execution.", "type":"integer", "format":"int64" }, "launched":{ "description":"Identify job run launched by schedule or manually.", "type":"string", "enum":[ "SCHEDULED", "MANUAL" ], "default":"MANUAL" }, "startTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "timeCreated":{ "description":"The time at which the job execution started.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time at which the job execution was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The user who triggered the job execution.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record", "type":"string" } } }, "CreateJobRunDetails":{ "description":"The data to create a job run.", "type":"object", "required":[ "jobKey" ], "properties":{ "key":{ "description":"The OCID of the job.", "type":"string" }, "jobKey":{ "description":"The OCID of the job.", "type":"string" }, "originalAttemptRunId":{ "description":"The OCID of the job.", "type":"string" }, "schedule":{ "$ref":"#/definitions/Schedule" }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "queue":{ "$ref":"#/definitions/Queue" }, "repairHistory":{ "description":"Array of repaired runs.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/RepairHistory" } } } }, "RepairJobRunDetails":{ "description":"The data to repair a job run.", "type":"object", "required":[ "taskKeys" ], "properties":{ "taskKeys":{ "type":"array", "description":"The collection of selected task IDs to be repaired.", "items":{ "type":"string" } }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } } } }, "RepairHistory":{ "description":"A description of a repaired job run.", "properties":{ "type":{ "description":"Indicates whether the job run is Original or Repaired.", "type":"string", "enum":[ "ORIGINAL", "REPAIR" ] }, "key":{ "description":"The unique ID of the Repair run.", "type":"integer", "format":"int32" }, "state":{ "$ref":"#/definitions/State" }, "startTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "taskToTaskRunMap":{ "description":"Task to TaskRun map for given job run.", "type":"object", "additionalProperties":{ "type":"string" } }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "repairedTasks":{ "type":"array", "description":"A list of repaired tasks.", "items":{ "type":"string" } }, "lifecycleStates":{ "type":"array", "description":"The collection of lifecycle states.", "items":{ "$ref":"#/definitions/LifecycleState" } }, "executionDuration":{ "description":"The time (in milliseconds) taken to complete the job execution.", "type":"integer", "format":"int64" } } }, "State":{ "description":"The current state of the run.", "type":"object", "properties":{ "status":{ "description":"Current state of execution.", "type":"string", "enum":[ "PENDING", "QUEUED", "RUNNING", "SKIPPED", "INTERNAL_ERROR", "BLOCKED", "SUCCESS", "FAILED", "CANCELING", "CANCELED", "UPSTREAM_CANCELED", "UPSTREAM_FAILED", "EXCLUDED", "TIMED_OUT", "PAUSED_MAINTENANCE" ] }, "stateMessage":{ "description":"A descriptive message of the current state.", "type":"string" }, "errorTrace":{ "description":"If there was an error executing the run, this field contains any available stack traces.", "type":"string" }, "isUserCanceledOrTimedOut":{ "description":"Set to true, if the job execution is canceled by the user or by the scheduler due to timeout.", "type":"boolean", "default":false } } }, "LifecycleState":{ "description":"The lifecycle state of execution.", "type":"object", "allOf":[ { "$ref":"#/definitions/State" }, { "type":"object" }, { "properties":{ "startTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" } } } ] }, "ClusterSpec":{ "description":"Cluster specification snapshot of a job.", "type":"object", "properties":{ "existingClusterKey":{ "description":"The key of the cluster.", "type":"string" }, "newCluster":{ "$ref":"#/definitions/NewClusterConfiguration" }, "libraries":{ "$ref":"#/definitions/Libraries" } } }, "AirflowCellConfig":{ "description":"The airflow cell ID and the URL.", "type":"object", "properties":{ "cellId":{ "description":"The airflow cell ID.", "type":"string" }, "cellUrl":{ "description":"The airflow cell URL.", "type":"string" } } }, "Libraries":{ "description":"List of libraries to be installed on the cluster.", "type":"object", "properties":{ "jar":{ "description":"URI of the jar to be installed.", "type":"string" } } }, "ClusterInstance":{ "description":"The cluster used for this run.\nThe value of this field will be set when a new cluster is specified for execution and once the request to create a new cluster is successfully submitted.\n", "type":"object", "properties":{ "clusterKey":{ "description":"The cluster key for the cluster configuration on which the job is executed.", "type":"string" }, "sparkContextKey":{ "description":"The spark context used in the job run.", "type":"string" } } }, "TaskRun":{ "description":"A description of a task run.", "type":"object", "required":[ "key", "name" ], "properties":{ "key":{ "description":"The OCID of the task run.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "taskKey":{ "description":"The display name of the task. User can specify a value for this.", "minLength":1, "maxLength":100, "type":"string" }, "jobKey":{ "description":"The OCID of the job.", "type":"string" }, "jobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "parentJobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "rootJobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "clusterValidationStartTime":{ "description":"The time at which the cluster validation started in epoch milliseconds.", "type":"integer", "format":"int64" }, "startTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "state":{ "$ref":"#/definitions/State" }, "setupDuration":{ "description":"The time (in milliseconds) taken to setup the cluster.", "type":"integer", "format":"int64" }, "executionDuration":{ "description":"The time (in milliseconds) taken to complete the job execution.", "type":"integer", "format":"int64" }, "cleanupDuration":{ "description":"The time (in milliseconds) taken to terminate the cluster and to clean up any associated artifacts.", "type":"integer", "format":"int64" }, "clusterSpec":{ "$ref":"#/definitions/ClusterSpec" }, "task":{ "$ref":"#/definitions/Task" }, "version":{ "description":"Current version of job run object in repository.", "type":"integer", "format":"int32" }, "retryAttempt":{ "description":"Sequence number of the current retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.", "type":"integer", "format":"int32" }, "retries":{ "description":"List of task retries.", "type":"array", "items":{ "$ref":"#/definitions/TaskRunRetry" } }, "outputKey":{ "description":"A unique identifier for the output.", "type":"string", "minLength":1, "maxLength":100 }, "externalId":{ "description":"The external ID of the task execution.", "type":"string" }, "systemParameters":{ "description":"Map of system parameters with their values for this job run.", "type":"object", "additionalProperties":{ "type":"string" } }, "parameters":{ "description":"An optional list of parameters.", "type":"array", "items":{ "$ref":"#/definitions/Parameter" } }, "lifecycleStates":{ "type":"array", "description":"The collection of lifecycle states.", "items":{ "$ref":"#/definitions/LifecycleState" } } } }, "TaskRunRetry":{ "description":"Representation of a task run retry. Maximum of 10 retries are allowed.", "properties":{ "startTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "clusterValidationStartTime":{ "description":"The time at which the cluster validation started in epoch milliseconds.", "type":"integer", "format":"int64" }, "state":{ "$ref":"#/definitions/State" }, "setupDuration":{ "description":"The time (in milliseconds) taken to setup the cluster.", "type":"integer", "format":"int64" }, "executionDuration":{ "description":"The time (in milliseconds) taken to complete the job execution.", "type":"integer", "format":"int64" }, "cleanupDuration":{ "description":"The time (in milliseconds) taken to terminate the cluster and to clean up any associated artifacts.", "type":"integer", "format":"int64" }, "outputKey":{ "description":"A unique identifier for the output.", "type":"string", "minLength":1, "maxLength":100 }, "externalId":{ "description":"The external ID of the task execution.", "type":"string" }, "retryNumber":{ "description":"Sequence number of the retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.", "type":"integer", "format":"int32" } } }, "TaskRunOutput":{ "description":"Output of a task run.", "type":"object", "required":[ "data" ], "properties":{ "key":{ "description":"A unique identifier for the output.", "type":"string", "minLength":1, "maxLength":100 }, "taskType":{ "description":"The type of the task.", "type":"string", "enum":[ "NOTEBOOK_TASK", "PYTHON_TASK", "SPARK_SUBMIT_TASK", "IF_ELSE_TASK", "JOB_TASK", "JAR_TASK" ] }, "isTruncated":{ "description":"True if logs are truncated.", "type":"boolean", "default":false }, "errorTrace":{ "description":"If there was an error executing the run, this field contains any available stack traces.", "type":"string" }, "data":{ "type":"array", "description":"Array of output objects.", "items":{ "$ref":"#/definitions/RunOutputData" } }, "outputParameters":{ "description":"List of output parameters with name and values.", "type":"array", "items":{ "$ref":"#/definitions/OutputParameter" } }, "version":{ "description":"Current version of job run object in repository.", "type":"integer", "format":"int32" } } }, "ExportTaskRunOutputDetails":{ "description":"Payload required to export task run output content to a file.", "type":"object", "properties":{ "format":{ "description":"The format in which task run output should be exported, supported formats are HTML and ipynb only.", "type":"string", "default":"HTML", "enum":[ "HTML", "IPYNB" ] } } }, "ExportedTaskRunOutputContents":{ "description":"This model represents a file with contents, format, and other details.\n", "type":"object", "required":[ "name", "path", "content", "format" ], "properties":{ "name":{ "description":"Name of file, equivalent to the last part of the path.", "type":"string" }, "path":{ "description":"Full path of the file.", "type":"string" }, "content":{ "description":"For ipynb format, this contains a string representing the .ipynb file.\nFor HTML format, this contains a string representing the HTML page. It has base64-encoded data for images.\n", "type":"object" }, "format":{ "description":"Format of content as requested by the client. HTML format by default.\n", "type":"string", "enum":[ "HTML", "IPYNB" ] } } }, "RunOutputData":{ "type":"object", "description":"An object representing execution output of a command.\n", "required":[ "type" ], "properties":{ "type":{ "description":"The type of the RunOutputData. For example, `TEXT_PLAIN`, `TEXT_HTML`, or `IMAGE`.\n", "type":"string", "enum":[ "TEXT_PLAIN", "NOTEBOOK", "TEXT_HTML", "IMAGE_PNG", "IMAGE_SVG", "IMAGE_JPEG", "APPLICATION_PDF", "APPLICATION_JSON", "FILE_PATH", "NOTEBOOK_PATH" ] }, "length":{ "description":"Size of object in bytes.", "type":"string" }, "charset":{ "description":"Charset of the result.", "type":"string", "enum":[ "UTF_8", "UTF_16" ] }, "isBase64":{ "description":"Boolean to identify if output data is base64-encoded.", "type":"boolean" }, "compression":{ "description":"Content-Encoding or compression", "type":"string", "enum":[ "GZIP", "DEFLATE", "COMPRESS", "BZIP2" ] }, "value":{ "description":"The output content string format.", "type":"string" } } }, "Queue":{ "description":"Queue configuration for job.", "type":"object", "required":[ "isEnabled" ], "properties":{ "isEnabled":{ "description":"True if job queue is enabled.", "type":"boolean", "default":false } } }, "FetchOutputDetails":{ "description":"The payload to fetch TaskRunOutput.", "type":"object", "properties":{ "outputKey":{ "description":"A unique identifier for the output.", "type":"string", "minLength":1, "maxLength":100 } } }, "TaskExecutionResult":{ "description":"Task run execution result.", "type":"object", "required":[ "state" ], "properties":{ "state":{ "$ref":"#/definitions/State" }, "startTimeMillis":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTimeMillis":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "externalId":{ "description":"The external ID of the task execution.", "type":"string" }, "metrics":{ "description":"The metrics of the task execution.", "type":"object", "additionalProperties":{ "type":"string" } }, "properties":{ "description":"The properties of the task execution.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "TaskRunCollection":{ "description":"List of TaskRuns.", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"List of TaskRuns.", "type":"array", "items":{ "$ref":"#/definitions/TaskRunSummary" } } } }, "TaskRunSummary":{ "description":"Summary information about a TaskRun.", "type":"object", "properties":{ "key":{ "description":"The OCID of the TaskRun.", "type":"string" }, "name":{ "description":"A user-friendly name. Does not have to be unique, and is changeable.", "type":"string" }, "taskKey":{ "description":"The display name of the task. User can specify a value for this.", "minLength":1, "maxLength":100, "type":"string" }, "jobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "parentJobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "rootJobRunKey":{ "description":"The OCID of the job.", "type":"string" }, "clusterValidationStartTime":{ "description":"The time at which the cluster validation started in epoch milliseconds.", "type":"integer", "format":"int64" }, "startTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "endTime":{ "description":"The time at which the job execution started in epoch milliseconds.", "type":"integer", "format":"int64" }, "state":{ "$ref":"#/definitions/State" }, "externalId":{ "description":"The external ID of the task execution.", "type":"string" }, "retryAttempt":{ "description":"Sequence number of the current retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.", "type":"integer", "format":"int32" } } }, "JobPrivilege":{ "description":"The privilege for a job.", "type":"string", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] }, "JobPermissionCollection":{ "type":"object", "description":"List of job permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of job permissions.", "type":"array", "items":{ "$ref":"#/definitions/JobPermissionSummary" } } } }, "JobPermissionSummary":{ "description":"Information about a job permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a Job.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/JobPrivilege", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] } } } }, "AssignJobPermissionDetails":{ "description":"The details of the permissions assigned on the Job to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permission assigned to the assignee as per the index of assignee. This list should be same size as assignees list.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/JobPrivilege", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] } } } }, "RevokeJobPermissionDetails":{ "description":"The details of the permissions revoked from assignees for a job.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permission revoked from the assignee as per the index of assignee. This list should be same size as assignees list.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/JobPrivilege", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] } } } }, "ManageJobPermissionDetails":{ "description":"Information to update permissions on a job.", "type":"object", "properties":{ "assignJobPermissionDetails":{ "$ref":"#/definitions/AssignJobPermissionDetails" }, "revokeJobPermissionDetails":{ "$ref":"#/definitions/RevokeJobPermissionDetails" } } }, "Dependency":{ "description":"Base class for all dependencies, including files, compute resources, and nested jobs.", "type":"object", "discriminator":"type", "required":[ "type" ], "properties":{ "type":{ "description":"The type of the dependency.", "type":"string", "enum":[ "FILE", "COMPUTE", "JOB" ] } } }, "FileDependency":{ "description":"File dependency. Represents a file or library.", "type":"object", "allOf":[ { "$ref":"#/definitions/Dependency" }, { "discriminator":"FILE", "properties":{ "path":{ "type":"string", "description":"File path or library name." } } } ] }, "ComputeDependency":{ "description":"Compute dependency. Represents a compute cluster resource.", "type":"object", "allOf":[ { "$ref":"#/definitions/Dependency" }, { "discriminator":"COMPUTE", "required":[ "key" ], "properties":{ "key":{ "type":"string", "description":"Unique identifier for compute resource." } } } ] }, "JobDependency":{ "description":"Job dependency. Represents a job with its dependencies. Can be used for both root jobs and nested jobs.", "type":"object", "allOf":[ { "$ref":"#/definitions/Dependency" }, { "discriminator":"JOB", "required":[ "key", "dependencies" ], "properties":{ "key":{ "type":"string", "description":"Unique identifier for the job." }, "dependencies":{ "type":"array", "description":"List of dependencies for this job.", "items":{ "$ref":"#/definitions/Dependency" } } } } ] }, "ClusterType":{ "description":"Cluster type. USER for clusters associated with workspace and created by users.", "type":"string", "default":"USER", "enum":[ "USER", "AGENT_FLOW_COMPUTE" ] }, "Cluster":{ "description":"A Cluster is a compute subresource within AI Data Platform Workbench. Compute/Runtime Clusters are Spark execution environments. \nSpark clusters are used for Notebook execution and for Spark SQL query execution over JDBC/ODBC. \nThese clusters seamlessly process the data in the AI Data Platform Workbench. Users can also use JDBC/ODBC endpoints for highly \nperformant SQL execution for integration with analytics tools such as Oracle Analytic Cloud and Excel.\nA DEFAULT cluster is a subresource within AI Data Platform Workbench associated with master catalog and it can not be\nattached to a notebook. A USER cluster is a subresource within workspace and can be attached to a notebook.\n", "type":"object", "required":[ "key", "state", "timeCreated", "displayName" ], "discriminator":"sourceApi", "properties":{ "key":{ "description":"Cluster key.", "type":"string" }, "displayName":{ "description":"Cluster name.", "type":"string" }, "description":{ "description":"Cluster description.", "type":"string", "minLength":1, "maxLength":400 }, "sourceApi":{ "description":"User created clusters are associated with a particular workspace. Default cluster is to\nbe used by all catalogs operations that require compute. Default cluster can be thought of as\nassociated with Master catalog. Agent Flow Compute is used to execute Agent Flows.\n", "type":"string", "default":"CLUSTER_API", "enum":[ "CLUSTER_API", "DEFAULT_CLUSTER_API", "AGENT_FLOW_COMPUTE" ] }, "type":{ "type":"string", "description":"ClusterType", "x-obmcs-top-level-enum":"#/definitions/ClusterType", "enum":[ "USER", "AGENT_FLOW_COMPUTE" ] }, "timeCreated":{ "description":"Date and time the cluster was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Date and time the cluster was updated.", "type":"string", "format":"date-time" }, "state":{ "description":"Common lifecycle states for resources in a compute cluster.\nACCEPTED - The resource create request has been accepted.\nCREATING - The resource is being created and might not be usable until the entire metadata is defined.\nACTIVE - The resource is valid and available for access.\nDELETING - The resource is being deleted, and might require a deep clean of any children.\nDELETED - The resource has been deleted, and isn't available.\nFAILED - The resource is in a failed state due to validation or other errors.\nSTOPPING - The resource is being stopped.\nSTOPPED - The resource has been stopped.\nUPDATING - The resource is being updated and might not be usable until all changes are commited.\nSTARTING - The resource is being started.\nRESTARTING - The resource is being restarted.\n", "type":"string", "enum":[ "ACCEPTED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "STOPPING", "STOPPED", "UPDATING", "RESTARTING", "STARTING", "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS", "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL", "NETWORK_CONFIGURATION_ATTACH_FAILED", "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS", "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL", "NETWORK_CONFIGURATION_DETACH_FAILED" ] }, "stateDetails":{ "description":"A message that describes the current state of the workspace cluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state.", "type":"string" }, "nodeType":{ "description":"Cluster node type encodes the node shape and associated resources.", "type":"string", "minLength":1, "maxLength":255 }, "driverConfig":{ "$ref":"#/definitions/DriverConfig" }, "activeClusterResources":{ "$ref":"#/definitions/ActiveClusterResources" }, "createdBy":{ "description":"OCID of the user who created this record.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record.", "type":"string" }, "updatedBy":{ "description":"OCID of the user who updated this record.", "type":"string" }, "updatedByName":{ "description":"Name of the user who updated this record.", "type":"string" }, "stoppedBy":{ "description":"OCID of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.", "type":"string" }, "stoppedByName":{ "description":"Name of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.", "type":"string" } } }, "SparkCluster":{ "type":"object", "description":"User-created cluster.", "allOf":[ { "$ref":"#/definitions/Cluster" }, { "discriminator":"CLUSTER_API", "properties":{ "workerConfig":{ "$ref":"#/definitions/WorkerConfig" }, "clusterRuntimeConfig":{ "$ref":"#/definitions/ClusterRuntimeConfig" }, "loggingConfig":{ "$ref":"#/definitions/LoggingConfig" }, "autoTerminationMinutes":{ "type":"integer", "format":"int32", "default":null, "x-default-description":"When no value is set, the cluster is not auto-stopped.", "description":"Optional timeout value in minutes used to automatically stop idle compute clusters.", "minimum":5, "maximum":59940 }, "attachedNotebooks":{ "type":"array", "description":"List of notebooks attached to a specific cluster.", "items":{ "type":"string" } }, "attachedSessions":{ "type":"array", "description":"List of sessions attached to a specific cluster.", "items":{ "$ref":"#/definitions/AttachedSession" } }, "attachedAgentFlowCount":{ "type":"integer", "default":null, "description":"Count of agent flow attached to a specific cluster." }, "jdbcEndpointUrl":{ "description":"Spark JDBC URL.", "type":"string" }, "logId":{ "type":"string", "description":"The OCID of the log where cluster logs are published and retrieved. This logId is always created within the logGroupId returned in the response payload.\n", "example":"ocid1.log.oc1.phx.amaaaaaaeq37tyqau2j7ug7xnlhtwiubbinfhiuc2fatgwtzt3s3flivchma" }, "logGroupId":{ "type":"string", "description":"The unique OCID that identifies a specific log group within OCI Logging.\nThis log group is exclusively associated with the AI Data Platform Workbench instance and is created in the same compartment within the customer???s tenancy as the AI Data Platform Workbench instance.\n", "example":"ocid1.loggroup.oc1.phx.amaaaaaaeq37tyqau3s5k4zp7gimmao3duxdy2y2j5x3lutjdhggjwzb7w3q" }, "subscription":{ "$ref":"#/definitions/SubscriptionDetails" } } } ] }, "DefaultCluster":{ "type":"object", "description":"The default cluster created by AI Data Platform Workbench.", "allOf":[ { "$ref":"#/definitions/Cluster" }, { "discriminator":"DEFAULT_CLUSTER_API", "properties":{ "workspaceKey":{ "type":"string", "description":"The key of the AI Data Platform Workbench workspace where the default cluster is." }, "workerConfig":{ "$ref":"#/definitions/WorkerConfig" }, "clusterRuntimeConfig":{ "$ref":"#/definitions/ClusterRuntimeConfig" }, "loggingConfig":{ "$ref":"#/definitions/LoggingConfig" }, "autoTerminationMinutes":{ "type":"integer", "format":"int32", "default":null, "x-default-description":"When no value is set, the cluster is not auto-stopped.", "description":"Optional timeout value in minutes used to automatically stop idle compute clusters.", "minimum":5, "maximum":59940 }, "jdbcEndpointUrl":{ "description":"Spark JDBC URL.", "type":"string" }, "logId":{ "type":"string", "description":"The OCID of the log where cluster logs are published and retrieved. This logId is always created within the logGroupId returned in the response payload.\n", "example":"ocid1.log.oc1.phx.amaaaaaaeq37tyqau2j7ug7xnlhtwiubbinfhiuc2fatgwtzt3s3flivchma" }, "logGroupId":{ "type":"string", "description":"The unique OCID that identifies a specific log group within OCI Logging.\nThis log group is exclusively associated with the AI Data Platform Workbench instance and is created in the same compartment within the customer???s tenancy as the AI Data Platform Workbench instance.\n", "example":"ocid1.loggroup.oc1.phx.amaaaaaaeq37tyqau3s5k4zp7gimmao3duxdy2y2j5x3lutjdhggjwzb7w3q" }, "subscription":{ "$ref":"#/definitions/SubscriptionDetails" } } } ] }, "AgentFlowCompute":{ "type":"object", "description":"User-created cluster.", "allOf":[ { "$ref":"#/definitions/Cluster" }, { "discriminator":"AGENT_FLOW_COMPUTE" } ] }, "ClusterSummary":{ "description":"Summary information about a workspace cluster.", "type":"object", "required":[ "key", "state", "type", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"Cluster key.", "type":"string" }, "displayName":{ "description":"Cluster name.", "type":"string" }, "description":{ "description":"Cluster description.", "type":"string", "minLength":1, "maxLength":400 }, "type":{ "type":"string", "description":"ClusterType", "x-obmcs-top-level-enum":"#/definitions/ClusterType", "enum":[ "USER", "AGENT_FLOW_COMPUTE" ] }, "timeCreated":{ "description":"Date and time the cluster was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Date and time the cluster was updated.", "type":"string", "format":"date-time" }, "state":{ "type":"string", "description":"The current state of the cluster.", "x-obmcs-enumref":"#/definitions/Cluster/state" }, "stateDetails":{ "description":"A message that describes the current state of the workspace cluster in more detail. For example, can be used to provide actionable information for a resource in the Failed state.", "type":"string" }, "createdBy":{ "description":"OCID of the user who created this record.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record.", "type":"string" }, "updatedBy":{ "description":"OCID of the user who updated this record.", "type":"string" }, "updatedByName":{ "description":"Name of the user who updated this record.", "type":"string" }, "stoppedBy":{ "description":"OCID of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.", "type":"string" }, "stoppedByName":{ "description":"Name of the user who stopped the cluster. Value will be 'SYSTEM' if it was auto stopped.", "type":"string" }, "clusterRuntimeConfig":{ "$ref":"#/definitions/ClusterRuntimeConfig" }, "activeClusterResources":{ "$ref":"#/definitions/ActiveClusterResources" }, "driverConfig":{ "$ref":"#/definitions/DriverConfig" }, "workerConfig":{ "$ref":"#/definitions/WorkerConfig" }, "attachedNotebooks":{ "type":"array", "description":"List of notebooks attached to a specific cluster.", "items":{ "type":"string" } }, "attachedSessions":{ "type":"array", "description":"List of sessions attached to a specific cluster.", "items":{ "$ref":"#/definitions/AttachedSession" } }, "attachedAgentFlowCount":{ "type":"integer", "default":null, "description":"Count of agent flow attached to a specific cluster." } } }, "CreateClusterDetails":{ "description":"The information about a new compute cluster.", "type":"object", "required":[ "displayName", "driverConfig", "type" ], "discriminator":"type", "properties":{ "type":{ "type":"string", "description":"ClusterType", "x-obmcs-top-level-enum":"#/definitions/ClusterType", "enum":[ "USER", "AGENT_FLOW_COMPUTE" ], "default":"USER" }, "displayName":{ "description":"Cluster name.", "type":"string" }, "description":{ "description":"Cluster description.", "type":"string", "minLength":1, "maxLength":400 }, "driverConfig":{ "$ref":"#/definitions/DriverConfig" }, "nodeType":{ "description":"Cluster node type encodes the node shape and associated resources.", "type":"string", "minLength":1, "maxLength":255 } } }, "CreateSparkClusterDetails":{ "type":"object", "description":"Spark cluster details for creation.", "allOf":[ { "$ref":"#/definitions/CreateClusterDetails" }, { "discriminator":"USER", "properties":{ "workerConfig":{ "$ref":"#/definitions/WorkerConfig" }, "clusterRuntimeConfig":{ "$ref":"#/definitions/ClusterRuntimeConfig" }, "loggingConfig":{ "$ref":"#/definitions/LoggingConfig" }, "autoTerminationMinutes":{ "type":"integer", "format":"int32", "default":null, "x-default-description":"When no value is set, the cluster is not auto-stopped.", "description":"Optional timeout value in minutes used to automatically stop idle compute clusters.", "minimum":5, "maximum":59940 }, "attachToNotebookConfig":{ "$ref":"#/definitions/AttachToNotebookConfig" }, "subscription":{ "$ref":"#/definitions/SubscriptionDetails" } } } ] }, "CreateAgentFlowComputeDetails":{ "type":"object", "description":"Agent flow compute cluster details for creation.", "allOf":[ { "$ref":"#/definitions/CreateClusterDetails" }, { "discriminator":"AGENT_FLOW_COMPUTE" } ] }, "ClusterRuntimeConfig":{ "description":"Cluster runtime configurations.", "type":"object", "discriminator":"type", "properties":{ "type":{ "type":"string", "description":"Runtime type.", "default":"SPARK", "enum":[ "SPARK" ] }, "initScripts":{ "type":"array", "description":"Init script paths that are run in the order of definition.", "items":{ "$ref":"#/definitions/InitScriptPath" } } } }, "ActiveClusterResources":{ "description":"Active resources of a cluster.", "type":"object", "properties":{ "activeExecutorCount":{ "description":"Count of active executors.", "type":"number", "format":"double" }, "activeCores":{ "description":"Count of active cores.", "type":"number", "format":"double" }, "activeGpuCores":{ "description":"Count of active GPU cores.", "type":"number", "format":"double" }, "activeMemoryInGBs":{ "description":"Active memory in GB.", "type":"number", "format":"double" }, "activeGpuMemoryInGBs":{ "description":"Active GPU memory in GB.", "type":"number", "format":"double" } } }, "SparkRuntimeConfig":{ "type":"object", "description":"Spark runtime information.", "allOf":[ { "$ref":"#/definitions/ClusterRuntimeConfig" }, { "discriminator":"SPARK", "properties":{ "sparkVersion":{ "type":"string", "description":"Spark version used to run the application." }, "sparkAdvancedConfigurations":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Spark configuration passed to the running process." }, "sparkEnvVariables":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Environment variables passed to the running process. See Available Properties.\nExample - { \"spark.app.name\" : \"My App Name\", \"spark.shuffle.io.maxRetries\" : \"4\" }\nNote: Not all Spark properties are permitted to be set. Attempting to set a property that is\nnot allowed to be overwritten will cause a 400 status to be returned.\n" } } } ] }, "InitScriptPath":{ "description":"The path details of init script.", "type":"object", "required":[ "destination" ], "properties":{ "destination":{ "type":"string", "description":"Full path of the init script file. Example - /Workspace/Shared/Folder1/my-init.sh or /Volumes/catalogName/schemaName/volumeName/Shared/Folder1/my-init.sh." } } }, "DriverConfig":{ "description":"Driver configuration.", "type":"object", "properties":{ "driverNodeType":{ "description":"Node type of optional driver node that encodes the driver node shape and associated resources.", "type":"string", "minLength":1, "maxLength":255 }, "driverShape":{ "description":"Shape of compute cluster driver instance. Example - VM.Standard2.x, VM.Standard.E3.Flex", "type":"string", "minLength":1, "maxLength":255 }, "driverShapeConfig":{ "$ref":"#/definitions/ShapeConfig" } } }, "WorkerConfig":{ "description":"Worker configuration.", "type":"object", "properties":{ "workerShape":{ "description":"Shape of the compute cluster executor instance.", "type":"string", "minLength":1, "maxLength":255 }, "workerShapeConfig":{ "$ref":"#/definitions/ShapeConfig" }, "minWorkerCount":{ "description":"Minimum number of workers.", "type":"integer" }, "maxWorkerCount":{ "description":"Maximum number of workers. When this property is specified, the cluster is auto-scaled.", "type":"integer" } } }, "ShapeConfig":{ "description":"Shape of the driver or executor if a flexible shape is used.", "properties":{ "ocpus":{ "description":"Total number of OCPUs used for the driver or workers.", "type":"integer", "minimum":1 }, "gpus":{ "description":"Total number of GPUs used for the driver or workers.", "type":"integer", "minimum":0 }, "memoryInGBs":{ "description":"Amount of memory used for the driver or workers.", "type":"integer", "minimum":16 } } }, "LoggingConfig":{ "description":"Logging configuration.", "type":"object", "discriminator":"type", "properties":{ "type":{ "type":"string", "description":"Type of logging service.", "default":"OCI_LOGGING", "enum":[ "OCI_LOGGING" ] } } }, "OciLogging":{ "description":"OCI logging configuration.", "type":"object", "allOf":[ { "$ref":"#/definitions/LoggingConfig" }, { "discriminator":"OCI_LOGGING", "properties":{ "logGroups":{ "type":"array", "description":"Init script paths that are run in the order of definition.", "items":{ "$ref":"#/definitions/LogGroup" } } } } ] }, "LogGroup":{ "description":"Log group details.", "type":"object", "properties":{ "compartmentId":{ "type":"string", "description":"The compartment ID of the log group." }, "groupName":{ "type":"string", "description":"Log group name." }, "logName":{ "type":"string", "description":"Log name." } } }, "UpdateClusterDetails":{ "description":"The data to update a cluster.", "type":"object", "required":[ "type" ], "discriminator":"type", "properties":{ "type":{ "type":"string", "description":"ClusterType", "x-obmcs-top-level-enum":"#/definitions/ClusterType", "default":"USER", "enum":[ "USER", "AGENT_FLOW_COMPUTE" ] }, "displayName":{ "description":"Cluster name.", "type":"string" }, "description":{ "description":"Cluster description.", "type":"string", "minLength":1, "maxLength":400 }, "driverConfig":{ "$ref":"#/definitions/DriverConfig" }, "nodeType":{ "description":"Cluster node type encodes the node shape and associated resources.", "type":"string", "minLength":1, "maxLength":255 } } }, "UpdateSparkClusterDetails":{ "type":"object", "description":"Spark cluster details for creation", "allOf":[ { "$ref":"#/definitions/UpdateClusterDetails" }, { "discriminator":"USER", "properties":{ "workerConfig":{ "$ref":"#/definitions/WorkerConfig" }, "clusterRuntimeConfig":{ "$ref":"#/definitions/ClusterRuntimeConfig" }, "loggingConfig":{ "$ref":"#/definitions/LoggingConfig" }, "autoTerminationMinutes":{ "type":"integer", "format":"int32", "default":null, "x-default-description":"When no value is set, the cluster is not auto-stopped.", "description":"Optional timeout value in minutes used to automatically stop idle compute clusters.", "minimum":5, "maximum":59940 }, "subscription":{ "$ref":"#/definitions/SubscriptionDetails" } } } ] }, "UpdateAgentFlowComputeDetails":{ "type":"object", "description":"Agent Flow Compute cluster details for creation", "allOf":[ { "$ref":"#/definitions/UpdateClusterDetails" }, { "discriminator":"AGENT_FLOW_COMPUTE" } ] }, "UpdateClusterAsyncOperationStatusDetails":{ "description":"The data to update cluster async operation status.", "type":"object", "required":[ "state" ], "properties":{ "stateMessage":{ "description":"Descriptive message of the current state.", "type":"string" }, "state":{ "description":"Common lifecycle states for resources in a compute cluster.\nACCEPTED - The resource create request has been accepted.\nCREATING - The resource is being created and might not be usable until the entire metadata is defined.\nACTIVE - The resource is valid and available for access.\nDELETING - The resource is being deleted, and might require a deep clean of any children.\nDELETED - The resource has been deleted, and isn't available.\nFAILED - The resource is in a failed state due to validation or other errors.\nSTOPPING - The resource is being stopped.\nSTOPPED - The resource has been stopped.\nUPDATING - The resource is being updated and might not be usable until all changes are commited.\nSTARTING - The resource is being started.\nRESTARTING - The resource is being restarted.\n", "type":"string", "enum":[ "ACCEPTED", "CREATING", "ACTIVE", "DELETING", "DELETED", "FAILED", "STOPPING", "STOPPED", "UPDATING", "RESTARTING", "STARTING", "NETWORK_CONFIGURATION_ATTACH_IN_PROGRESS", "NETWORK_CONFIGURATION_ATTACH_SUCCESSFUL", "NETWORK_CONFIGURATION_ATTACH_FAILED", "NETWORK_CONFIGURATION_DETACH_IN_PROGRESS", "NETWORK_CONFIGURATION_DETACH_SUCCESSFUL", "NETWORK_CONFIGURATION_DETACH_FAILED" ] }, "externalId":{ "description":"External work-request-id if applicable.", "type":"string" }, "metrics":{ "description":"Metrics for the cluster operation.", "type":"object", "additionalProperties":{ "type":"string" } }, "properties":{ "description":"Properties of operation on cluster.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "ClusterCollection":{ "type":"object", "description":"Results of a cluster list.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Clusters.", "type":"array", "items":{ "$ref":"#/definitions/ClusterSummary" } } } }, "DataLakeClusterCollection":{ "type":"object", "description":"Results of a cluster list within the AI Data Platform Workbench.", "required":[ "items" ], "properties":{ "items":{ "description":"List of clusters within the AI Data Platform Workbench.", "type":"array", "items":{ "$ref":"#/definitions/DataLakeClusterSummary" } } } }, "DataLakeClusterSummary":{ "description":"Information about the list of AI Data Platform Workbench clusters contained within a workspace.", "type":"object", "required":[ "workspaceKey", "workspaceDisplayName" ], "properties":{ "workspaceKey":{ "description":"Key of the AI Data Platform Workbench workspace.", "type":"string" }, "workspaceDisplayName":{ "description":"Name of the AI Data Platform Workbench workspace.", "type":"string" }, "clusters":{ "description":"List of clusters.", "type":"array", "items":{ "$ref":"#/definitions/ClusterSummary" } } } }, "StartClusterDetails":{ "description":"Details to start a cluster.", "type":"object" }, "StopClusterDetails":{ "description":"Details to stop a cluster.", "type":"object" }, "RestartClusterDetails":{ "description":"Details to restart a cluster.", "type":"object" }, "ClusterLibraryCollection":{ "type":"object", "description":"List of cluster libraries.", "required":[ "items" ], "properties":{ "items":{ "description":"List of cluster libraries.", "type":"array", "items":{ "$ref":"#/definitions/ClusterLibrarySummary" } } } }, "ClusterLibrarySummary":{ "description":"Summary information about a cluster library.", "type":"object", "discriminator":"type", "properties":{ "type":{ "description":"Library type.", "type":"string" }, "timeCreated":{ "description":"Date and time the library was installed.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Date and time the library was updated.", "type":"string", "format":"date-time" }, "stateMessage":{ "description":"Additional context or detail about the current state of the library, especially useful when the status is `FAILED`, `SKIPPED`, or requires user intervention.\nThis message can contain information such as the reason for failure, the step where the installation failed, or other diagnostic messages.\n", "type":"string" }, "status":{ "description":"Status of the library installed on the cluster.", "type":"string", "enum":[ "PENDING", "RESOLVING", "INSTALLING", "INSTALLED", "FAILED", "INSTALL_ON_RESTART", "UNINSTALL_ON_RESTART", "SKIPPED", "DELETED" ] } } }, "WorkspaceFileClusterLibrarySummary":{ "description":"Details of a workspace file installed as a library on a cluster.", "type":"object", "allOf":[ { "$ref":"#/definitions/ClusterLibrarySummary" }, { "discriminator":"WORKSPACE_FILE", "properties":{ "name":{ "description":"Library name.", "type":"string" }, "path":{ "description":"Full path of the library.", "type":"string" } } } ] }, "VolumeFileClusterLibrarySummary":{ "description":"Details of a volume file installed as a library on a cluster.", "type":"object", "allOf":[ { "$ref":"#/definitions/ClusterLibrarySummary" }, { "discriminator":"VOLUME_FILE", "properties":{ "name":{ "description":"Library name.", "type":"string" }, "path":{ "description":"Full path of the library.", "type":"string" } } } ] }, "ClusterLibraryDetails":{ "description":"Information about a cluster library to install or uninstall.", "type":"object", "discriminator":"operation", "required":[ "operation" ], "properties":{ "operation":{ "description":"Operation to perform on this library from the cluster. Install or uninstall.", "type":"string", "enum":[ "INSTALL", "UNINSTALL" ] }, "type":{ "description":"Library type.", "type":"string", "enum":[ "WORKSPACE_FILE", "VOLUME_FILE" ] } } }, "InstallClusterLibraryDetails":{ "description":"Details required to install a library on a cluster.", "type":"object", "allOf":[ { "$ref":"#/definitions/ClusterLibraryDetails" }, { "discriminator":"INSTALL", "properties":{ "path":{ "description":"File path for the library to install. Example - /Workspace/shared/example/test.txt or /Volumes/catalogName/schemaName/volumeName/test.txt", "type":"string" } } } ] }, "UninstallClusterLibraryDetails":{ "description":"Details required to uninstall a library from a cluster.", "type":"object", "allOf":[ { "$ref":"#/definitions/ClusterLibraryDetails" }, { "discriminator":"UNINSTALL", "properties":{ "name":{ "description":"Name of the library to uninstall.", "type":"string" } } } ] }, "PatchClusterLibraryDetails":{ "description":"Cluster library details to update.", "type":"object", "properties":{ "items":{ "description":"List of library changes to make.", "type":"array", "items":{ "$ref":"#/definitions/ClusterLibraryDetails" } } } }, "AttachToNotebookConfig":{ "description":"Configuration associated with the notebook being attached to the created cluster.", "type":"object", "required":[ "notebookPath" ], "properties":{ "notebookPath":{ "description":"Notebook URI path.", "type":"string" } } }, "ClusterPrivilege":{ "description":"Privilege for a cluster.", "type":"string", "enum":[ "READ", "USE", "ADMIN" ] }, "ClusterPermissionCollection":{ "type":"object", "description":"List of cluster permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of cluster permissions.", "type":"array", "items":{ "$ref":"#/definitions/ClusterPermissionSummary" } } } }, "ClusterPermissionSummary":{ "description":"Information about a cluster permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"Simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"Type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"Selected permissions for a cluster.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ClusterPrivilege", "enum":[ "READ", "USE", "ADMIN" ] } } } }, "AssignClusterPermissionDetails":{ "description":"Details of the permissions assigned on the cluster to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"Permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ClusterPrivilege", "enum":[ "READ", "USE", "ADMIN" ] } } } }, "RevokeClusterPermissionDetails":{ "description":"Details of the permissions revoked from assignees for a cluster.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"Permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ClusterPrivilege", "enum":[ "READ", "USE", "ADMIN" ] } } } }, "ManageClusterPermissionDetails":{ "description":"Information to update permissions on a cluster.", "type":"object", "properties":{ "assignClusterPermissionDetails":{ "$ref":"#/definitions/AssignClusterPermissionDetails" }, "revokeClusterPermissionDetails":{ "$ref":"#/definitions/RevokeClusterPermissionDetails" } } }, "IsPrincipalAdmin":{ "type":"object", "description":"Response indicating whether the principal has admin privileges.", "required":[ "isAdmin" ], "properties":{ "isAdmin":{ "type":"boolean", "description":"True if the principal has admin privileges, otherwise false." } } }, "AttachedSession":{ "type":"object", "description":"Details of attached sessions to a cluster", "properties":{ "type":{ "type":"string", "description":"The type of the attached session.", "enum":[ "NOTEBOOK", "FILE" ] }, "path":{ "type":"string", "description":"The path of the attached file." }, "state":{ "type":"string", "description":"The state of the attached file.", "enum":[ "ACTIVE", "IDLE" ] }, "lastCommandRun":{ "type":"string", "description":"The time of the last command of file was run in this cluster.\n" } } }, "SubscriptionDetails":{ "type":"object", "description":"Details of subscription.", "properties":{ "callbackUrl":{ "type":"string", "description":"The notification callback URL." }, "serviceName":{ "type":"string", "description":"The name of the service." } } }, "WorkspaceObjectDetails":{ "description":"A WorkspaceObject is a file or folder belonging to an AI Data Platform Workbench workspace.\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\nIAM Policies for Oracle AI Data Platform Workbench.\n", "type":"object", "required":[ "path", "type", "timeCreated", "displayName" ], "properties":{ "path":{ "description":"The fully qualified path of the workspace object.\nExample: /Shared/Folder1/Notebook1.ipynb\n", "type":"string" }, "key":{ "description":"The key of the Workspace Object.", "type":"string" }, "displayName":{ "description":"The name of the Workspace Object. This will be the name of the file/folder in the workspace.\nExample: Notebook1.ipynb, Folder1\n", "type":"string" }, "timeCreated":{ "description":"The date and time the workspace object was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the workspace object was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "type":{ "description":"The type of the workspace object.", "type":"string", "enum":[ "NOTEBOOK", "JOB", "LAKE_FLOW", "AGENT_LAKE_FLOW", "GENERATED_ARTIFACT", "LIBRARY", "FILE", "FOLDER" ] }, "description":{ "description":"The description for the file and folder.", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "WorkspaceObject":{ "description":"Contents of a Workspace Object.", "type":"object" }, "WorkspaceObjectSummary":{ "description":"Summary information about a workspace object.", "type":"object", "required":[ "path", "type", "timeCreated", "displayName" ], "properties":{ "path":{ "description":"The fully qualified path of the workspace object.\nExample: /Shared/Folder1/Notebook1.ipynb\n", "type":"string" }, "displayName":{ "description":"The name of the workspace object. This will be the name of the file/folder in the workspace.\nExample: Notebook1.ipynb, Folder1\n", "type":"string" }, "timeCreated":{ "description":"The date and time the workspace object was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the workspace object was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "metadata":{ "type":"object", "description":"Metadata details of file or folder objects.", "additionalProperties":{ "type":"string" } }, "compositeEtag":{ "description":"Etag combining data and metadata.", "type":"string" }, "type":{ "description":"The type of workspace object.", "type":"string", "x-obmcs-enumref":"#/definitions/WorkspaceObjectDetails/type" }, "description":{ "description":"The description of workspace object.", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } }, "createdBy":{ "description":"OCID of the user who created this object.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this object.", "type":"string" } } }, "WorkspaceObjectCollection":{ "type":"object", "description":"Results of a workspace object list.", "required":[ "items" ], "properties":{ "items":{ "description":"List of workspace objects.", "type":"array", "items":{ "$ref":"#/definitions/WorkspaceObjectSummary" } } } }, "WorkspaceObjectPrivilege":{ "description":"The privilege for a workspace object.", "type":"string", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] }, "WorkspaceObjectPermissionCollection":{ "type":"object", "description":"List of workspace object permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of workspace object permissions.", "type":"array", "items":{ "$ref":"#/definitions/WorkspaceObjectPermissionSummary" } } } }, "WorkspaceObjectPermissionSummary":{ "description":"Information about a workspace object permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a workspace object.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/WorkspaceObjectPrivilege", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] } }, "isPermissionsInheritable":{ "type":"boolean", "description":"Property to determine if permission is inheritable or not. This is applicable only on workspace folders not on files." } } }, "AssignWorkspaceObjectPermissionDetails":{ "description":"The details of the permissions assigned on the workspace object to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/WorkspaceObjectPrivilege", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] } }, "isPermissionsInheritable":{ "type":"boolean", "description":"Property to determine if permission should be inheritable or not, its default value is true. This is applicable only on workspace folders not on files.", "default":true } } }, "RevokeWorkspaceObjectPermissionDetails":{ "description":"The details of the permissions revoked from assignees for a workspace object.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/WorkspaceObjectPrivilege", "enum":[ "READ", "USE", "MANAGE", "ADMIN" ] } }, "isPermissionsInheritable":{ "type":"boolean", "description":"Property to determine that permission which should be removed is inheritable or not. This is applicable only on workspace folders not on files.", "default":true } } }, "ManageWorkspaceObjectPermissionDetails":{ "description":"Information to update permissions on a workspace object.", "type":"object", "properties":{ "assignWorkspaceObjectPermissionDetails":{ "$ref":"#/definitions/AssignWorkspaceObjectPermissionDetails" }, "revokeWorkspaceObjectPermissionDetails":{ "$ref":"#/definitions/RevokeWorkspaceObjectPermissionDetails" } } }, "MoveWorkspaceObjectDetails":{ "description":"Details to move a workspace object to a different location.", "type":"object", "properties":{ "fromPath":{ "description":"The fully qualified path of the workspace object that should be moved.", "type":"string" }, "toPath":{ "description":"The fully qualified destination path to which the Workspace object should be moved.", "type":"string" } } }, "RenameWorkspaceObjectDetails":{ "description":"Details to rename a workspace object.", "type":"object", "properties":{ "path":{ "description":"The fully qualified path of the Workspace object that should be renamed.", "type":"string" }, "newName":{ "description":"The new name of the workspace object.", "type":"string" } } }, "MkdirDetails":{ "description":"Details to create a directory in the workspace.", "type":"object", "properties":{ "path":{ "description":"The fully qualified path of the directory to create.", "type":"string" }, "description":{ "description":"The description of the directory to create.", "type":"string" } } }, "AttachWorkspaceObjectToClusterDetails":{ "description":"Details to attach a workspace object to a cluster.", "type":"object" }, "DetachWorkspaceObjectFromClusterDetails":{ "description":"Details to detach a workspace object from a cluster.", "type":"object" }, "CopyWorkspaceObjectDetails":{ "description":"Details to copy a workspace object to a different location.", "type":"object", "properties":{ "fromPath":{ "description":"The fully qualified path of the Workspace object that should be copied.", "type":"string" }, "toPath":{ "description":"The fully qualified destination path to which the Workspace object should be copied.", "type":"string" }, "isDeleteSource":{ "description":"Flag to delete the source file.", "type":"boolean" }, "isOverWrite":{ "description":"Flag to overwrite pre existing destination file.", "type":"boolean" }, "bufferSize":{ "description":"Buffer capacity to be hold for copying file from one source to destination.", "type":"integer" }, "isIncludeOutputs":{ "description":"Flag to indicate whether to include cell outputs when copying a notebook file. If false, all cell outputs will be cleared. Defaults to true if not specified. Only applies to notebook files.", "type":"boolean" } } }, "UpdateFileMetadataActionType":{ "description":"Metadata update action.", "type":"string", "enum":[ "UPDATE", "APPEND", "REPLACE", "RESET" ] }, "UpdateFileMetadataDetails":{ "description":"The metadata information.", "type":"object", "required":[ "action" ], "properties":{ "metadata":{ "description":"The metadata information in map form. Example entries include system:key1=val1 and user:key2=val1.", "type":"object", "additionalProperties":{ "type":"string" } }, "action":{ "description":"Action to be taken in case of conflict.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/UpdateFileMetadataActionType", "enum":[ "UPDATE", "APPEND", "REPLACE", "RESET" ] } } }, "Kernel":{ "description":"Notebook kernel information.", "type":"object", "required":[ "id" ], "properties":{ "id":{ "description":"UUID of kernel.", "type":"string" }, "name":{ "description":"Kernel spec name. (Example python3)", "type":"string" }, "last_activity":{ "description":"ISO 8601 timestamp for last-seen activity on this kernel.\nUse this in combination with execution_state == 'idle' to identify\nwhich kernels have been idle since a given time.\nTimestamps will be UTC, indicated 'Z' suffix.\n", "type":"string" }, "connections":{ "description":"The number of active connections to this kernel.\n", "type":"integer" }, "execution_state":{ "description":"Current execution state of Kernel (typically 'idle' or 'busy', but may be other values, such as 'starting').\nAdded in notebook server 5.0.\n", "type":"string", "enum":[ "unknown", "starting", "idle", "busy", "terminating", "restarting", "autorestarting", "dead" ] } } }, "Session":{ "description":"Notebook Session describes the Session context for a running instance of a Notebook. Each opened Notebook has a separate Session,\nbut different Notebook kernels can use same Session if user wants to share data across various opened Notebooks.\n", "type":"object", "required":[ "name", "id" ], "properties":{ "id":{ "description":"UUID of the notebook session.", "type":"string" }, "name":{ "description":"A user-friendly name for the notebook session.", "type":"string" }, "path":{ "description":"Path to notebook session. For example, /data/test.ipynb", "type":"string" }, "type":{ "description":"Notebook session type.", "type":"string", "enum":[ "notebook", "file", "agentflow" ] }, "cluster_id":{ "type":"string", "description":"Cluster ID." }, "kernel":{ "$ref":"#/definitions/Kernel" }, "agentFlowKey":{ "type":"string", "description":"Agent Flow Key of an agent flow." }, "lifecycleState":{ "type":"string", "description":"lifecycleState of a Notebook Session.", "enum":[ "CREATING", "ACTIVE", "FAILED" ] } } }, "KernelSummary":{ "description":"Kernel summary", "required":[ "name" ], "properties":{ "id":{ "type":"string", "description":"UUID of the kernel." }, "name":{ "type":"string", "description":"Kernel spec name." }, "last_activity":{ "type":"string", "description":"ISO 8601 timestamp for the last-seen activity on this kernel.\nUse this in combination with execution_state == 'idle' to identify\nwhich kernels have been idle since a given time.\nTimestamps will be UTC, indicated 'Z' suffix.\nAdded in notebook server 5.0.\n" }, "connections":{ "type":"integer", "description":"The number of active connections to this kernel.\n" }, "execution_state":{ "type":"string", "description":"Current execution state of the kernel. Typically 'idle' or 'busy', but may be other values, such as 'starting'.\n" } } }, "Content":{ "description":"Content model provides a programmatic interface to interact with notebooks, files and directories within the AI Data Platform Workbench Notebook environment.\nType field is used to describe content types like file, directory or notebook. \nOther notable fields are content and format. The content and format keys may be null if content is not contained.\n", "type":"object", "required":[ "type", "name", "path", "writable", "created", "last_modified", "mimetype", "format", "content" ], "properties":{ "name":{ "description":"Name of notebook, file or directory, equivalent to the last part of the path.", "type":"string" }, "path":{ "description":"Full path for notebook, file or directory.", "type":"string" }, "type":{ "description":"Type of content model.", "type":"string", "enum":[ "notebook", "file", "directory" ] }, "writable":{ "description":"Indicates whether the requester has permission to edit the file.", "type":"boolean" }, "created":{ "description":"Creation timestamp.", "type":"string", "format":"date-time" }, "last_modified":{ "description":"Last modified timestamp.", "type":"string", "format":"date-time" }, "size":{ "description":"Size of file or notebook in bytes. If no size is provided, defaults to null.", "type":"integer" }, "mimetype":{ "description":"Mimetype is only applicable for File model. For other models, it is None. If content is not null, and type is 'file', \nthis contains the mimetype of file. For example, text/plain application/octet-stream. Otherwise this is null.\n", "type":"string" }, "content":{ "description":"Content if requested, otherwise is Null. \nFor Notebook model, this contains a nbformat NotebookNode representing the .ipynb file represented by the model. \nFor File model, content field is always Unicode type. For text-format file models, content simply contains the bytes of the file after decoding as UTF-8. \nNon-text (base64) files are read as bytes, base64 encoded, and then decoded as UTF-8. \nFor Directory model, content field contains a list of content-free models representing the entities in the directory.\n", "type":"object" }, "format":{ "description":"Format of content. For Notebook model, format field is always 'json'. For File model, format field is either 'text' or 'base64'. \nFor directory model, format field is always 'json'.\n", "type":"string", "enum":[ "NULL", "json", "text", "base64" ] }, "hash":{ "description":"[optional] The hexdigest hash string of content, if requested, otherwise null. It cannot be null if hashAlgorithm is defined.\n", "type":"string" }, "hash_algorithm":{ "description":"[optional] The algorithm used to produce the hash, if requested, (otherwise null). It cannot be null if hash is defined. \n Available algorithms.\n", "type":"string" }, "description":{ "description":"A user-provided description of the file.", "type":"string" } } }, "ExportedContents":{ "description":"This model represents a file with contents, format and other details.\n", "type":"object", "required":[ "name", "path", "content", "format" ], "properties":{ "name":{ "description":"Name of file, equivalent to the last part of the path.", "type":"string" }, "path":{ "description":"Full path of the file.", "type":"string" }, "content":{ "description":"For ipynb format, this contains a string representing the .ipynb file.\nFor html format, this contains a string representing the HTML page, it has base64 encoded data for images.\n", "type":"object" }, "format":{ "description":"Format of content as requested by the client. By default, ipynb format.\n", "type":"string", "enum":[ "html", "ipynb" ] } } }, "ExportContentsDetails":{ "description":"Payload required to export contents of a file.", "type":"object", "properties":{ "format":{ "description":"The format in which contents should be exported, supported formats are HTML and ipynb only.", "type":"string", "default":"ipynb", "enum":[ "ipynb", "html" ] } } }, "ClearOutputsDetails":{ "description":"Payload required to clear outputs of a notebook file.", "type":"object", "properties":{ "shouldClearExecMetadata":{ "description":"To clear execution metadata like execution count, command_metadata etc.", "type":"boolean", "default":true } } }, "CreateContentDetails":{ "description":"Path of file to copy. A POST to /api/contents/path creates a New untitled, empty file or directory. A POST to /api/contents/path with body {'copy_from': '/path/to/OtherNotebook.ipynb'} creates a new copy of OtherNotebook in path.", "type":"object", "properties":{ "copy_from":{ "description":"Copy from Path. For example, /path/to/OtherNotebook.ipynb.", "type":"string" }, "ext":{ "description":"File format extension", "type":"string" }, "type":{ "description":"Type of Content model. Either notebook, file, or directory.", "type":"string", "x-obmcs-enumref":"#/definitions/Content/type" } } }, "ModifyContentDetails":{ "description":"Path of file to copy. A POST to /api/contents/path creates a New untitled, empty file or directory. A POST to /api/contents/path with body {'copy_from': '/path/to/OtherNotebook.ipynb'} creates a new copy of OtherNotebook in path", "type":"object", "properties":{ "path":{ "description":"New path for file or directory", "type":"string" } } }, "UpdateContentDetails":{ "description":"Content model provides a programmatic interface to interact with notebooks, files and directories within DataLake Notebook environment.\nType field is used to describe content types like file, directory or notebook. \nOther notable fields are content and format. The content and format keys may be null if content is not contained.\n", "type":"object", "properties":{ "name":{ "description":"Name of notebook, file or directory, equivalent to the last part of the path", "type":"string" }, "path":{ "description":"Full path for notebook, file, or directory.", "type":"string" }, "type":{ "description":"Type of Content model", "type":"string", "enum":[ "notebook", "file", "directory" ] }, "content":{ "description":"Content if requested (otherwise null). \nFor Notebook model, this contains a nbformat NotebookNode representing the .ipynb file represented by the model. \nFor File model, content field is always of type unicode. For text-format file models, content simply contains the file???s bytes after decoding as UTF-8. \nNon-text (base64) files are read as bytes, base64 encoded, and then decoded as UTF-8. \nFor Directory model, content field contains a list of content-free models representing the entities in the directory.\n", "type":"object" }, "format":{ "description":"Format of content. For Notebook model, format field is always JSON. For File model, format field is either Text or Base64. \nFor Directory model, format field is always JSON.\n", "type":"string", "enum":[ "NULL", "json", "text", "base64" ] } } }, "CreateSessionDetails":{ "description":"Details to create a session.", "type":"object", "properties":{ "id":{ "type":"string", "description":"UUID of the session." }, "path":{ "type":"string", "description":"Path to the session. A directory where notebook server is started and where notebooks are saved. For example, /data/test.ipynb." }, "name":{ "type":"string", "description":"A user-friendly name for the session." }, "type":{ "type":"string", "description":"Type of session." }, "cluster_id":{ "type":"string", "description":"Cluster ID." }, "agentFlowKey":{ "type":"string", "description":"Key of the agent flow." }, "kernel":{ "$ref":"#/definitions/Kernel" } } }, "PatchSessionDetails":{ "description":"Details to update a session.", "type":"object", "properties":{ "id":{ "description":"UUID of the session.", "type":"string" }, "name":{ "description":"A user-friendly name for the session.", "type":"string" }, "path":{ "description":"Path to the session. A directory where notebook server is started and where notebooks are saved. For example, /data/test.ipynb.", "type":"string" }, "type":{ "description":"Type of session.", "type":"string", "x-obmcs-enumref":"#/definitions/Session/type" }, "kernel":{ "$ref":"#/definitions/Kernel" }, "cluster_id":{ "type":"string", "description":"Cluster ID." }, "must_refresh_context":{ "type":"boolean", "default":false, "description":"Set as True, if a new execution context is needed." } } }, "SessionSummary":{ "description":"Summary information about a notebook session.", "type":"object", "properties":{ "id":{ "description":"UUID if the session.", "type":"string" }, "name":{ "description":"A user-friendly name for the session.", "type":"string" }, "path":{ "description":"Path to the session. A directory where notebook server is started and where notebooks are saved. For example, /data/test.ipynb.", "type":"string" }, "type":{ "description":"Type of session.", "type":"string", "x-obmcs-enumref":"#/definitions/Session/type" }, "cluster_id":{ "type":"string", "description":"Cluster ID." }, "kernel":{ "$ref":"#/definitions/KernelSummary" }, "agentFlowKey":{ "type":"string", "description":"Agent flow key of an agent flow." }, "lifecycleState":{ "type":"string", "description":"lifecycleState of a Notebook Session.", "x-obmcs-enumref":"#/definitions/Session/lifecycleState" } } }, "SessionCollection":{ "type":"object", "description":"A list of session summaries related to a workspace.", "required":[ "items" ], "properties":{ "items":{ "description":"List of sessions.", "type":"array", "items":{ "$ref":"#/definitions/SessionSummary" } } } }, "KernelCollection":{ "type":"object", "description":"A list of active kernel objects in the workspace.", "required":[ "items" ], "properties":{ "items":{ "description":"List of active kernel objects.", "type":"array", "items":{ "$ref":"#/definitions/KernelSummary" } } } }, "IdentityDomainSummary":{ "type":"object", "description":"A domain in the tenancy.", "properties":{ "domainId":{ "type":"string", "description":"The ID of the domain." }, "domainName":{ "type":"string", "description":"The name of the domain." }, "lifecycleState":{ "type":"string", "description":"The current state of the domain in its lifecycle.", "enum":[ "CREATING", "ACTIVE", "DELETING", "INACTIVE" ] }, "homeRegionUrl":{ "type":"string", "description":"The primary region-specific URL for accessing the domain." } } }, "IdentityDomainCollection":{ "type":"object", "description":"A collection of Identity domains.", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Identity domains.", "items":{ "$ref":"#/definitions/IdentityDomainSummary" } } } }, "IdentityUserSummary":{ "type":"object", "description":"A user in the tenancy.", "properties":{ "userId":{ "type":"string", "description":"The ID of the user." }, "userName":{ "type":"string", "description":"The login userName used by the user." }, "userEmail":{ "type":"string", "description":"The email of the user." } } }, "IdentityUserCollection":{ "type":"object", "description":"A collection of tenancy users.", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of tenancy users.", "items":{ "$ref":"#/definitions/IdentityUserSummary" } } } }, "IdentityGroupSummary":{ "type":"object", "description":"A group in the tenancy.", "properties":{ "groupId":{ "type":"string", "description":"The ID of the group." }, "groupName":{ "type":"string", "description":"The name of the group." } } }, "IdentityGroupCollection":{ "type":"object", "description":"A collection of tenancy groups.", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of tenancy groups.", "items":{ "$ref":"#/definitions/IdentityGroupSummary" } } } }, "FeatureStatusResult":{ "type":"object", "description":"Model representing the response for checking the status of a single feature.", "properties":{ "feature":{ "$ref":"#/definitions/Feature" } }, "required":[ "feature" ] }, "FeatureStatusCollection":{ "type":"object", "description":"Model representing the response for checking the statuses of features.", "properties":{ "items":{ "type":"array", "description":"List of features.", "items":{ "$ref":"#/definitions/FeatureStatusSummary" } } }, "required":[ "items" ] }, "FeatureStatusSummary":{ "type":"object", "description":"A single feature summary and its value.", "properties":{ "featureName":{ "type":"string", "description":"The name of the queried feature." }, "value":{ "type":"string", "description":"The status value of the feature." }, "error":{ "type":"string", "description":"Error message, if error with featureName like unsupported." } }, "required":[ "featureName", "value" ] }, "Feature":{ "type":"object", "description":"A single feature and its value.", "properties":{ "featureName":{ "type":"string", "description":"The name of the queried feature." }, "value":{ "type":"string", "description":"The status value of the feature." } }, "required":[ "featureName", "value" ] }, "SearchClusterLogsDetails":{ "type":"object", "description":"Request payload for searching logs in a cluster.", "required":[ "timeBegin", "timeEnd", "logContentTypeContains" ], "properties":{ "timeBegin":{ "type":"string", "format":"date-time", "description":"Start filter log's date and time, in RFC 3339 format." }, "timeEnd":{ "type":"string", "format":"date-time", "description":"End filter log's date and time, in RFC 3339 format." }, "logContentTypeContains":{ "type":"string", "description":"The string represent the type of compute logs \nCommon values include `events`, `driver`, `executor`.\n", "example":"events" }, "subjectContains":{ "type":"string", "description":"The string represent the specific of compute nodes\nCommon values include `spark-driver`, `spark-executor-1`.\n", "example":"executor-1" }, "messageContains":{ "type":"string", "description":"The string represent a filter to search message string from the log\nSupported only when `logContentTypeContains` is `events`.\n" }, "logLevel":{ "type":"string", "description":"The severity level of the log messages to filter. \nCommon values include `INFO`, `WARN`, `ERROR`, `DEBUG`, etc.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n", "example":"ERROR" }, "opcRequestId":{ "type":"string", "description":"The unique request identifier used for tracking the API call.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n", "example":"bce8d78b-6f12-4a99-95d2-3f44440c54a9" }, "advancedFilter":{ "type":"string", "description":"Contains any key and value that you want to search in the logs.\nShould be provided in the format 'key = value'. As of now supported keys are 'taskRunKey' and 'jobRunKey'\n", "example":"taskRunKey = c75b2b5e-b104-48ac-ae82-3acbdc638ab2" }, "thread":{ "type":"string", "description":"The thread identifier that generated the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n" }, "executionContextId":{ "type":"string", "description":"The execution context identifier associated with the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n" }, "logStreamTypeContains":{ "type":"string", "description":"Filters logs based on the output stream type. \n- This includes standard output (`stdout`) for regular program output \n- and standard error (`stderr`) for error messages and diagnostics.\nOnly supported when logContentTypeContains=executor/driver.\n", "example":"stderr" }, "eventType":{ "type":"string", "description":"Filters logs based on the event type.\nSupported only when `logContentTypeContains` is `events`.\n", "example":"CREATING" } } }, "ClusterLogCollection":{ "type":"object", "description":"Results of a cluster log list.", "required":[ "items" ], "properties":{ "items":{ "description":"List of cluster logs.", "type":"array", "items":{ "$ref":"#/definitions/ClusterLogsSummary" } } } }, "ClusterLogsSummary":{ "type":"object", "description":"Response payload containing search results and metadata.", "required":[ "results", "summary" ], "properties":{ "fields":{ "type":"array", "description":"List of log field schema information.", "items":{ "$ref":"#/definitions/FieldInfo" } }, "results":{ "type":"array", "description":"List of search results.", "items":{ "$ref":"#/definitions/SearchResult" } }, "summary":{ "$ref":"#/definitions/SearchResultSummary" } } }, "FieldInfo":{ "type":"object", "description":"Schema details of log fields.", "required":[ "fieldName", "fieldType" ], "properties":{ "fieldName":{ "type":"string", "minLength":1, "maxLength":1024, "description":"The name of the field." }, "fieldType":{ "type":"string", "description":"The type of the field.", "enum":[ "STRING", "NUMBER", "BOOLEAN", "ARRAY" ] } } }, "SearchResult":{ "type":"object", "description":"A single search result.", "required":[ "data" ], "properties":{ "data":{ "type":"object", "description":"The actual log data with field mappings." } } }, "SearchResultSummary":{ "type":"object", "description":"Summary of the search response.", "required":[ "resultCount", "fieldCount" ], "properties":{ "resultCount":{ "type":"integer", "description":"Total number of search results." }, "fieldCount":{ "type":"integer", "description":"Total number of field schema information." } } }, "SummarizeMetricsDataDetails":{ "type":"object", "description":"Request payload for summarizing compute metrics data.", "required":[ "timeBegin", "timeEnd", "aggregationType", "metricName", "interval" ], "properties":{ "aggregationType":{ "type":"string", "description":"The type of aggregation to apply.\n- Standard Aggregations: `MAX`, `MEAN`, `MIN`, `SUM`, `RATE`.\n- Percentile Aggregation: Use `Pxx`, where `xx` is the percentile value (e.g., `P80` for the 80th percentile).\n", "enum":[ "MAX", "MEAN", "MIN", "SUM", "RATE", "P50", "P80", "P90", "P95", "P99", "P99_9" ], "example":"P80" }, "metricName":{ "type":"string", "minLength":1, "maxLength":255, "description":"The metric to summarize. \n- Supported values include but are not limited to:\n - `CPU_UTILIZATION`, `MEMORY_UTILIZATION`, `FILE_SYSTEM_UTILIZATION`, `GC_CPU_UTILIZATION`\n - `DISK_READ_BYTES`, `DISK_WRITE_BYTES`, `NETWORK_RECEIVE_BYTES`, `NETWORK_TRANSMIT_BYTES`\n - `APP_STATUS`, `EXECUTOR_METRICS`, `SYSTEM_CPU`, `SYSTEM_MEMORY`\n - `SYSTEM_NETWORK_IN`, `SYSTEM_NETWORK_OUT`, `SYSTEM_DISK_READ`, `SYSTEM_DISK_WRITE`\n - Additional metrics such as task-related and shuffle metrics may be introduced in the future.\n- Refer to API documentation or contact support for the latest supported metric list.\n" }, "timeBegin":{ "type":"string", "format":"date-time", "description":"The beginning of the time range to use when searching for metric data points. Format is RFC 3339.", "x-default-description":"Default value is the timestamp 3 hours before the call was sent." }, "timeEnd":{ "type":"string", "format":"date-time", "description":"The end of the time range to use when searching for metric data points. Format is RFC 3339.", "x-default-description":"Default value is the timestamp representing when the call was sent." }, "interval":{ "type":"string", "description":"The time window used to convert the set of raw data points.\nThe timestamp of the aggregated data point corresponds to the end of the time window during which raw data points are assessed.\nFor example, for a five-minute interval, the timestamp \"2:05\" corresponds to the five-minute time window from 2:00:00 to 2:05:00.\n", "example":"5m" }, "resolution":{ "type":"string", "description":"The time between calculated aggregation windows. Use with the query interval to vary the frequency for returning aggregated data points.\nFor example, use a query interval of 5 minutes with a resolution of 1 minute to retrieve five-minute aggregations at a one-minute frequency.\nThe resolution must be equal to or less than the interval in the query.\nThe default resolution is 1m (one minute).\nSupported values: 1m-60m, 1h-24h, 1d.\n", "example":"1m" } } }, "SummarizeMetricsResponse":{ "type":"object", "description":"Response payload containing summarized metric data.", "required":[ "results" ], "properties":{ "results":{ "type":"array", "description":"List of computed metric summary results.", "items":{ "$ref":"#/definitions/MetricsSummary" } } } }, "MetricsSummary":{ "type":"object", "description":"A summarized metric result containing aggregated data points.", "required":[ "namespace", "compartmentId", "name", "dimensions", "aggregatedDataPoints" ], "properties":{ "namespace":{ "type":"string", "minLength":1, "maxLength":255, "description":"The source service or application that emitted the metric." }, "compartmentId":{ "type":"string", "minLength":1, "maxLength":255, "description":"The OCID of the compartment containing the resources that the aggregated data was returned from." }, "name":{ "type":"string", "minLength":1, "maxLength":255, "description":"The name of the metric." }, "dimensions":{ "type":"object", "description":"Key-value pairs that provide context for the metric.", "example":{ "resourceId":"ocid1.instance.region1.phx.exampleuniqueID" } }, "metadata":{ "type":"object", "description":"Additional references provided in the metric definition.", "example":{ "unit":"bytes" } }, "resolution":{ "type":"string", "description":"The time between calculated aggregation windows.", "example":"5m" }, "resourceGroup":{ "type":"string", "minLength":1, "maxLength":255, "description":"A custom string used for grouping related metrics." }, "aggregatedDataPoints":{ "type":"array", "description":"List of timestamp-value pairs for the metric.", "minItems":1, "items":{ "$ref":"#/definitions/AggregatedDataPoint" } } } }, "AggregatedDataPoint":{ "type":"object", "description":"A single aggregated data point.", "required":[ "timestamp", "value" ], "properties":{ "timestamp":{ "type":"string", "format":"date-time", "description":"The timestamp of the aggregated data point." }, "value":{ "type":"number", "format":"float", "description":"The computed metric value at the given timestamp." } } }, "DownloadClusterLogsDetails":{ "type":"object", "description":"Request payload for downloading logs in a cluster.", "required":[ "timeBegin", "timeEnd", "logContentTypeContains" ], "properties":{ "timeBegin":{ "type":"string", "format":"date-time", "description":"Start filter log's date and time, in RFC 3339 format.", "example":"2025-03-16T00:00:00Z" }, "timeEnd":{ "type":"string", "format":"date-time", "description":"End filter log's date and time, in RFC 3339 format.", "example":"2025-03-16T23:59:59Z" }, "logContentTypeContains":{ "type":"string", "description":"The string represent the type of compute logs \nCommon values include `events`, `driver`, `executor`.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n", "example":"events" }, "clientContext":{ "type":"string", "description":"UI-generated identifier to correlate the async job.\n" }, "subjectContains":{ "type":"string", "description":"The string represent the specific of compute nodes\nCommon values include `spark-driver`, `spark-executor-1`.\n", "example":"executor-1" }, "logLevel":{ "type":"string", "description":"The severity level of the log messages to filter. \nCommon values include `INFO`, `WARN`, `ERROR`, `DEBUG`, etc.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n", "example":"ERROR" }, "opcRequestId":{ "type":"string", "description":"The unique request identifier used for tracking the API call.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n", "example":"bce8d78b-6f12-4a99-95d2-3f44440c54a9" }, "thread":{ "type":"string", "description":"The thread identifier that generated the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n", "example":"oracle.dataflow.commons.server.uds.UdsRequestHandlerTask" }, "executionContextId":{ "type":"string", "description":"The execution context identifier associated with the log.\nSupported only when `logContentTypeContains` is `executor` or `driver`.\n", "example":"aaa-bbb-ccc-ddd" }, "logStreamTypeContains":{ "type":"string", "description":"Filters logs based on the output stream type. \n- This includes standard output (`stdout`) for regular program output \n- and standard error (`stderr`) for error messages and diagnostics.\nOnly supported when logContentTypeContains=executor/driver.\n", "example":"stderr" }, "eventType":{ "type":"string", "description":"Filters logs based on the event type.\nSupported only when `logContentTypeContains` is `events`.\n", "example":"CREATING" } } }, "MasterCatalogLifecycleState":{ "description":"The state of the Master Catalog", "type":"string", "enum":[ "ACTIVE", "CREATING", "DELETING" ] }, "MasterCatalog":{ "description":"A Data Lake Master Catalog is a ...\n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n", "type":"object", "required":[ "key", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The key of the Data Lake Master Catalog.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique and it's changeable.", "type":"string" }, "description":{ "description":"Short description of the catalog", "type":"string" }, "lifecycleState":{ "description":"The state of the Catalog.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/MasterCatalogLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "timeCreated":{ "description":"The date and time the Data Lake Master Catalog was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Data Lake Master Catalog was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The userId which created the catalog.\n", "type":"string" }, "updatedBy":{ "description":"The userId which last updated the catalog\n", "type":"string" } } }, "MasterCatalogSummary":{ "description":"Summary information about a Master Catalog.", "type":"object", "required":[ "key", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The key of the Data Lake Master Catalog.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique and it's changeable.", "type":"string" }, "description":{ "description":"Short description of the catalog", "type":"string" }, "lifecycleState":{ "description":"The state of the Catalog.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/MasterCatalogLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "timeCreated":{ "description":"The date and time the Data Lake Master Catalog was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Data Lake Master Catalog was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The userId which created the catalog.\n", "type":"string" }, "updatedBy":{ "description":"The userId which last updated the catalog\n", "type":"string" } } }, "CreateMasterCatalogDetails":{ "description":"The data to create a Master Catalog.", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique and it's changeable.", "type":"string" }, "description":{ "description":"Short description of the catalog", "type":"string" } } }, "UpdateMasterCatalogDetails":{ "description":"The data to update a Master Catalog.", "type":"object", "properties":{ "description":{ "description":"Short description of the catalog", "type":"string" } } }, "MasterCatalogCollection":{ "type":"object", "description":"Result of listing Master Catalogs", "required":[ "items" ], "properties":{ "items":{ "description":"List of Master Catalogs.", "type":"array", "items":{ "$ref":"#/definitions/MasterCatalogSummary" } } } }, "AttachMasterCatalogToClusterDetails":{ "description":"Details to attach a Master Catalog to a Cluster", "type":"object", "required":[ "clusterKey" ], "properties":{ "clusterKey":{ "description":"The key of the Cluster to attach Master Catalog", "type":"string" } } }, "MasterCatalogPrivilege":{ "description":"The privilege for a Master Catalog. MASTER CATALOG ADMIN: This permission will allow the user to: - Grant/Revoke permissions - View all catalogs in the Master Catalog - Create Catalogs - DELETE Catalog CREATE CATALOG: This permission will enable users to add create a catalog (internal or external)", "type":"string", "enum":[ "CREATE_CATALOG", "ADMIN", "CREATE_SHARE", "CREATE_RECIPIENT", "CREATE_CREDENTIAL" ] }, "AssignMasterCatalogPermissionDetails":{ "description":"The details of the permissions assigned on the MasterCatalog to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/MasterCatalogPrivilege", "enum":[ "CREATE_CATALOG", "ADMIN", "CREATE_SHARE", "CREATE_RECIPIENT", "CREATE_CREDENTIAL" ] } } } }, "RevokeMasterCatalogPermissionDetails":{ "description":"The details of the permissions revoked from assignees for a MasterCatalog.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/MasterCatalogPrivilege", "enum":[ "CREATE_CATALOG", "ADMIN", "CREATE_SHARE", "CREATE_RECIPIENT", "CREATE_CREDENTIAL" ] } } } }, "MasterCatalogPermissionCollection":{ "type":"object", "description":"List of Master Catalog permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Master Catalog permissions.", "type":"array", "items":{ "$ref":"#/definitions/MasterCatalogPermissionSummary" } } } }, "MasterCatalogPermissionSummary":{ "description":"Summary information about a Master Catalog Permission.", "type":"object", "properties":{ "grantee":{ "description":"The ocid of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a Master Catalog.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/MasterCatalogPrivilege", "enum":[ "CREATE_CATALOG", "ADMIN", "CREATE_SHARE", "CREATE_RECIPIENT", "CREATE_CREDENTIAL" ] } } } }, "ManageMasterCatalogPermissionDetails":{ "description":"Information to update permissions on a Master Catalog.", "type":"object", "properties":{ "assignMasterCatalogPermissionDetails":{ "$ref":"#/definitions/AssignMasterCatalogPermissionDetails" }, "revokeMasterCatalogPermissionDetails":{ "$ref":"#/definitions/RevokeMasterCatalogPermissionDetails" } } }, "AdwExternalCatalogConnectionPropertyKey":{ "description":"ADW external catalog connection property keys.", "type":"string", "enum":[ "ADW_WALLET_CONTENT_BASE64", "ADW_WALLET_PASSWORD", "ADW_USERNAME", "ADW_PASSWORD", "ADW_TNS_ALIAS", "ADW_STAGING_TENANCY_OCID", "ADW_STAGING_REGION", "ADW_STAGING_NAMESPACE", "ADW_STAGING_BUCKET", "ADW_STAGING_FILE_PREFIX" ] }, "AlhExternalCatalogConnectionPropertyKey":{ "description":"ALH external catalog connection property keys.", "type":"string", "enum":[ "ALH_WALLET_CONTENT_BASE64", "ALH_WALLET_PASSWORD", "ALH_USERNAME", "ALH_PASSWORD", "ALH_TNS_ALIAS", "ALH_STAGING_TENANCY_OCID", "ALH_STAGING_REGION", "ALH_STAGING_NAMESPACE", "ALH_STAGING_BUCKET", "ALH_STAGING_FILE_PREFIX" ] }, "OracleExternalCatalogConnectionPropertyKey":{ "description":"Oracle Database external catalog connection property keys.", "type":"string", "enum":[ "ORACLE_WALLET_CONTENT_BASE64", "ORACLE_WALLET_PASSWORD", "ORACLE_USERNAME", "ORACLE_PASSWORD", "ORACLE_HOST", "ORACLE_PORT", "ORACLE_DATABASE_NAME", "ORACLE_DATABASE_SID", "ORACLE_SSL_ENABLED", "ORACLE_STAGING_TENANCY_OCID", "ORACLE_STAGING_REGION", "ORACLE_STAGING_NAMESPACE", "ORACLE_STAGING_BUCKET", "ORACLE_STAGING_FILE_PREFIX" ] }, "ExadataExternalCatalogConnectionPropertyKey":{ "description":"Exadata external catalog connection property keys.", "type":"string", "enum":[ "EXADATA_WALLET_CONTENT_BASE64", "EXADATA_WALLET_PASSWORD", "EXADATA_USERNAME", "EXADATA_PASSWORD", "EXADATA_HOST", "EXADATA_PORT", "EXADATA_DATABASE_NAME", "EXADATA_DATABASE_SID", "EXADATA_SSL_ENABLED", "EXADATA_STAGING_TENANCY_OCID", "EXADATA_STAGING_REGION", "EXADATA_STAGING_NAMESPACE", "EXADATA_STAGING_BUCKET", "EXADATA_STAGING_FILE_PREFIX", "WORKSPACE_KEY" ] }, "AtpExternalCatalogConnectionPropertyKey":{ "description":"ATP external catalog connection property keys.", "type":"string", "enum":[ "ATP_WALLET_CONTENT_BASE64", "ATP_WALLET_PASSWORD", "ATP_USERNAME", "ATP_PASSWORD", "ATP_TNS_ALIAS", "ATP_STAGING_TENANCY_OCID", "ATP_STAGING_REGION", "ATP_STAGING_NAMESPACE", "ATP_STAGING_BUCKET", "ATP_STAGING_FILE_PREFIX" ] }, "KafkaExternalCatalogConnectionPropertyKey":{ "description":"Kafka external catalog connection property keys.", "type":"string", "enum":[ "BOOTSTRAP_SERVERS", "USERNAME", "PASSWORD", "ENABLE_SSL", "SASL_MODE" ] }, "CatalogPropertyKey":{ "description":"Catalog property keys.", "type":"string", "enum":[ "BUCKET_LOCATION_COMPARTMENT_ID" ] }, "CatalogType":{ "description":"The catalog type. Internal (Standard) or external.", "type":"string", "enum":[ "EXTERNAL", "INTERNAL" ] }, "CrawlerLastRefreshStatus":{ "description":"The status for an entity refresh.", "type":"string", "enum":[ "FAILED", "SUCCESS", "IN_PROGRESS" ] }, "ExternalCatalogSourceType":{ "description":"The source type of an external catalog.", "type":"string", "enum":[ "ADW", "ALH", "KAFKA", "ATP", "ORACLE", "EXADATA" ] }, "CatalogLifecycleState":{ "description":"The current status of the catalog.", "type":"string", "enum":[ "ACTIVE", "CREATING", "DELETING", "UPDATING" ] }, "Catalog":{ "description":"AI Data Platform Workbench catalogs enable you to manage your data and metadata.\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\nIAM Policies for Oracle AI Data Platform Workbench.\n", "type":"object", "required":[ "key", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The AI Data Platform Workbench catalog key.", "type":"string" }, "displayName":{ "description":"Catalog display name.", "type":"string" }, "description":{ "description":"Short description of the catalog.", "type":"string" }, "catalogGuid":{ "description":"Unique identifier for catalog.", "type":"string" }, "catalogType":{ "type":"string", "description":"Type of catalog.", "x-obmcs-top-level-enum":"#/definitions/CatalogType", "enum":[ "EXTERNAL", "INTERNAL" ] }, "sourceType":{ "type":"string", "description":"External catalog source type.", "x-obmcs-top-level-enum":"#/definitions/ExternalCatalogSourceType", "enum":[ "ADW", "ALH", "KAFKA", "ATP", "ORACLE", "EXADATA" ] }, "connectionDetails":{ "$ref":"#/definitions/CatalogConnectionDetails" }, "lifecycleState":{ "description":"The current status of the catalog.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CatalogLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING", "UPDATING" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "timeCreated":{ "description":"The date and time the AI Data Platform Workbench catalog was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the AI Data Platform Workbench catalog was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user that created the catalog.", "type":"string" }, "updatedBy":{ "description":"The ID of the last user to update the catalog.", "type":"string" }, "properties":{ "description":"Key-value pair used to provide catalog properties like the subCompartment OCID where the buckets need to reside.", "type":"object", "additionalProperties":{ "type":"string" } } } }, "CatalogTestConnectionDetails":{ "description":"Information needed to test connection to an external catalog.", "type":"object", "properties":{ "key":{ "description":"The AI Data Platform Workbench catalog key.", "type":"string" }, "sourceType":{ "type":"string", "description":"External catalog source type.", "x-obmcs-top-level-enum":"#/definitions/ExternalCatalogSourceType", "enum":[ "ADW", "ALH", "KAFKA", "ATP", "ORACLE", "EXADATA" ] }, "connectionDetails":{ "$ref":"#/definitions/CatalogConnectionDetails" } } }, "CatalogSummary":{ "description":"Summary information about a catalog.", "type":"object", "required":[ "key", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The AI Data Platform Workbench catalog key.", "type":"string" }, "displayName":{ "description":"Catalog display name.", "type":"string" }, "description":{ "description":"Short description of the catalog.", "type":"string" }, "catalogType":{ "type":"string", "description":"Type of catalog.", "x-obmcs-top-level-enum":"#/definitions/CatalogType", "enum":[ "EXTERNAL", "INTERNAL" ] }, "catalogGuid":{ "description":"Unique identifier for catalog.", "type":"string" }, "sourceType":{ "type":"string", "description":"External catalog source type.", "x-obmcs-top-level-enum":"#/definitions/ExternalCatalogSourceType", "enum":[ "ADW", "ALH", "KAFKA", "ATP", "ORACLE", "EXADATA" ] }, "lifecycleState":{ "description":"The current status of the catalog.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CatalogLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING", "UPDATING" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "timeCreated":{ "description":"The date and time the AI Data Platform Workbench catalog was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the AI Data Platform Workbench catalog was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user that created the catalog.", "type":"string" }, "updatedBy":{ "description":"The ID of the last user to update the catalog.", "type":"string" }, "lastRefreshStatus":{ "description":"The status for last refresh performed on catalog.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CrawlerLastRefreshStatus", "enum":[ "FAILED", "SUCCESS", "IN_PROGRESS" ] }, "timeLastRefresh":{ "description":"The timestamp for last refresh performed on catalog.", "type":"string", "format":"date-time" } } }, "CatalogConnectionDetails":{ "description":"The details of a connection associated with a catalog.", "type":"object", "required":[ "connectionProperties" ], "properties":{ "displayName":{ "description":"Connection name.", "type":"string", "maxLength":255 }, "connectionProperties":{ "description":"Connection properties.", "type":"object", "additionalProperties":{ "type":"string" } } } }, "CreateConnectionDetails":{ "description":"The details of a connection associated with a catalog.", "type":"object", "required":[ "connectionProperties" ], "properties":{ "connectionProperties":{ "description":"Connection properties.", "type":"object", "additionalProperties":{ "type":"string" } } } }, "UpdateConnectionDetails":{ "description":"The details of a connection associated with a catalog.", "type":"object", "required":[ "connectionProperties" ], "properties":{ "connectionProperties":{ "description":"Connection properties.", "type":"object", "additionalProperties":{ "type":"string" } } } }, "CreateCatalogDetails":{ "description":"The required details for creating catalog.", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "description":"Catalog display name.", "type":"string" }, "description":{ "description":"Short description of the catalog.", "type":"string" }, "catalogType":{ "type":"string", "description":"Type of catalog.", "x-obmcs-top-level-enum":"#/definitions/CatalogType", "enum":[ "EXTERNAL", "INTERNAL" ] }, "sourceType":{ "type":"string", "description":"External catalog source type.", "x-obmcs-top-level-enum":"#/definitions/ExternalCatalogSourceType", "enum":[ "ADW", "ALH", "KAFKA", "ATP", "ORACLE", "EXADATA" ] }, "properties":{ "description":"Key-value pair used to provide catalog properties like the subCompartment OCID where the buckets need to reside.", "type":"object", "additionalProperties":{ "type":"string" } }, "connectionDetails":{ "$ref":"#/definitions/CreateConnectionDetails" } } }, "UpdateCatalogDetails":{ "description":"The details to update in a catalog.", "type":"object", "properties":{ "displayName":{ "description":"Catalog display name.", "type":"string" }, "description":{ "description":"Short description of the catalog.", "type":"string" }, "connectionDetails":{ "$ref":"#/definitions/UpdateConnectionDetails" }, "properties":{ "description":"Key-value pair used to provide catalog properties like the subCompartment OCID where the buckets need to reside.", "type":"object", "additionalProperties":{ "type":"string" } } } }, "CatalogCollection":{ "type":"object", "description":"Catalog List", "required":[ "items" ], "properties":{ "items":{ "description":"List of catalogs.", "type":"array", "items":{ "$ref":"#/definitions/CatalogSummary" } } } }, "CatalogPrivilege":{ "description":"Catalog privilege", "type":"string", "enum":[ "SELECT", "MANAGE", "CREATE_SCHEMA", "ADMIN" ] }, "CatalogPermissionCollection":{ "type":"object", "description":"Catalog permissions", "required":[ "items" ], "properties":{ "items":{ "description":"List of catalog permissions.", "type":"array", "items":{ "$ref":"#/definitions/CatalogPermissionSummary" } } } }, "CatalogPermissionSummary":{ "description":"Summary information about a Catalog Permission.", "type":"object", "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a catalog.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/CatalogPrivilege", "enum":[ "SELECT", "MANAGE", "CREATE_SCHEMA", "ADMIN" ] } } } }, "AssignCatalogPermissionDetails":{ "description":"The details of the permissions assigned on the catalog to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/CatalogPrivilege", "enum":[ "SELECT", "MANAGE", "CREATE_SCHEMA", "ADMIN" ] } } } }, "RevokeCatalogPermissionDetails":{ "description":"The details of the permissions revoked from assignees for a catalog.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/CatalogPrivilege", "enum":[ "SELECT", "MANAGE", "CREATE_SCHEMA", "ADMIN" ] } } } }, "ManageCatalogPermissionDetails":{ "description":"Information to update permissions on a catalog.", "type":"object", "properties":{ "assignCatalogPermissionDetails":{ "$ref":"#/definitions/AssignCatalogPermissionDetails" }, "revokeCatalogPermissionDetails":{ "$ref":"#/definitions/RevokeCatalogPermissionDetails" } } }, "ExecuteDatabaseUserWorkflowsDetails":{ "type":"object", "description":"Base schema for database user workflow execution. Contains common workflow fields.", "required":[ "actionType" ], "properties":{ "actionType":{ "type":"string", "description":"Determines which child schema this request maps to" } }, "discriminator":"actionType" }, "ProvisionUserSchemaDetails":{ "type":"object", "description":"Provision user schema which includes creating user schema, persist credentials in credential store.", "allOf":[ { "$ref":"#/definitions/ExecuteDatabaseUserWorkflowsDetails" }, { "discriminator":"PROVISION_USER_SCHEMA", "properties":{ "userSchemaName":{ "type":"string", "description":"The user schema name. Example: AIDP__KB_READONLY", "minLength":1, "maxLength":255 }, "grants":{ "type":"array", "description":"The grants to be assigned to the user schema.", "maxItems":100, "items":{ "type":"string" } } } } ] }, "DeProvisionUserSchemasDetails":{ "type":"object", "description":"Deprovision user schemas created by AI Data Platform Workbench.", "allOf":[ { "$ref":"#/definitions/ExecuteDatabaseUserWorkflowsDetails" }, { "discriminator":"DEPROVISION_USER_SCHEMAS" } ] }, "EmbeddingModelDetails":{ "type":"object", "description":"The embedding models which need to be enabled along with their storage location.", "allOf":[ { "$ref":"#/definitions/ExecuteDatabaseUserWorkflowsDetails" }, { "discriminator":"LOAD_EMBEDDING_MODELS", "properties":{ "onnxModelFiles":{ "type":"string", "description":"CSV list of models, e.g. \",\"" }, "locationUri":{ "type":"string", "description":"Directory for the models listed in onnxModelFiles." } } } ] }, "ExecuteSqlCommandDetails":{ "type":"object", "description":"Running SQL command.", "allOf":[ { "$ref":"#/definitions/ExecuteDatabaseUserWorkflowsDetails" }, { "discriminator":"EXECUTE_SQL_COMMAND", "properties":{ "userSchemaName":{ "type":"string", "description":"The user schema name. Only supports a valid knowledge base user and ADMIN.", "minLength":1, "maxLength":255 }, "sqlCommand":{ "type":"string", "description":"Base64-encoded SQL command." } } } ] }, "SchemaDetailsKey":{ "description":"Schema details key. This can be referred to when the related catalog is an external (Non-ADW) catalog.", "type":"string", "enum":[ "PARTITIONS", "REPLICATION_FACTOR", "BOOTSTRAP_SERVERS", "PARTITIONS_DETAILS" ] }, "SchemaLifecycleState":{ "description":"The current state of the schema.", "type":"string", "enum":[ "ACTIVE", "CREATING", "DELETING" ] }, "TableLifecycleState":{ "description":"The current state of the table.", "type":"string", "enum":[ "ACTIVE", "CREATING", "DELETING", "UPDATING" ] }, "ViewLifecycleState":{ "description":"The state of the View", "type":"string", "enum":[ "ACTIVE" ] }, "SchemaCatalogType":{ "description":"The type of catalog for the schema.", "type":"string", "enum":[ "ADW", "ALH", "STANDARD", "KAFKA_TOPIC", "ATP", "ORACLE", "EXADATA" ] }, "TableCatalogType":{ "description":"The type of catalog for the table.", "type":"string", "enum":[ "ADW", "ALH", "STANDARD", "ATP", "ORACLE", "EXADATA" ] }, "Schema":{ "description":"Schema in data catalogs are constructs to organize data. Schema can contain tables, which contain structured data,\nand volumes, which contain unstructured data. A default schema is created in all standard catalogs created in the\nMaster Catalog. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\nIAM Policies for Oracle AI Data Platform Workbench.\n", "type":"object", "discriminator":"entityType", "required":[ "entityType", "key", "displayName" ], "properties":{ "entityType":{ "description":"An enum to decide the type of the derived model.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SchemaCatalogType", "enum":[ "ADW", "ALH", "STANDARD", "KAFKA_TOPIC", "ATP", "ORACLE", "EXADATA" ] }, "key":{ "description":"The fully qualified name of the schema in the format ..", "type":"string" }, "displayName":{ "description":"Schema name.", "type":"string" }, "description":{ "description":"Schema description.", "type":"string" }, "timeCreated":{ "description":"The date and time the schema was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the schema was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"ID of the user who created the schema.", "type":"string" }, "updatedBy":{ "description":"ID of the user who last updated the schema.", "type":"string" }, "properties":{ "description":"Key-value pair representing a defined tag key and value.", "type":"object", "additionalProperties":{ "type":"string" } }, "catalogName":{ "description":"The name of the catalog to which this schema belongs.", "type":"string" }, "lifecycleState":{ "description":"The current state of the schema.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SchemaLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "details":{ "description":"Deprecated field. Map of key-value pairs. This object will be only provided when the parent catalog is external.", "type":"object", "x-deprecated":true, "additionalProperties":{ "type":"string" } } } }, "StandardSchema":{ "description":"Derived model for schema of a standard catalog.", "allOf":[ { "$ref":"#/definitions/Schema" }, { "discriminator":"STANDARD" } ] }, "AdwSchema":{ "description":"Derived model for schema of a ADW external catalog.", "allOf":[ { "$ref":"#/definitions/Schema" }, { "discriminator":"ADW" } ] }, "AlhSchema":{ "description":"Derived model for schema of a ALH external catalog.", "allOf":[ { "$ref":"#/definitions/Schema" }, { "discriminator":"ALH" } ] }, "OracleSchema":{ "description":"Derived model for schema of a Oracle external catalog.", "allOf":[ { "$ref":"#/definitions/Schema" }, { "discriminator":"ORACLE" } ] }, "ExadataSchema":{ "description":"Derived model for schema of a Exadata external catalog.", "allOf":[ { "$ref":"#/definitions/Schema" }, { "discriminator":"EXADATA" } ] }, "KafkaTopicSchema":{ "description":"Derived model for topic of a Kafka external catalog.", "allOf":[ { "$ref":"#/definitions/Schema" }, { "discriminator":"KAFKA_TOPIC", "required":[ "partitionDetails" ], "properties":{ "partitions":{ "description":"The number of partitions in the Kafka topic.", "type":"string" }, "replicationFactor":{ "description":"The replication factor.", "type":"string" }, "bootstrapServers":{ "description":"Bootstrap servers for the Kafka topic.", "type":"string" }, "partitionDetails":{ "description":"The details of the partitions in Kafka topic.", "type":"string" } } } ] }, "AtpSchema":{ "description":"Derived model for schema of a ATP external catalog.", "allOf":[ { "$ref":"#/definitions/Schema" }, { "discriminator":"ATP" } ] }, "SchemaSummary":{ "description":"Summary information about a schema.", "type":"object", "discriminator":"entityType", "required":[ "entityType", "key", "displayName" ], "properties":{ "entityType":{ "description":"An enum to decide the type of the derived model.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SchemaCatalogType", "enum":[ "ADW", "ALH", "STANDARD", "KAFKA_TOPIC", "ATP", "ORACLE", "EXADATA" ] }, "key":{ "description":"The fully qualified name of the schema in the format ..", "type":"string" }, "displayName":{ "description":"Schema name.", "type":"string" }, "description":{ "description":"Schema description.", "type":"string" }, "timeCreated":{ "description":"The date and time the schema was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the schema was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"ID of the user who created the schema.", "type":"string" }, "updatedBy":{ "description":"ID of the user who last updated the schema.", "type":"string" }, "lifecycleState":{ "description":"The current state of the schema.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SchemaLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING" ] }, "details":{ "description":"Deprecated field. Map of key-value pairs. This object will be only provided when the parent catalog is external.", "type":"object", "x-deprecated":true, "additionalProperties":{ "type":"string" } }, "lastRefreshStatus":{ "description":"The status for last refresh performed on schema.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CrawlerLastRefreshStatus", "enum":[ "FAILED", "SUCCESS", "IN_PROGRESS" ] }, "timeLastRefresh":{ "description":"The timestamp for last refresh performed on schema.", "type":"string", "format":"date-time" } } }, "StandardSchemaSummary":{ "description":"Derived model for schema of a standard catalog.", "allOf":[ { "$ref":"#/definitions/SchemaSummary" }, { "discriminator":"STANDARD" } ] }, "AdwSchemaSummary":{ "description":"Derived model for topic of a ADW external catalog.", "allOf":[ { "$ref":"#/definitions/SchemaSummary" }, { "discriminator":"ADW" } ] }, "AlhSchemaSummary":{ "description":"Derived model for topic of a ALH external catalog.", "allOf":[ { "$ref":"#/definitions/SchemaSummary" }, { "discriminator":"ALH" } ] }, "OracleSchemaSummary":{ "description":"Derived model for topic of a Oracle external catalog.", "allOf":[ { "$ref":"#/definitions/SchemaSummary" }, { "discriminator":"ORACLE" } ] }, "ExadataSchemaSummary":{ "description":"Derived model for topic of a Exadata external catalog.", "allOf":[ { "$ref":"#/definitions/SchemaSummary" }, { "discriminator":"EXADATA" } ] }, "KafkaTopicSchemaSummary":{ "description":"Derived model for topic of a Kafka external catalog.", "allOf":[ { "$ref":"#/definitions/SchemaSummary" }, { "discriminator":"KAFKA_TOPIC", "properties":{ "partitions":{ "description":"The number of partitions in the Kafka topic.", "type":"string" }, "replicationFactor":{ "description":"The replication factor.", "type":"string" } } } ] }, "AtpSchemaSummary":{ "description":"Derived model for topic of a ATP external catalog.", "allOf":[ { "$ref":"#/definitions/SchemaSummary" }, { "discriminator":"ATP" } ] }, "CreateSchemaDetails":{ "description":"The data to create a schema.", "type":"object", "required":[ "displayName", "catalogName" ], "properties":{ "displayName":{ "description":"Schema name.", "type":"string" }, "description":{ "description":"Schema description.", "type":"string" }, "properties":{ "description":"Key-value pair representing a defined tag key and value.", "type":"object", "additionalProperties":{ "type":"string" } }, "catalogName":{ "description":"The name of the catalog to which this schema belongs.", "type":"string" } } }, "UpdateSchemaDetails":{ "description":"The data to update a schema.", "type":"object", "properties":{ "displayName":{ "description":"Schema name.", "type":"string" }, "description":{ "description":"Schema description.", "type":"string" }, "properties":{ "description":"Key-value pair representing a defined tag key and value.", "type":"object", "additionalProperties":{ "type":"string" } } } }, "SchemaCollection":{ "type":"object", "description":"Result of listing schemas.", "required":[ "items" ], "properties":{ "items":{ "description":"List of schemas.", "type":"array", "items":{ "$ref":"#/definitions/SchemaSummary" } } } }, "SchemaPrivilegeForManage":{ "description":"The privilege for a schema.", "type":"string", "enum":[ "SELECT", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "ADMIN", "CREATE_KNOWLEDGE_BASE" ] }, "SchemaPrivilege":{ "description":"The privilege for a schema. This privilege could be inherited from the object higher up in hierarchy.", "type":"string", "enum":[ "SELECT", "MANAGE", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE", "ADMIN" ] }, "SchemaPermissionCollection":{ "type":"object", "description":"List of schema permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of schema permissions.", "type":"array", "items":{ "$ref":"#/definitions/SchemaPermissionSummary" } } } }, "SchemaPermissionSummary":{ "description":"Information about a schema permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"Simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"Type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"Selected permissions for a schema.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/SchemaPrivilege", "enum":[ "SELECT", "MANAGE", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE", "ADMIN" ] } }, "isInherited":{ "type":"boolean", "description":"Permission listed is inherited or not from object higher up in hierarchy." }, "resourceName":{ "type":"string", "description":"Name of the object to which this permission belongs. This would be the name of schema if permission is not inherited or name of object higher up in hierarchy if permission is inherited." } } }, "AssignSchemaPermissionDetails":{ "description":"The details of the permissions assigned on the schema to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/SchemaPrivilegeForManage", "enum":[ "SELECT", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "ADMIN", "CREATE_KNOWLEDGE_BASE" ] } } } }, "RevokeSchemaPermissionDetails":{ "description":"The details of the permissions revoked from assignees for a schema.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/SchemaPrivilegeForManage", "enum":[ "SELECT", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "ADMIN", "CREATE_KNOWLEDGE_BASE" ] } } } }, "ManageSchemaPermissionDetails":{ "description":"Information to update permissions on a schema.", "type":"object", "properties":{ "assignSchemaPermissionDetails":{ "$ref":"#/definitions/AssignSchemaPermissionDetails" }, "revokeSchemaPermissionDetails":{ "$ref":"#/definitions/RevokeSchemaPermissionDetails" } } }, "TableType":{ "description":"Table type.", "type":"string", "enum":[ "MANAGED", "EXTERNAL" ] }, "ExternalTableLocationType":{ "description":"The location type of an external table.", "type":"string", "minLength":1, "maxLength":255, "enum":[ "OBJECT_STORAGE", "MOUNT" ], "default":"OBJECT_STORAGE" }, "DataFormat":{ "description":"The table data format type.", "type":"string", "minLength":1, "maxLength":255, "enum":[ "AVRO", "ORC", "PARQUET", "TEXTFILE", "JSON", "CSV", "DELTA", "ICEBERG" ] }, "Table":{ "description":"Information about the table in the schema.", "type":"object", "discriminator":"entityType", "required":[ "entityType", "displayName" ], "properties":{ "entityType":{ "description":"An enum to decide the type of the derived model", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TableCatalogType", "enum":[ "ADW", "ALH", "STANDARD", "ATP", "ORACLE", "EXADATA" ] }, "key":{ "description":"The fully qualified name of the table in the format ...", "type":"string" }, "displayName":{ "description":"Table name.", "type":"string" }, "catalogKey":{ "description":"The name of the catalog to which this table belongs.", "type":"string" }, "schemaKey":{ "description":"The name of the schema to which this table belongs.", "type":"string" }, "location":{ "description":"Location of the table data.", "type":"string" }, "description":{ "description":"Table description.", "type":"string" }, "tableType":{ "description":"Type of table. Managed, external or mount table.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TableType", "enum":[ "MANAGED", "EXTERNAL" ] }, "managedTableDefinition":{ "$ref":"#/definitions/ManagedTableDefinition" }, "externalTableDefinition":{ "$ref":"#/definitions/ExternalTableDefinition" }, "tableFields":{ "description":"Columns for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "partitionKeys":{ "description":"Columns to be used in partition for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "tableProperties":{ "description":"Table properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/TableProperty" } }, "timeCreated":{ "description":"The date and time the table was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the table was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the table.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the schema.", "type":"string", "minLength":1, "maxLength":255 }, "lifecycleState":{ "description":"The state of the table.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TableLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING", "UPDATING" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" } } }, "StandardTable":{ "description":"Derived model for table of a standard catalog.", "allOf":[ { "$ref":"#/definitions/Table" }, { "discriminator":"STANDARD" } ] }, "AdwTable":{ "description":"Derived model for table of a ADW catalog.", "allOf":[ { "$ref":"#/definitions/Table" }, { "discriminator":"ADW" } ] }, "AlhTable":{ "description":"Derived model for table of a ALH catalog.", "allOf":[ { "$ref":"#/definitions/Table" }, { "discriminator":"ALH" } ] }, "OracleTable":{ "description":"Derived model for table of a Oracle catalog.", "allOf":[ { "$ref":"#/definitions/Table" }, { "discriminator":"ORACLE" } ] }, "ExadataTable":{ "description":"Derived model for table of a Exadata catalog.", "allOf":[ { "$ref":"#/definitions/Table" }, { "discriminator":"EXADATA" } ] }, "AtpTable":{ "description":"Derived model for table of a ATP catalog.", "allOf":[ { "$ref":"#/definitions/Table" }, { "discriminator":"ATP" } ] }, "TableSummary":{ "description":"Summary information of table in the schema.", "type":"object", "discriminator":"entityType", "required":[ "entityType" ], "properties":{ "entityType":{ "description":"An enum to decide the type of the derived model", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TableCatalogType", "enum":[ "ADW", "ALH", "STANDARD", "ATP", "ORACLE", "EXADATA" ] }, "key":{ "description":"The fully qualified name of the table in the format ...", "type":"string" }, "displayName":{ "description":"Table name.", "type":"string" }, "tableType":{ "description":"Type of table. Managed, external or mount table.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TableType", "enum":[ "MANAGED", "EXTERNAL" ] }, "timeCreated":{ "description":"The date and time the table was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the table was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the table.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the schema.", "type":"string", "minLength":1, "maxLength":255 }, "lifecycleState":{ "description":"The state of the table.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TableLifecycleState", "enum":[ "ACTIVE", "CREATING", "DELETING", "UPDATING" ] } } }, "StandardTableSummary":{ "description":"Derived model for table summary of a standard catalog.", "allOf":[ { "$ref":"#/definitions/TableSummary" }, { "discriminator":"STANDARD" } ] }, "AdwTableSummary":{ "description":"Derived model for table summary of a ADW catalog.", "allOf":[ { "$ref":"#/definitions/TableSummary" }, { "discriminator":"ADW" } ] }, "AlhTableSummary":{ "description":"Derived model for table summary of a ALH catalog.", "allOf":[ { "$ref":"#/definitions/TableSummary" }, { "discriminator":"ALH" } ] }, "OracleTableSummary":{ "description":"Derived model for table summary of a Oracle catalog.", "allOf":[ { "$ref":"#/definitions/TableSummary" }, { "discriminator":"ORACLE" } ] }, "ExadataTableSummary":{ "description":"Derived model for table summary of a Exadata catalog.", "allOf":[ { "$ref":"#/definitions/TableSummary" }, { "discriminator":"EXADATA" } ] }, "AtpTableSummary":{ "description":"Derived model for table summary of a ATP catalog.", "allOf":[ { "$ref":"#/definitions/TableSummary" }, { "discriminator":"ATP" } ] }, "TableCollection":{ "type":"object", "description":"Result of listing tables in a schema.", "required":[ "items" ], "properties":{ "items":{ "description":"List of tables.", "type":"array", "items":{ "$ref":"#/definitions/TableSummary" } } } }, "CreateTableDetails":{ "description":"The data to create a table.", "type":"object", "required":[ "displayName", "catalogKey", "schemaKey", "tableType" ], "properties":{ "displayName":{ "description":"Table name.", "type":"string" }, "catalogKey":{ "description":"The name of the catalog to which this table belongs.", "type":"string" }, "schemaKey":{ "description":"The name of the schema to which this table belongs.", "type":"string" }, "description":{ "description":"Table description.", "type":"string" }, "tableType":{ "description":"Type of table. Managed, external or mount table.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TableType", "enum":[ "MANAGED", "EXTERNAL" ] }, "managedTableDefinition":{ "$ref":"#/definitions/ManagedTableDefinition" }, "externalTableDefinition":{ "$ref":"#/definitions/ExternalTableDefinition" }, "tableFields":{ "description":"Columns for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "partitionKeys":{ "description":"Columns to be used in partition for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "tableProperties":{ "description":"Table properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/TableProperty" } } } }, "CreateDataTableDetails":{ "description":"The details to create a managed table with data.", "type":"object", "required":[ "displayName", "catalogKey", "schemaKey", "tableFields", "managedTableDefinition", "selectedColumns", "fileFormat", "objectStorageLocationPath" ], "properties":{ "displayName":{ "description":"Table name.", "type":"string" }, "description":{ "description":"Table description.", "type":"string" }, "catalogKey":{ "description":"The name of the catalog to which this table belongs.", "type":"string" }, "schemaKey":{ "description":"The name of the schema to which this table belongs.", "type":"string" }, "tableFields":{ "description":"Columns for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "partitionKeys":{ "description":"Columns to be used in partition for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "tableProperties":{ "description":"Table properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/TableProperty" } }, "managedTableDefinition":{ "$ref":"#/definitions/ManagedTableDefinition" }, "selectedColumns":{ "description":"The list of the columns from which data needs to be copied.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "fileFormat":{ "description":"Format of the sample file from which data needs to be copied.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DataFormat", "enum":[ "AVRO", "ORC", "PARQUET", "TEXTFILE", "JSON", "CSV", "DELTA", "ICEBERG" ] }, "objectStorageLocationPath":{ "description":"The file location from which table details will be used.", "type":"string", "minLength":1, "maxLength":1024 } } }, "UpdateTableDetails":{ "description":"The data to update a table.", "type":"object", "properties":{ "displayName":{ "description":"Table name.", "type":"string" }, "description":{ "description":"Table description.", "type":"string" }, "addTableFields":{ "description":"Columns for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "dropTableFields":{ "description":"Columns for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/TableFieldDetails" } }, "renameTableFields":{ "description":"Columns for table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/RenameTableFieldDetails" } }, "addTableProperties":{ "description":"Table properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/TableProperty" } }, "dropTableProperties":{ "description":"Table properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/TableProperty" } }, "updateTableFields":{ "description":"Update columns in table.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/UpdateTableFieldDetails" } } } }, "ParAccessType":{ "description":"The operation that can be performed on this resource.", "type":"string", "enum":[ "OBJECT_READ", "OBJECT_WRITE", "OBJECT_READ_WRITE", "ANY_OBJECT_WRITE", "ANY_OBJECT_READ", "ANY_OBJECT_READ_WRITE" ] }, "ParDetails":{ "description":"The details of PAR URL associated with table.", "type":"object", "required":[ "parUrl", "tableKey", "timeExpires", "parAccessType" ], "properties":{ "parUrl":{ "description":"PAR URL of the table.", "type":"string", "minLength":1, "maxLength":4000 }, "tableKey":{ "description":"The fully qualified name of the table in the format ...", "type":"string" }, "timeExpires":{ "description":"The date and time the table was updated.", "type":"string", "format":"date-time" }, "parAccessType":{ "description":"The operation that can be performed on this resource.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ParAccessType", "enum":[ "OBJECT_READ", "OBJECT_WRITE", "OBJECT_READ_WRITE", "ANY_OBJECT_WRITE", "ANY_OBJECT_READ", "ANY_OBJECT_READ_WRITE" ] } } }, "TableFieldDetails":{ "description":"Columns for table.", "type":"object", "required":[ "fieldName" ], "properties":{ "fieldName":{ "description":"Name of the column.", "type":"string", "minLength":1, "maxLength":767 }, "fieldType":{ "description":"Type of the column.", "type":"string", "minLength":1, "maxLength":9999 }, "fieldPrecision":{ "description":"Precision of the column.", "type":"string", "minLength":1, "maxLength":64 }, "fieldScale":{ "description":"Scale of the column.", "type":"string", "minLength":1, "maxLength":64 }, "fieldDescription":{ "description":"Description of the column.", "type":"string" } } }, "RenameTableFieldDetails":{ "description":"Details for renaming column of a table.", "type":"object", "required":[ "fieldName", "updatedFieldName" ], "properties":{ "fieldName":{ "description":"Name of the column.", "type":"string", "minLength":1, "maxLength":767 }, "updatedFieldName":{ "description":"Updated name of the column.", "type":"string", "minLength":1, "maxLength":767 } } }, "UpdateTableFieldDetails":{ "description":"Details for updating column of a table.", "type":"object", "required":[ "fieldName" ], "properties":{ "fieldName":{ "description":"Name of the column.", "type":"string", "minLength":1, "maxLength":767 }, "fieldDescription":{ "description":"Description of the column.", "type":"string" } } }, "TableProperty":{ "description":"The property of the table.", "type":"object", "required":[ "propertyName" ], "properties":{ "propertyName":{ "description":"Property name.", "type":"string", "minLength":1, "maxLength":255 }, "propertyValue":{ "description":"Property value.", "type":"string", "minLength":1, "maxLength":255 } } }, "ManagedTableDefinition":{ "description":"The details about the new managed table.", "type":"object", "required":[ "managedTableDataFormat" ], "properties":{ "managedTableDataFormat":{ "description":"Data format of the managed table.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DataFormat", "enum":[ "AVRO", "ORC", "PARQUET", "TEXTFILE", "JSON", "CSV", "DELTA", "ICEBERG" ] } } }, "ExternalTableDefinition":{ "description":"The details about the new external table.", "type":"object", "required":[ "externalTableDataFormat" ], "properties":{ "externalTableLocationType":{ "type":"string", "description":"External table location type, either object store location or mount location.", "x-obmcs-top-level-enum":"#/definitions/ExternalTableLocationType", "enum":[ "OBJECT_STORAGE", "MOUNT" ] }, "objectStorageLocationPath":{ "description":"The file location from which table properties are loaded.", "type":"string", "minLength":1, "maxLength":1024 }, "externalTableDataFormat":{ "description":"External table data format.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DataFormat", "enum":[ "AVRO", "ORC", "PARQUET", "TEXTFILE", "JSON", "CSV", "DELTA", "ICEBERG" ] }, "txtFileDefinition":{ "$ref":"#/definitions/TxtFileDefinition" } } }, "TxtFileDefinition":{ "description":"Properties specific to a text file.", "type":"object", "properties":{ "delimiter":{ "description":"Delimiter to be used with text file.", "type":"string", "minLength":1, "maxLength":255 }, "quote":{ "description":"Type of quote to be used with text file.", "type":"string", "minLength":1, "maxLength":255 } } }, "TablePrivilegeForManage":{ "description":"The privilege for a table.", "type":"string", "enum":[ "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ] }, "TablePrivilege":{ "description":"The privilege for a table. Can be inherited privilege coming from object higher up in hierarchy.", "type":"string", "enum":[ "SELECT", "MANAGE", "WRITE", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ] }, "TablePermissionCollection":{ "type":"object", "description":"List of table permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of table permissions.", "type":"array", "items":{ "$ref":"#/definitions/TablePermissionSummary" } } } }, "TablePermissionSummary":{ "description":"Information about a table permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a table.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/TablePrivilege", "enum":[ "SELECT", "MANAGE", "WRITE", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ] } }, "columns":{ "description":"The list of the columns included for permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of the columns excluded from permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "isInherited":{ "type":"boolean", "description":"If the permission listed is inherited or not from object higher up in hierarchy." }, "resourceName":{ "type":"string", "description":"Name of the object to which this permission belong to. Name of table if permission is not inherited or name of object higher up in hierarchy if permission is inherited." } } }, "AssignTablePermissionDetails":{ "description":"The details of the permissions assigned on the table to assignee.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/TablePrivilegeForManage", "enum":[ "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ] } }, "includeColumns":{ "description":"The list of columns to be included for the assigning of permissions.", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the assigning of permissions.", "type":"array", "items":{ "type":"string" } } } }, "RevokeTablePermissionDetails":{ "description":"The details of the permissions revoked from assignee for a table.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "description":"The permissions revoked from the assignee.", "type":"array", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/TablePrivilegeForManage", "enum":[ "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ] } }, "includeColumns":{ "description":"The list of columns to be included for the revoking of permissions.", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the revoking of permissions.", "type":"array", "items":{ "type":"string" } } } }, "ManageTablePermissionDetails":{ "description":"Information to update permissions on a table.", "type":"object", "properties":{ "assignTablePermissionDetails":{ "$ref":"#/definitions/AssignTablePermissionDetails" }, "revokeTablePermissionDetails":{ "$ref":"#/definitions/RevokeTablePermissionDetails" } } }, "InferSchemaColumn":{ "description":"Column inferred from location.", "type":"object", "properties":{ "fieldName":{ "description":"Name of the column.", "type":"string", "minLength":1, "maxLength":767 }, "fieldType":{ "description":"Type of the column.", "type":"string", "minLength":1, "maxLength":9999 }, "isPartition":{ "description":"Boolean value indicating if this column is partition column.", "type":"boolean" }, "rank":{ "description":"For partition columns rank value indicates level, for non-partition column the value will be zero.", "type":"integer" } } }, "InferSchema":{ "description":"Inferred schema from location.", "type":"object", "required":[ "inferSchemaColumn" ], "properties":{ "inferSchemaColumn":{ "description":"Column information obtained by inferring schema.", "type":"array", "items":{ "$ref":"#/definitions/InferSchemaColumn" } } } }, "InferSchemaWithPreview":{ "description":"Inferred schema and data.", "type":"object", "required":[ "schema", "data" ], "properties":{ "schema":{ "description":"Column information obtained by inferring schema.", "type":"array", "items":{ "$ref":"#/definitions/InferSchemaColumn" } }, "data":{ "description":"Sample preview data.", "type":"array", "items":{ "type":"object", "additionalProperties":{ "type":"string" } } } } }, "PerformInferSchemaDetails":{ "description":"Infer schema details.", "type":"object", "required":[ "dataFormat", "location" ], "properties":{ "dataFormat":{ "description":"Data format of the schema location.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DataFormat", "enum":[ "AVRO", "ORC", "PARQUET", "TEXTFILE", "JSON", "CSV", "DELTA", "ICEBERG" ] }, "location":{ "description":"Location of the table to infer schema.", "type":"string" }, "numberOfPartitions":{ "description":"Number of root partition folders to scan.", "type":"integer" }, "inferSchemaProperties":{ "description":"Properties which are needed for inferring schema.", "type":"array", "items":{ "$ref":"#/definitions/InferSchemaProperties" } } } }, "InferSchemaProperties":{ "description":"Properties to be supplied for infer schema.", "type":"object", "properties":{ "propertyName":{ "description":"Name of the property.", "type":"string", "minLength":1, "maxLength":255 }, "propertyValue":{ "description":"Property value.", "type":"string", "minLength":1, "maxLength":255 } } }, "GenerateTempFileUploadTargetResponseDetails":{ "description":"The details for a generated URI for uploading a temporary file in a schema.", "type":"object", "required":[ "tempFileUploadTarget", "uploadKey", "ociFilePath" ], "properties":{ "tempFileUploadTarget":{ "description":"The generated target URI to upload the file, it must be prefixed by object stroage URL.", "type":"string" }, "uploadKey":{ "description":"The unique key for this request.", "type":"string" }, "ociFilePath":{ "description":"The exact URI path of the object storage.", "type":"string" } } }, "View":{ "description":"Information about the view in the schema.", "type":"object", "required":[ "displayName" ], "properties":{ "key":{ "description":"The fully qualified name of the view in the format ..", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the scope of the schema and is changeable.", "type":"string" }, "catalogKey":{ "description":"The name of the catalog to which this view belongs.", "type":"string" }, "schemaKey":{ "description":"The name of the Schema to which this view belongs.", "type":"string" }, "viewText":{ "description":"The Query used to create the view.", "type":"string" }, "description":{ "description":"The description of the view.", "type":"string" }, "viewFields":{ "description":"Columns for view.", "type":"array", "maxItems":1000, "items":{ "$ref":"#/definitions/ViewFieldDetails" } }, "timeCreated":{ "description":"The date and time the View was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the View was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user/principal who created the view.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the view.", "type":"string", "minLength":1, "maxLength":255 }, "viewProperties":{ "description":"View Properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/ViewProperty" } }, "lifecycleState":{ "description":"The state of the view.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ViewLifecycleState", "enum":[ "ACTIVE" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" } } }, "ViewSummary":{ "description":"Summary information of view in the schema.", "type":"object", "properties":{ "key":{ "description":"The fully qualified name of the view in the format ..", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the scope of the schema and is changeable.", "type":"string" }, "isTemporary":{ "description":"Denotes whether the view is temporary or permanent.", "type":"boolean", "default":false }, "timeCreated":{ "description":"The date and time the View was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the View was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user/principal who created the view.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the view.", "type":"string", "minLength":1, "maxLength":255 }, "lifecycleState":{ "description":"The state of the Table.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ViewLifecycleState", "enum":[ "ACTIVE" ] } } }, "ViewCollection":{ "type":"object", "description":"Result of listing views in a schema.", "required":[ "items" ], "properties":{ "items":{ "description":"List of views.", "type":"array", "items":{ "$ref":"#/definitions/ViewSummary" } } } }, "ViewProperty":{ "description":"The property of the view.", "type":"object", "required":[ "propertyName" ], "properties":{ "propertyName":{ "description":"Property name.", "type":"string", "minLength":1, "maxLength":255 }, "propertyValue":{ "description":"Property value.", "type":"string", "minLength":1, "maxLength":255 } } }, "ViewFieldDetails":{ "description":"Columns for view.", "type":"object", "required":[ "fieldName" ], "properties":{ "fieldName":{ "description":"Name of the column.", "type":"string", "minLength":1, "maxLength":767 }, "fieldType":{ "description":"Type of the column.", "type":"string", "minLength":1, "maxLength":9999 }, "fieldPrecision":{ "description":"Precision of the column.", "type":"string" }, "fieldScale":{ "description":"Scale of the column.", "type":"string" }, "fieldDescription":{ "description":"Description of the column.", "type":"string" } } }, "ViewUpdateDetails":{ "description":"The details for updating a view.", "type":"object", "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the scope of the schema and is changeable.", "type":"string" }, "description":{ "description":"The description of the view.", "type":"string" }, "viewText":{ "description":"The Query used to create the view.", "type":"string" }, "viewFields":{ "description":"Columns for view.", "type":"array", "maxItems":1000, "items":{ "$ref":"#/definitions/ViewFieldDetails" } }, "addViewProperties":{ "description":"View Properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/ViewProperty" } }, "dropViewProperties":{ "description":"View Properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/ViewProperty" } } } }, "CreateViewDetails":{ "description":"The data to create a view.", "type":"object", "required":[ "displayName", "catalogKey", "schemaKey", "viewText" ], "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the scope of the schema and is changeable.", "type":"string" }, "catalogKey":{ "description":"The name of the catalog to which this view belongs.", "type":"string" }, "schemaKey":{ "description":"The name of the Schema to which this view belongs.", "type":"string" }, "description":{ "description":"The description of the view.", "type":"string" }, "viewText":{ "description":"The Query used to create the view.", "type":"string" }, "viewProperties":{ "description":"View Properties.", "type":"array", "maxItems":10, "items":{ "$ref":"#/definitions/ViewProperty" } }, "viewFields":{ "description":"Columns for view.", "type":"array", "maxItems":1000, "items":{ "$ref":"#/definitions/ViewFieldDetails" } } } }, "UpdateViewDetails":{ "description":"The data to update a view.", "type":"object", "required":[ "updateMode" ], "properties":{ "updateMode":{ "description":"The mode of update for a view", "type":"string", "enum":[ "RENAME_VIEW", "ADD_PROPERTIES", "DROP_PROPERTIES", "UPDATE_VIEW_DESCRIPTION", "UPDATE_VIEW_QUERY", "UPDATE_COLUMN_DESCRIPTION" ] }, "viewUpdateDetails":{ "$ref":"#/definitions/ViewUpdateDetails" } } }, "ViewPrivilege":{ "description":"The privilege for a View which could be an inherited privilege coming from object up in hierarchy.", "type":"string", "enum":[ "SELECT", "MANAGE", "WRITE", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ] }, "ViewPrivilegeForManage":{ "description":"The privilege for a view.", "type":"string", "enum":[ "SELECT", "ALTER", "ADMIN" ] }, "ViewPermissionCollection":{ "type":"object", "description":"List of view permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of view permissions.", "type":"array", "items":{ "$ref":"#/definitions/ViewPermissionSummary" } } } }, "ViewPermissionSummary":{ "description":"Information about a view permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a view.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ViewPrivilege", "enum":[ "SELECT", "MANAGE", "WRITE", "INSERT", "UPDATE", "DELETE", "ALTER", "ADMIN" ] } }, "columns":{ "description":"The list of the columns included for permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "excludedColumns":{ "description":"The list of the columns excluded from permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "isInherited":{ "type":"boolean", "description":"The permission listed is inherited or not from object up in hierarchy." }, "resourceName":{ "type":"string", "description":"Name of the object to which this permission belong to. This would be the name of view if permission is not inherited or name of object up in hierarchy if permission is inherited." } } }, "AssignViewPermissionDetails":{ "description":"The details of the permissions assigned on the view to assignee.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ViewPrivilegeForManage", "enum":[ "SELECT", "ALTER", "ADMIN" ] } }, "includeColumns":{ "description":"The list of columns to be included for the assigning of permissions.", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the assigning of permissions.", "type":"array", "items":{ "type":"string" } } } }, "RevokeViewPermissionDetails":{ "description":"The details of the permissions revoked from assignee for a view.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "description":"The permissions revoked from the assignee.", "type":"array", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ViewPrivilegeForManage", "enum":[ "SELECT", "ALTER", "ADMIN" ] } }, "includeColumns":{ "description":"The list of columns to be included for the revoking of permissions.", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the revoking of permissions.", "type":"array", "items":{ "type":"string" } } } }, "ManageViewPermissionDetails":{ "description":"Information to update permissions on a view.", "type":"object", "properties":{ "assignViewPermissionDetails":{ "$ref":"#/definitions/AssignViewPermissionDetails" }, "revokeViewPermissionDetails":{ "$ref":"#/definitions/RevokeViewPermissionDetails" } } }, "ValidateViewSqlDetails":{ "description":"View select query details.", "type":"object", "required":[ "viewSelectQuery" ], "properties":{ "viewSelectQuery":{ "description":"The Query used to create the view.", "type":"string" } } }, "ViewSqlParseDetails":{ "description":"Parsed view select query post validation.", "type":"object", "required":[ "isQueryValid" ], "properties":{ "isQueryValid":{ "description":"Flag to indicate whether given view SQL is valid or not.", "type":"boolean" }, "queryParseErrorMessage":{ "description":"Error message if given view SQL is not valid.", "type":"string" }, "viewFields":{ "description":"Columns for view.", "type":"array", "maxItems":1000, "items":{ "$ref":"#/definitions/ViewFieldDetails" } } } }, "Volume":{ "description":"A volumes is a container to store data in its original form and can store semi-structured or unstructured data.\nVolumes can either be external or managed. To use any of the API operations, you must be authorized in an IAM policy. \nIf you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give\nusers access, see IAM Policies for Oracle AI Data Platform Workbench.\n", "type":"object", "required":[ "key", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The key of the volume.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the schema and is changeable.", "type":"string" }, "description":{ "description":"Short description of the volume", "type":"string" }, "timeCreated":{ "description":"The date and time the Data Lake Volume was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Data Lake Volume was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user that created the volume.\n", "type":"string" }, "updatedBy":{ "description":"The ID of the user that last updated the volume\n", "type":"string" }, "catalogName":{ "description":"The name of the catalog to which this volume belongs.", "type":"string" }, "schemaName":{ "description":"The name of the schema to which this volume belongs.", "type":"string" }, "fullName":{ "description":"The fully qualified name of this volume.", "type":"string" }, "volumeType":{ "description":"The type of volume.", "type":"string", "enum":[ "MANAGED", "EXTERNAL" ], "default":"MANAGED" }, "storageLocation":{ "description":"The storage location of the external volume. Only applicable for external volumes.", "type":"string" }, "lifecycleState":{ "description":"The lifecycle state of the volume. The volume is ready for use in ACTIVE state", "type":"string", "enum":[ "CREATING", "UPDATING", "DELETING", "ACTIVE", "DELETED" ] }, "lifecycleStateDetails":{ "description":"Additional details associated with the lifecycle state.", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "VolumeSummary":{ "description":"Summary information about a volume.", "type":"object", "required":[ "key", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The key of the volume.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the schema and is changeable.", "type":"string" }, "description":{ "description":"Short description of the volume", "type":"string" }, "timeCreated":{ "description":"The date and time the Data Lake Volume was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Data Lake Volume was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user that created the volume.\n", "type":"string" }, "updatedBy":{ "description":"The ID of the user that last updated the volume\n", "type":"string" }, "fullName":{ "description":"The fully qualified name of this volume.", "type":"string" }, "volumeType":{ "description":"The type of volume.", "type":"string", "enum":[ "MANAGED", "EXTERNAL" ], "default":"MANAGED" }, "lifecycleState":{ "type":"string", "description":"The current state of the volume.", "x-obmcs-enumref":"#/definitions/Volume/lifecycleState" }, "lifecycleStateDetails":{ "description":"Additional details associated with the lifecycle state.", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "CreateVolumeDetails":{ "description":"The data to create a volume.", "type":"object", "required":[ "displayName", "schemaName", "catalogName" ], "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the schema and is changeable.", "type":"string" }, "catalogName":{ "description":"The name of the catalog to which this volume belongs.", "type":"string" }, "schemaName":{ "description":"The name of the schema to which this volume belongs.", "type":"string" }, "description":{ "description":"Short description of the volume", "type":"string" }, "volumeType":{ "description":"The type of volume.", "type":"string", "enum":[ "MANAGED", "EXTERNAL" ], "default":"MANAGED" }, "storageLocation":{ "description":"The storage location of the external volume. Only applicable for external volumes.", "type":"string" } } }, "UpdateVolumeDetails":{ "description":"The data to update a volume.", "type":"object", "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the schema and is changeable.", "type":"string" }, "description":{ "description":"Short description of the volume", "type":"string" } } }, "VolumeCollection":{ "type":"object", "description":"Result of listing volumes", "required":[ "items" ], "properties":{ "items":{ "description":"List of volumes.", "type":"array", "items":{ "$ref":"#/definitions/VolumeSummary" } } } }, "VolumePrivilege":{ "description":"The privilege for a volume", "type":"string", "enum":[ "READ", "WRITE", "ADMIN" ] }, "AllVolumePrivilege":{ "description":"The privilege for a volume. Can be an inherited privilege coming from object up in hierarchy.", "type":"string", "enum":[ "READ", "WRITE", "ADMIN", "SELECT", "MANAGE" ] }, "VolumePermissionCollection":{ "type":"object", "description":"List of volume permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of volume permissions.", "type":"array", "items":{ "$ref":"#/definitions/VolumePermissionSummary" } } } }, "VolumePermissionSummary":{ "description":"Information about a volume permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a volume.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/AllVolumePrivilege", "enum":[ "READ", "WRITE", "ADMIN", "SELECT", "MANAGE" ] } }, "isInherited":{ "type":"boolean", "description":"The permission listed is inherited or not from object up in hierarchy." }, "resourceName":{ "type":"string", "description":"Name of the object to which this permission belongs to. This would be the name of a table if permission is not inherited or name of the object up in hierarchy if permission is inherited." } } }, "AssignVolumePermissionDetails":{ "description":"The details of the permissions assigned on the volume to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/VolumePrivilege", "enum":[ "READ", "WRITE", "ADMIN" ] } } } }, "RevokeVolumePermissionDetails":{ "description":"The details of the permissions revoked from assignees for a volume.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/VolumePrivilege", "enum":[ "READ", "WRITE", "ADMIN" ] } } } }, "ManageVolumePermissionDetails":{ "description":"Information to update permissions on a volume.", "type":"object", "properties":{ "assignVolumePermissionDetails":{ "$ref":"#/definitions/AssignVolumePermissionDetails" }, "revokeVolumePermissionDetails":{ "$ref":"#/definitions/RevokeVolumePermissionDetails" } } }, "VolumeFile":{ "description":"Information of file in the volume.", "type":"object" }, "VolumeFileSummary":{ "description":"Summary information of file in the volume", "type":"object", "required":[ "path", "type", "timeCreated", "displayName" ], "properties":{ "path":{ "description":"The fully qualified path of the volume file.\nExample: /Shared/Folder1/sample.csv\n", "type":"string" }, "displayName":{ "description":"The name of the volume file. This will be the name of the file/folder in the volume.\nExample: sample.csv, Folder1\n", "type":"string" }, "timeCreated":{ "description":"The date and time the file was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the file was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "type":{ "description":"The type of volume file.", "type":"string", "enum":[ "FILE", "FOLDER" ] }, "description":{ "description":"The description for the file and folder.", "type":"string" }, "metadata":{ "type":"object", "description":"Metadata details of file or folder objects.", "additionalProperties":{ "type":"string" } }, "compositeEtag":{ "description":"Etag combining data and metadata.", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } }, "createdBy":{ "description":"OCID of the user who created this file.", "type":"string" }, "createdByName":{ "description":"Name of the user who created this file.", "type":"string" } } }, "VolumeFileCollection":{ "type":"object", "description":"Result of listing files in a volume.", "required":[ "items" ], "properties":{ "items":{ "description":"List of volume files.", "type":"array", "items":{ "$ref":"#/definitions/VolumeFileSummary" } } } }, "UpdateDirDetails":{ "description":"The data to update a folder.", "type":"object", "properties":{ "displayName":{ "description":"The name of the volume folder. This will be the name of the folder in the volume.\n", "type":"string" } } }, "UploadFileWithParDetails":{ "description":"The data to create/update a file.", "type":"object", "properties":{ "action":{ "description":"Action type on create or close.", "type":"string", "enum":[ "CREATE", "REFRESH", "UPDATE" ] }, "eTag":{ "description":"Etag that needs to be updated.", "type":"string" }, "size":{ "description":"Size of the file needed when closed.", "type":"integer", "format":"int64" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "UploadFileWithParResult":{ "description":"Response object of generate PAR with Upload API.", "type":"object", "required":[ "locationUri", "eTag" ], "properties":{ "parUrl":{ "description":"String representing the PAR URL.\n", "type":"string" }, "eTag":{ "description":"Etag after creating or closing a file.\n", "type":"string" }, "locationUri":{ "description":"The object storage URI which has bucket and namespace information.\n", "type":"string" }, "size":{ "description":"File size in bytes.\n", "type":"integer", "format":"int64" }, "createdBy":{ "description":"The user who created the file.\n", "type":"string" }, "updatedBy":{ "description":"The user who last updated the file.\n", "type":"string" }, "createdTime":{ "description":"The time at which the file was created.\n", "type":"string" }, "updatedTime":{ "description":"The last modified time of the file.\n", "type":"string" }, "description":{ "description":"The file description.\n", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "DownloadFileWithParResult":{ "description":"Response object of generate PAR with download API.", "type":"object", "required":[ "locationUri", "eTag", "size" ], "properties":{ "parUrl":{ "description":"String representing the PAR URL.\n", "type":"string" }, "eTag":{ "description":"Etag after creating or closing a file.\n", "type":"string" }, "locationUri":{ "description":"The object storage URI which has bucket and namespace information.\n", "type":"string" }, "size":{ "description":"File size in bytes.\n", "type":"integer", "format":"int64" }, "createdBy":{ "description":"The user who created the file.\n", "type":"string" }, "updatedBy":{ "description":"The user who last updated the file.\n", "type":"string" }, "createdTime":{ "description":"The time at which the file was created.\n", "type":"string" }, "updatedTime":{ "description":"The last modified time of the file.\n", "type":"string" }, "description":{ "description":"The file description.\n", "type":"string" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "ListRolePermissionScopeType":{ "description":"The permission scope for a role based on how it was obtained.", "type":"string", "enum":[ "DIRECT", "INHERITED", "ALL" ] }, "GetRoleScopeType":{ "description":"The role scope based on grantee type.", "type":"string", "enum":[ "USER", "ADMIN", "MEMBER_OF", "GROUP", "ALL" ] }, "AllPrivilegeType":{ "description":"List of all privileges in the AI Data Platform Workbench.", "type":"string", "enum":[ "USER", "ADMINISTRATOR", "READ", "USE", "MANAGE", "ADMIN", "CREATE_CATALOG", "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE_SCHEMA", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE" ] }, "AllResourceType":{ "description":"List of sub-resources that are RBAC managed by AI Data Platform Workbench.", "type":"string", "enum":[ "WORKSPACE", "WORKFLOW", "FOLDER", "FILE", "CLUSTER", "MASTER_CATALOG", "CATALOG", "SCHEMA", "TABLE", "SHARE", "RECIPIENT", "VOLUME", "VIEW", "KNOWLEDGE_BASE" ] }, "RoleAssigneeType":{ "description":"The entity type to which a role can be assigned to/revoked from. It is also used for role Admin type.", "type":"string", "minLength":1, "maxLength":255, "enum":[ "USER", "ROLE", "GROUP" ] }, "RoleType":{ "description":"The role type for a role.", "type":"string", "minLength":1, "maxLength":255, "enum":[ "SYSTEM", "CUSTOM" ] }, "RoleAssignee":{ "type":"object", "description":"The user/principal/role the role can be assigned to.", "required":[ "type", "target" ], "properties":{ "type":{ "type":"string", "description":"assignee type.", "x-obmcs-top-level-enum":"#/definitions/RoleAssigneeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "target":{ "type":"string", "description":"The OCID for a principal or role." }, "targetName":{ "type":"string", "description":"The name for a principal or role." } } }, "Role":{ "description":"Role details.", "type":"object", "x-obmcs-splat":{ "resourceKind":"Role", "ocidEntityType":"Role", "activeLifecycleStates":[ "active" ], "deletedLifecycleStates":[ "deleted" ], "getOperationId":"GetRole", "adLocality":"regional" }, "required":[ "key" ], "properties":{ "key":{ "description":"A unique key for the role. It cannot be changed.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"The role name. It can be changed.", "type":"string", "maxLength":255 }, "roleType":{ "description":"Type of role.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/RoleType", "enum":[ "SYSTEM", "CUSTOM" ] }, "timeCreated":{ "description":"The time the role was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the Role was updated. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The user name of the user/principal who created the role.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The user name of the user/principal who updated the role.", "type":"string", "minLength":1, "maxLength":255 }, "isAssigned":{ "description":"The role is assigned to the current user or a group that the user is part of.", "type":"boolean" }, "assignees":{ "description":"The users and groups this role is assigned to.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/RoleAssignee" } }, "lifecycleState":{ "description":"The state of the role.", "type":"string", "enum":[ "ACTIVE" ] }, "lifecycleDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "description":{ "description":"The description of the role.", "type":"string" } } }, "RoleSummary":{ "description":"The summary of the role.", "type":"object", "required":[ "key", "displayName" ], "properties":{ "key":{ "description":"A unique key for the role summary. It cannot be changed.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"The role summary name. It can be changed.", "type":"string", "maxLength":255 }, "roleType":{ "description":"Type of role.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/RoleType", "enum":[ "SYSTEM", "CUSTOM" ] }, "timeCreated":{ "description":"The time the role summary was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the role summary was updated. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "isAssigned":{ "description":"The role summary is assigned to the current user or a group that the user is part of.", "type":"boolean" }, "createdBy":{ "description":"The user name of the user/principal who created the role.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The user name of the user/principal who updated the role.", "type":"string", "minLength":1, "maxLength":255 }, "lifecycleState":{ "description":"The current state of the role summary.", "type":"string", "x-obmcs-enumref":"#/definitions/Role/lifecycleState" }, "lifecycleDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "description":{ "description":"The description of the role summary.", "type":"string" } } }, "RoleCollection":{ "type":"object", "description":"The results of a role search. It contains RoleSummary objects.", "required":[ "items" ], "properties":{ "items":{ "description":"The role summaries returned.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/RoleSummary" } } } }, "CreateRoleDetails":{ "description":"The details about the new role.", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "description":"The role name, it can be changed. No special characters except for ???_???. Case insensitive.", "type":"string", "maxLength":64 }, "description":{ "description":"The description of the role.", "type":"string", "maxLength":1024 } } }, "UpdateRoleDetails":{ "description":"The data to update a role.", "type":"object", "properties":{ "displayName":{ "description":"The role name, it can be changed. No special characters except for ???_???. Case insensitive.", "type":"string", "maxLength":64 }, "description":{ "description":"The description of the role.", "type":"string" } } }, "AddMemberToRoleDetails":{ "description":"The details of assignees for this role.", "type":"object", "required":[ "assignees" ], "properties":{ "assignees":{ "description":"The assignees on the role.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/RoleAssignee" } } } }, "RemoveMemberFromRoleDetails":{ "description":"The details of revoking the role.", "type":"object", "required":[ "assignees" ], "properties":{ "assignees":{ "description":"The assignees on the role.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/RoleAssignee" } } } }, "PermissionWithResourceDetails":{ "type":"object", "description":"A permission string with resource details.", "required":[ "permissions", "resourceType", "resourceKey" ], "properties":{ "permissions":{ "type":"string", "description":"Permission or privilege name.", "x-obmcs-top-level-enum":"#/definitions/AllPrivilegeType", "enum":[ "USER", "ADMINISTRATOR", "READ", "USE", "MANAGE", "ADMIN", "CREATE_CATALOG", "SELECT", "INSERT", "UPDATE", "DELETE", "ALTER", "CREATE_SCHEMA", "WRITE", "CREATE_VIEW", "CREATE_VOLUME", "CREATE_TABLE", "CREATE_KNOWLEDGE_BASE" ] }, "resourceType":{ "type":"string", "description":"All sub-resources in catalog and workspace.", "x-obmcs-top-level-enum":"#/definitions/AllResourceType", "enum":[ "WORKSPACE", "WORKFLOW", "FOLDER", "FILE", "CLUSTER", "MASTER_CATALOG", "CATALOG", "SCHEMA", "TABLE", "SHARE", "RECIPIENT", "VOLUME", "VIEW", "KNOWLEDGE_BASE" ] }, "resourceKey":{ "type":"string", "description":"Workspace and its sub-resources key.\nFor example - For workspaceKey, clusterKey its a UUID\nWithin catalog its a 3 level namespace\n tableKey - .. \n schemaKey - .\n catalogKey - \n" } } }, "ListPermissionsWithResourceDetails":{ "type":"object", "description":"List of permissions/privileges with resource details.", "required":[ "permissions", "resourceType", "resourceKey" ], "properties":{ "permissions":{ "type":"array", "description":"List of privilege names.", "maxItems":100, "items":{ "$ref":"#/definitions/AllPrivilegeType" } }, "resourceType":{ "type":"string", "description":"All sub-resources in catalog and workspace.", "x-obmcs-top-level-enum":"#/definitions/AllResourceType", "enum":[ "WORKSPACE", "WORKFLOW", "FOLDER", "FILE", "CLUSTER", "MASTER_CATALOG", "CATALOG", "SCHEMA", "TABLE", "SHARE", "RECIPIENT", "VOLUME", "VIEW", "KNOWLEDGE_BASE" ] }, "resourceKey":{ "type":"string", "description":"Workspace and its sub-resources key.\nFor example - For workspaceKey, clusterKey its a UUID\nWithin catalog its a 3 level namespace\n tableKey - .. \n schemaKey - .\n catalogKey - \n" } } }, "RolePermissionCollection":{ "type":"object", "description":"A collection of permission summaries associated with a role.", "required":[ "items" ], "properties":{ "items":{ "description":"Role permissions.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/RolePermissionSummary" } } } }, "RolePermissionSummary":{ "type":"object", "description":"Summary of role permissions.", "required":[ "roleKey", "permissionsWithResourceDetails" ], "properties":{ "permissionsWithResourceDetails":{ "$ref":"#/definitions/ListPermissionsWithResourceDetails" }, "roleKey":{ "description":"Role attached to this permission entry.", "type":"string", "maxLength":64 }, "roleDescription":{ "description":"The description of the role.", "type":"string", "maxLength":1024 } } }, "AssignRolePermissionDetails":{ "description":"The details of the permissions assigned on the role to assignee.", "type":"object", "required":[ "permissionWithResourceDetails" ], "properties":{ "permissionWithResourceDetails":{ "description":"A list of permissions, resourceTypes, and resourceKeys.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/PermissionWithResourceDetails" } } } }, "RevokeRolePermissionDetails":{ "description":"The details of the permissions revoked from assignees for a role.", "type":"object", "required":[ "permissionWithResourceDetails" ], "properties":{ "permissionWithResourceDetails":{ "description":"A list of permissions, resourceTypes, and resourceKeys.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/PermissionWithResourceDetails" } } } }, "ManageRolePermissionDetails":{ "description":"Information to update permissions on a role.", "type":"object", "properties":{ "assignRolePermissionDetails":{ "$ref":"#/definitions/AssignRolePermissionDetails" }, "revokeRolePermissionDetails":{ "$ref":"#/definitions/RevokeRolePermissionDetails" } } }, "ListFilterEnum":{ "description":"Accepted values of list filters", "type":"string", "enum":[ "TYPE", "OWNER", "CREATED_BY", "CATALOG", "SCHEMA", "WORKSPACE", "JOB", "CLUSTER" ] }, "RangeFilterEnum":{ "description":"Accepted values of range filters", "type":"string", "enum":[ "TIME_UPDATED", "TIME_CREATED" ] }, "DataTypeEnum":{ "description":"Possible types of data types", "type":"string", "enum":[ "STRING", "DATE", "INTEGER" ] }, "SortFieldEnum":{ "description":"Accepted values of sort field", "type":"string", "enum":[ "TIME_UPDATED", "TIME_CREATED", "RELEVANCY", "TYPE" ] }, "SortDetails":{ "type":"object", "description":"Object with sort criteria details", "properties":{ "sortBy":{ "description":"Field name that needs to be sorted by.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SortFieldEnum", "enum":[ "TIME_UPDATED", "TIME_CREATED", "RELEVANCY", "TYPE" ] }, "sortOrder":{ "description":"Sort order for search results.", "type":"string", "example":"ASC", "enum":[ "ASC", "DESC" ] } } }, "SearchCriteria":{ "description":"Details about search criteria", "type":"object", "properties":{ "query":{ "description":"Search query string", "type":"string" }, "limit":{ "description":"The maximum number of items to return.", "type":"integer", "minimum":1, "maximum":1000 }, "offset":{ "description":"The doc number from which it needs to be return.", "type":"integer", "minimum":0, "maximum":1000 }, "aggregations":{ "description":"The provide the field name on which we need aggregation.", "type":"array", "items":{ "$ref":"#/definitions/AggregationEnum" } }, "filter":{ "$ref":"#/definitions/FilterTypes" }, "sort":{ "description":"Array of objects having details about sort field and order.", "type":"array", "items":{ "$ref":"#/definitions/SortDetails" } } } }, "WorkspaceSearchCriteria":{ "type":"object", "description":"List of Workspace objects", "allOf":[ { "$ref":"#/definitions/SearchCriteria" }, { "properties":{ "path":{ "description":"The path prefix Example: /Shared, /Shared/Folder1, etc.\n", "type":"string" } } } ] }, "GroupedSearchCriteria":{ "type":"object", "description":"Details about group search criteria", "allOf":[ { "$ref":"#/definitions/SearchCriteria" }, { "properties":{ "groupLimit":{ "description":"The maximum number of items to return in group", "type":"integer", "minimum":1, "maximum":20, "default":3 } } } ] }, "WorkspaceObjectSearchResultsCollection":{ "type":"object", "description":"List of Workspace objects", "required":[ "items" ], "properties":{ "items":{ "description":"List of Workspace objects.", "type":"array", "items":{ "$ref":"#/definitions/WorkspaceObjectSearchSummary" } } } }, "SearchResultsCollection":{ "type":"object", "description":"List of objects", "required":[ "count", "query", "items", "aggregations" ], "properties":{ "count":{ "description":"Total number of hits", "type":"integer" }, "query":{ "description":"User search query", "type":"string" }, "items":{ "description":"List of objects.", "type":"array", "items":{ "$ref":"#/definitions/ObjectSearchSummary" } }, "aggregations":{ "description":"Grouped doc name with count.", "type":"object", "additionalProperties":{ "type":"array", "items":{ "$ref":"#/definitions/SearchObjectType" } } } } }, "SearchResultsGroupByCollection":{ "type":"object", "description":"Grouped list of objects by type.", "required":[ "count", "query", "items", "aggregations" ], "properties":{ "count":{ "description":"Total number of hits", "type":"integer" }, "query":{ "description":"User search query", "type":"string" }, "items":{ "description":"Objects grouped by their type. Each key is a type (e.g., \"database\", \"catalog\").", "type":"object", "additionalProperties":{ "type":"array", "description":"List of objects for a particular type.", "items":{ "$ref":"#/definitions/ObjectSearchSummary" } } }, "aggregations":{ "description":"Grouped doc name with count.", "type":"object", "additionalProperties":{ "type":"array", "items":{ "$ref":"#/definitions/SearchObjectType" } } } } }, "SearchObjectType":{ "description":"Possible types of search object", "type":"object", "properties":{ "name":{ "description":"Possible types of search object", "type":"string" }, "count":{ "description":"Total count of search object", "type":"integer" } } }, "AggregationEnum":{ "description":"Possible types of search object", "type":"string", "enum":[ "TYPE", "OWNER", "CREATED_BY", "CATALOG", "SCHEMA", "WORKSPACE" ] }, "FilterTypes":{ "description":"Different types of filters", "type":"object", "properties":{ "listFilters":{ "description":"Provide the list of term filters", "type":"array", "items":{ "$ref":"#/definitions/ListFilter" } }, "rangeFilters":{ "description":"Provide the list of range filters", "type":"array", "items":{ "$ref":"#/definitions/RangeFilter" } } } }, "ListFilter":{ "description":"List filters", "type":"object", "properties":{ "field":{ "description":"Field Name for term filter", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ListFilterEnum", "enum":[ "TYPE", "OWNER", "CREATED_BY", "CATALOG", "SCHEMA", "WORKSPACE", "JOB", "CLUSTER" ] }, "dataType":{ "description":"Field Name data type", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DataTypeEnum", "enum":[ "STRING", "DATE", "INTEGER" ] }, "values":{ "description":"List of values", "type":"array", "items":{ "type":"string" } } } }, "RangeFilter":{ "description":"Range filters", "type":"object", "properties":{ "field":{ "description":"Field Name for range filter", "type":"string", "x-obmcs-top-level-enum":"#/definitions/RangeFilterEnum", "enum":[ "TIME_UPDATED", "TIME_CREATED" ] }, "dataType":{ "description":"Field Name data type", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DataTypeEnum", "enum":[ "STRING", "DATE", "INTEGER" ] }, "start":{ "description":"Start value", "type":"string" }, "end":{ "description":"End value", "type":"string" } } }, "WorkspaceObjectSearchSummary":{ "description":"An object in a Data Lake Workspace\n", "type":"object", "required":[ "key", "type", "timeCreated", "displayName" ], "properties":{ "key":{ "description":"The key of the object", "type":"string" }, "displayName":{ "description":"A user-friendly name.", "type":"string" }, "description":{ "description":"Description of the object", "type":"string" }, "type":{ "description":"The type of the Workspace Object", "type":"string" }, "workspaceKey":{ "description":"Key of the workspace.", "type":"string" }, "path":{ "description":"Path of workspace object.", "type":"string" }, "timeCreated":{ "description":"The date and time when the object was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time when the object was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"OCID of the user who created this record", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record", "type":"string" }, "updatedBy":{ "description":"OCID of the user who updated this record", "type":"string" }, "updatedByName":{ "description":"Name of the user who updated this record", "type":"string" } } }, "ObjectSearchSummary":{ "description":"A Search object in a Data Lake\n", "type":"object", "required":[ "key", "type", "displayName", "description", "path", "createdByName", "timeUpdated" ], "properties":{ "key":{ "description":"The key of the object", "type":"string" }, "displayName":{ "description":"A user-friendly name.", "type":"string" }, "description":{ "description":"Description of the object", "type":"string" }, "type":{ "description":"The type of the Object", "type":"string" }, "path":{ "description":"Path of object.", "type":"string" }, "timeCreated":{ "description":"The date and time the object was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the object was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "owner":{ "description":"Name of the owner of the record", "type":"string" }, "createdByName":{ "description":"Name of the user who created this record", "type":"string" }, "updatedByName":{ "description":"Name of the user who updated this record", "type":"string" }, "workspaceKey":{ "description":"Key of the workspace.", "type":"string" }, "workspaceName":{ "description":"Name of the workspace.", "type":"string" }, "catalogKey":{ "description":"Key of the catalog.", "type":"string" }, "schemaKey":{ "description":"Key of the schema.", "type":"string" }, "hitHighlights":{ "description":"Highlights related to this notebook object", "type":"array", "items":{ "type":"string" }, "minItems":0, "maxItems":10 } } }, "RecentSearchesCriteria":{ "description":"Details about recent searches criteria", "type":"object", "properties":{ "limit":{ "description":"The maximum number of items to return.", "type":"integer", "minimum":1, "maximum":20 } } }, "ObjectSuggestSummary":{ "description":"A Suggest object in a Data Lake\n", "type":"object", "required":[ "type", "displayName", "path" ], "properties":{ "displayName":{ "description":"A user-friendly name.", "type":"string" }, "type":{ "description":"The type of the Object", "type":"string" }, "path":{ "description":"Path of object.", "type":"string" }, "key":{ "description":"Key of object.", "type":"string" }, "workspaceKey":{ "description":"Key of the workspace.", "type":"string" }, "catalogKey":{ "description":"Key of the catalog.", "type":"string" }, "schemaKey":{ "description":"Key of the schema.", "type":"string" }, "workspaceName":{ "description":"Name of the workspace", "type":"string" } } }, "SuggestResultsCollection":{ "type":"object", "description":"List of suggested objects", "required":[ "items", "count", "query" ], "properties":{ "count":{ "description":"Total number of hits", "type":"integer" }, "query":{ "description":"User suggest query", "type":"string" }, "items":{ "description":"List of objects.", "type":"array", "items":{ "$ref":"#/definitions/ObjectSuggestSummary" } } } }, "SuggestCriteria":{ "description":"Details about suggest criteria", "type":"object", "properties":{ "query":{ "description":"Suggest query string", "type":"string" }, "limit":{ "description":"The maximum number of items to return.", "type":"integer", "minimum":1, "maximum":20 } } }, "ObjectRecentSearchSummary":{ "description":"A Recent Search object in a Data Lake", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "description":"De-normalized search term.", "type":"string" } } }, "RecentSearchResultsCollection":{ "type":"object", "description":"List of recent searches objects", "required":[ "items", "count" ], "properties":{ "count":{ "description":"Total number of items", "type":"integer" }, "items":{ "description":"List of objects.", "type":"array", "items":{ "$ref":"#/definitions/ObjectRecentSearchSummary" } } } }, "ShareLifecycleState":{ "description":"The state of the Share", "type":"string", "enum":[ "ACTIVE" ] }, "Share":{ "description":"A share is used to access the data assets in AI Data Platform Workbench through Delta Share Protocol.\n", "type":"object", "required":[ "key", "timeCreated", "displayName", "createdBy", "recipientCount" ], "properties":{ "key":{ "description":"Unique identifier for this share in AI Data Platform Workbench instance.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"A description associated with this share.", "type":"string" }, "timeCreated":{ "description":"The date and time the Delta Share was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Delta Share was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user who created the share.\n", "type":"string" }, "updatedBy":{ "description":"The ID of the user who last updated the share.\n", "type":"string" }, "recipientCount":{ "description":"The number of recipients who have access on this share.\n", "type":"integer" }, "assetCount":{ "description":"The number of assets in this share.\n", "type":"integer" }, "lifecycleState":{ "description":"The state of the Share.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ShareLifecycleState", "enum":[ "ACTIVE" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail.", "type":"string" } } }, "CreateShareDetails":{ "description":"The details for creating a Delta Share in AI Data Platform Workbench.", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"A description associated with this share.", "type":"string" } } }, "UpdateShareDetails":{ "description":"The details for updating a Delta Share metadata in AI Data Platform Workbench.", "type":"object", "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"A description associated with this share.", "type":"string" } } }, "ShareSummary":{ "description":"Summary information about a share.", "type":"object", "required":[ "key", "displayName", "createdBy", "timeCreated" ], "properties":{ "key":{ "description":"Unique identifier for this share in AI Data Platform Workbench instance.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "recipientCount":{ "description":"The number of recipients who have access on this share.\n", "type":"integer" }, "assetCount":{ "description":"The number of assets in this share.\n", "type":"integer" }, "description":{ "description":"A description associated with this share.", "type":"string" }, "timeCreated":{ "description":"The date and time the Delta Share was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user who created the share.\n", "type":"string" }, "lifecycleState":{ "description":"The state of the Share.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ShareLifecycleState", "enum":[ "ACTIVE" ] }, "timeUpdated":{ "description":"The date and time the Delta Share was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "updatedBy":{ "description":"The ID of the user who last updated the share.\n", "type":"string" } } }, "ShareCollection":{ "type":"object", "description":"Results of a listing Delta Shares. Contains summary information of shares.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Shares.", "type":"array", "items":{ "$ref":"#/definitions/ShareSummary" } } } }, "SharePrivilege":{ "description":"The privilege for a share, which can be an inherited privilege coming from the object higher in the hierarchy.", "type":"string", "enum":[ "ADMIN", "READ", "USE" ] }, "SharePermissionCollection":{ "type":"object", "description":"List of share permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of share permissions.", "type":"array", "items":{ "$ref":"#/definitions/SharePermissionSummary" } } } }, "SharePermissionSummary":{ "description":"Information about a share permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a share.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/SharePrivilege", "enum":[ "ADMIN", "READ", "USE" ] } } } }, "AssignSharePermissionDetails":{ "description":"The details of the permissions assigned on the share to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/SharePrivilege", "enum":[ "ADMIN", "READ", "USE" ] } } } }, "RevokeSharePermissionDetails":{ "description":"The details of the permissions revoked from assignees for a share.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/SharePrivilege", "enum":[ "ADMIN", "READ", "USE" ] } } } }, "ManageSharePermissionDetails":{ "description":"Information to update permissions on a share.", "type":"object", "properties":{ "assignSharePermissionDetails":{ "$ref":"#/definitions/AssignSharePermissionDetails" }, "revokeSharePermissionDetails":{ "$ref":"#/definitions/RevokeSharePermissionDetails" } } }, "ShareDataAssetAction":{ "description":"The action of an operation.", "type":"string", "enum":[ "ADD", "REMOVE" ] }, "ShareDataAssetType":{ "description":"The asset type of an operation.", "type":"string", "enum":[ "SCHEMA", "TABLE", "VIEW" ] }, "ManageShareDataAssetDetails":{ "description":"Information to update data assets on a share.", "type":"object", "required":[ "action", "type", "name" ], "properties":{ "action":{ "description":"The action of this update.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ShareDataAssetAction", "enum":[ "ADD", "REMOVE" ] }, "type":{ "description":"The asset type for this update.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ShareDataAssetType", "enum":[ "SCHEMA", "TABLE", "VIEW" ] }, "name":{ "description":"The data asset name for this operation. For relational assets, it should be fully qualified name. For example, catalog.schema or catalog.schema.table.\n", "type":"string" }, "description":{ "description":"The data asset description for this operation.\n", "type":"string" }, "partition":{ "description":"Partition clause information, only applicable for TABLE.\n", "type":"string" }, "alias":{ "description":"The data asset alias for this operation, only applicable for TABLE and VIEW.\n", "type":"string" } } }, "ShareDataAssetSummary":{ "description":"Summary information about a share data asset.", "type":"object", "required":[ "type", "name", "createdBy" ], "properties":{ "type":{ "description":"The asset type for this update.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ShareDataAssetType", "enum":[ "SCHEMA", "TABLE", "VIEW" ] }, "name":{ "description":"The data asset name for this operation.\n", "type":"string" }, "createdBy":{ "description":"The ID of the user who created the share data asset.\n", "type":"string" }, "description":{ "description":"Short description or comment.", "type":"string" }, "catalog":{ "description":"The data asset catalog for this operation.\n", "type":"string" }, "partition":{ "description":"Partition clause information, only applicable for TABLE.\n", "type":"string" }, "timeCreated":{ "description":"The date and time the Delta Share Data Asset was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Delta Share Data Asset was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" } } }, "ShareDataAssetCollection":{ "type":"object", "description":"Results of a listing Delta Shares assets. Contains summary information of shares assets.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Shares assets.", "type":"array", "items":{ "$ref":"#/definitions/ShareDataAssetSummary" } } } }, "ShareAccessAction":{ "description":"The action for an operation to grant/revoke consumption access on a share to/from a recipient.", "type":"string", "enum":[ "GRANT", "REVOKE" ] }, "ManageShareAccessDetails":{ "description":"Information to perform grant/revoke consumption access on a share to/from a recipient.", "type":"object", "required":[ "action", "recipient" ], "properties":{ "action":{ "description":"The action. Either Grant or Revoke.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ShareAccessAction", "enum":[ "GRANT", "REVOKE" ] }, "recipient":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 } } }, "RecipientPropertyKey":{ "description":"Recipient property keys.", "type":"string", "enum":[ "ACTIVATION_LINK_EMAIL", "DELTA_SHARE_ENDPOINT", "ACTIVATION_LINK", "ACTIVATION_TOKEN_KEY", "ACTIVATION_TOKEN_EXPIRY_TIME", "BEARER_TOKEN_KEY", "BEARER_TOKEN_EXPIRY_TIME" ] }, "RecipientLifecycleState":{ "description":"The state of the Recipient", "type":"string", "enum":[ "ACTIVE", "INACTIVE" ] }, "Recipient":{ "description":"A Delta Share recipient can access the data assets in AI Data Platform Workbench through Delta Share Protocol.\n", "type":"object", "required":[ "key", "timeCreated", "displayName", "createdBy", "shareCount", "lifecycleState" ], "properties":{ "key":{ "description":"Unique identifier for this recipient in AI Data Platform Workbench instance.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"Short description of the Recipient", "type":"string" }, "timeCreated":{ "description":"The date and time the Delta Share recipient was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Delta Share recipient was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "shareCount":{ "description":"The number of shares this recipient has access on.\n", "type":"integer" }, "createdBy":{ "description":"The ID of the user who created the recipient.\n", "type":"string" }, "updatedBy":{ "description":"The ID of the user who last updated the recipient.\n", "type":"string" }, "properties":{ "description":"Key-value pair representing a defined tag key and value.\nExample: `{ \"CostCenter\": \"42\" }`\n", "type":"object", "additionalProperties":{ "type":"string" } }, "lifecycleState":{ "description":"The state of the recipient.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/RecipientLifecycleState", "enum":[ "ACTIVE", "INACTIVE" ] }, "lifecycleStateDetails":{ "description":"A message describing the current state in more detail.", "type":"string" } } }, "CreateRecipientDetails":{ "description":"The details for creating a Delta Share recipient in AI Data Platform Workbench.", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"Short description of the Recipient", "type":"string" }, "properties":{ "description":"Key-value pair representing a defined tag key and value.\nExample: `{ \"CostCenter\": \"42\" }`\n", "type":"object", "additionalProperties":{ "type":"string" } } } }, "RecipientSummary":{ "description":"Summary information about a recipient.", "type":"object", "required":[ "key", "displayName", "timeCreated", "createdBy" ], "properties":{ "key":{ "description":"Unique identifier for this recipient in AI Data Platform Workbench instance.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"Short description of the Recipient", "type":"string" }, "shareCount":{ "description":"The number of shares this recipient has access on.\n", "type":"integer" }, "timeCreated":{ "description":"The date and time the Delta Share recipient was created, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The ID of the user who created the recipient.\n", "type":"string" }, "lifecycleState":{ "description":"The state of the recipient.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/RecipientLifecycleState", "enum":[ "ACTIVE", "INACTIVE" ] }, "lifecycleDetails":{ "description":"A message describing the current state in more detail.", "type":"string" }, "updatedBy":{ "description":"The ID of the user who last updated the recipient.\n", "type":"string" }, "timeUpdated":{ "description":"The date and time the Delta Share recipient was updated, in the format defined by RFC 3339.\nExample: `2016-08-25T21:10:29.600Z`\n", "type":"string", "format":"date-time" } } }, "RecipientCollection":{ "type":"object", "description":"Results of a listing Delta Share recipients. Contains summary information of recipients.", "required":[ "items" ], "properties":{ "items":{ "description":"List of recipients.", "type":"array", "items":{ "$ref":"#/definitions/RecipientSummary" } } } }, "RecipientPrivilege":{ "description":"The privilege for a recipient", "type":"string", "enum":[ "ADMIN", "USE", "READ" ] }, "RecipientPermissionSummary":{ "description":"Information about a recipient permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a recipient.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/RecipientPrivilege", "enum":[ "ADMIN", "USE", "READ" ] } } } }, "RecipientPermissionCollection":{ "type":"object", "description":"List of recipient permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of recipient permissions.", "type":"array", "items":{ "$ref":"#/definitions/RecipientPermissionSummary" } } } }, "AssignRecipientPermissionDetails":{ "description":"The details of the permissions assigned on the recipient to an assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/RecipientPrivilege", "enum":[ "ADMIN", "USE", "READ" ] } } } }, "RevokeRecipientPermissionDetails":{ "description":"The details of the permissions revoked from assignees for a recipient.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/RecipientPrivilege", "enum":[ "ADMIN", "USE", "READ" ] } } } }, "ManageRecipientPermissionDetails":{ "description":"Information to update permissions on a recipient.", "type":"object", "properties":{ "assignRecipientPermissionDetails":{ "$ref":"#/definitions/AssignRecipientPermissionDetails" }, "revokeRecipientPermissionDetails":{ "$ref":"#/definitions/RevokeRecipientPermissionDetails" } } }, "UpdateRecipientDetails":{ "description":"The data to update a recipient.", "type":"object", "properties":{ "displayName":{ "description":"A user-friendly name. Has to be unique within the AI Data Platform Workbench instance.", "type":"string" }, "description":{ "description":"Short description of the Recipient", "type":"string" }, "properties":{ "description":"Key-value pair representing a defined tag key and value.\nExample: `{ \"CostCenter\": \"42\" }`\n", "type":"object", "additionalProperties":{ "type":"string" } } } }, "Model":{ "description":"A Data Lake Model details", "discriminator":"modelType", "type":"object", "x-obmcs-splat":{ "ocidEntityType":"Model", "activeLifecycleStates":[ "active" ], "deletedLifecycleStates":[ "deleted" ], "adLocality":"regional" }, "required":[ "id", "modelName" ], "properties":{ "modelType":{ "description":"Possible modelTypes of Models object", "type":"string", "enum":[ "GEN_AI" ] }, "id":{ "description":"A unique Id for the model, that is immutable on creation.", "type":"string", "minLength":1, "maxLength":255 }, "modelName":{ "description":"modelName that is immutable on creation.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"The model name. It can be changed.", "type":"string", "maxLength":255 }, "namespaceName":{ "description":"The model's schema.", "type":"string", "maxLength":255 }, "description":{ "description":"The description of the Model.", "type":"string" }, "timeCreated":{ "description":"The time the Model was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The time the Model was updated. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The vendor who created the Model.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The vendor who updated the Model.", "type":"string", "minLength":1, "maxLength":255 }, "lifecycleState":{ "description":"The state of the Model.", "type":"string", "enum":[ "ACTIVE", "CREATING", "DELETING", "DELETED", "FAILED" ] }, "lifecycleDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" } } }, "AiModel":{ "description":"A Data Lake AiModel details\n", "allOf":[ { "$ref":"#/definitions/Model" }, { "discriminator":"GEN_AI", "properties":{ "modelCapabilities":{ "description":"Provides Ai Model's Capabilities.", "type":"array", "items":{ "$ref":"#/definitions/AiModelCapabilitiesEnum" } }, "modelVersion":{ "description":"version that is available for that AI Model.", "type":"string", "minLength":1, "maxLength":30 }, "vendor":{ "description":"vendor name for that Model.", "type":"string", "minLength":1, "maxLength":30 }, "regionId":{ "description":"region source of that model", "type":"string", "minLength":1, "maxLength":30 } } } ] }, "ModelParameterDetail":{ "type":"object", "description":"The detail summary of each model parameter", "properties":{ "codeGenName":{ "type":"string", "description":"Internal code-friendly name for the parameter", "minLength":1, "maxLength":100 }, "name":{ "type":"string", "description":"Human-readable name for the parameter", "minLength":1, "maxLength":100 }, "description":{ "type":"string", "description":"Description of the parameter", "minLength":1, "maxLength":255 } } }, "ModelParameterResponse":{ "description":"Details of each Model Parameter", "type":"object", "properties":{ "maximumOutputTokens":{ "$ref":"#/definitions/ModelParameterDetail" }, "temperature":{ "$ref":"#/definitions/ModelParameterDetail" }, "topP":{ "$ref":"#/definitions/ModelParameterDetail" }, "topK":{ "$ref":"#/definitions/ModelParameterDetail" }, "frequencyPenalty":{ "$ref":"#/definitions/ModelParameterDetail" }, "presencePenalty":{ "$ref":"#/definitions/ModelParameterDetail" }, "seed":{ "$ref":"#/definitions/ModelParameterDetail" }, "reasoningEffort":{ "$ref":"#/definitions/ModelParameterDetail" }, "numberOfGenerations":{ "$ref":"#/definitions/ModelParameterDetail" }, "truncate":{ "$ref":"#/definitions/ModelParameterDetail" }, "preambleOverride":{ "$ref":"#/definitions/ModelParameterDetail" }, "safetyMode":{ "$ref":"#/definitions/ModelParameterDetail" } } }, "ModelParameter":{ "type":"object", "description":"The parameter details of each model", "required":[ "modelName", "modelParameters" ], "properties":{ "modelName":{ "type":"string", "description":"name of the model" }, "modelParameters":{ "$ref":"#/definitions/ModelParameterResponse" } } }, "ModelSummary":{ "description":"The summary of the Model.", "type":"object", "required":[ "id", "modelName", "modelVersion", "modelType" ], "properties":{ "id":{ "description":"A unique Id for the Model summary, that is immutable on creation.", "type":"string", "minLength":1, "maxLength":255 }, "modelName":{ "description":"A unique key for the Model summary, that is immutable on creation.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"The Model summary name, it can be changed.", "type":"string", "maxLength":255 }, "modelVersion":{ "description":"version that is available for that Model.", "type":"string", "minLength":1, "maxLength":30 }, "vendor":{ "description":"vendor name for that Model.", "type":"string", "minLength":1, "maxLength":30 }, "modelType":{ "description":"Possible modelTypes of Models object", "type":"string", "enum":[ "GEN_AI" ] } } }, "AiModelCapabilitiesEnum":{ "description":"Possible capabilities of AiModels object", "type":"string", "enum":[ "FINE_TUNE", "CHAT", "TEXT_EMBEDDINGS" ] }, "ModelsCollection":{ "type":"object", "description":"The results of a Models list, it contains ModelSummary objects.", "required":[ "items" ], "properties":{ "items":{ "description":"The Models Summaries returned.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/ModelSummary" } } } }, "DacEndpointCollection":{ "type":"object", "description":"Results of an endpoint search. Contains EndpointSummary items and other information such as metadata.", "required":[ "items" ], "properties":{ "items":{ "description":"List of endpoints.", "type":"array", "items":{ "$ref":"#/definitions/DacEndpointSummary" } } } }, "DacEndpointSummary":{ "description":"Summary information for an endpoint resource.", "type":"object", "required":[ "id", "compartmentId", "lifecycleState", "timeCreated", "modelId", "dedicatedAiClusterId" ], "properties":{ "id":{ "description":"An OCID that uniquely identifies this endpoint resource.", "type":"string" }, "displayName":{ "description":"A user-friendly name. Does not have to be unique, and it's changeable.", "type":"string" }, "description":{ "description":"An optional description of the endpoint.", "type":"string" }, "modelId":{ "description":"The OCID of the model that's used to create this endpoint.", "type":"string" }, "compartmentId":{ "description":"The compartment OCID to create the endpoint in.", "type":"string" }, "dedicatedAiClusterId":{ "description":"The OCID of the dedicated AI cluster on which a model will be deployed to.", "type":"string" }, "timeCreated":{ "description":"The date and time that the endpoint was created in the format of an RFC3339 datetime string.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the endpoint was updated in the format of n RFC3339 datetime string.", "type":"string", "format":"date-time" }, "lifecycleState":{ "description":"The current state of the endpoint.\nAllowed values are:\n- ACTIVE\n- CREATING\n- UPDATING\n- DELETING\n- DELETED\n- FAILED\n", "type":"string", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING", "DELETED", "FAILED" ] }, "lifecycleDetails":{ "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.", "type":"string" }, "contentModerationConfig":{ "$ref":"#/definitions/ContentModerationConfig" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "ContentModerationConfig":{ "type":"object", "description":"The configuration details, whether to add the content moderation feature to the model. Content moderation removes toxic and biased content from responses.", "required":[ "isEnabled" ], "properties":{ "mode":{ "type":"string", "description":"Enum for the modes of operation for inference protection.", "enum":[ "INFORM", "BLOCK" ], "default":"INFORM" }, "modelId":{ "description":"The OCID of the model used for the feature.", "type":"string" }, "isEnabled":{ "description":"Whether to enable the content moderation feature.", "type":"boolean" } } }, "ObjectType":{ "description":"Type of Object", "type":"string", "enum":[ "DATA_LAKE", "ROLE", "CATALOG", "SCHEMA", "TABLE", "VOLUME", "VIEW", "WORKSPACE", "WORKSPACE_FILE", "WORKSPACE_FOLDER", "COMPUTE", "FOLDER", "FILE", "AUTO_POPULATE", "VOLUME_FILE", "VOLUME_FOLDER", "KNOWLEDGE_BASE", "KNOWLEDGE_BASE_JOB", "KNOWLEDGE_BASE_JOB_RUN", "KNOWLEDGE_BASE_OWNERSHIP", "VECTOR_STORE_CREDENTIALS", "AUDIT_LOG", "WORKFLOW", "CREDENTIAL" ] }, "Operation":{ "description":"Type of operation", "type":"string", "enum":[ "CREATE", "UPDATE", "DELETE", "VIEW", "GRANT", "REVOKE", "ATTACH", "DETACH", "VIEW_LOGS", "RENAME", "TERMINATE", "MOVE", "EXECUTE", "MANAGE_ACCESS", "QUERY", "MANAGE", "READ", "WRITE", "START", "STOP" ] }, "Action":{ "type":"string", "description":"Action to enable or disable the logs.", "enum":[ "ENABLE", "DISABLE" ] }, "Status":{ "type":"string", "description":"Status of log", "enum":[ "SUCCEEDED", "FAILED" ] }, "SearchAuditLogsDetails":{ "description":"Information needed to search the audit logs.", "type":"object", "properties":{ "timeBegin":{ "description":"Start time of the logs.", "type":"string", "format":"date-time" }, "timeEnd":{ "description":"End time of the logs.", "type":"string", "format":"date-time" }, "objectType":{ "type":"string", "description":"Type of object.", "x-obmcs-top-level-enum":"#/definitions/ObjectType", "enum":[ "DATA_LAKE", "ROLE", "CATALOG", "SCHEMA", "TABLE", "VOLUME", "VIEW", "WORKSPACE", "WORKSPACE_FILE", "WORKSPACE_FOLDER", "COMPUTE", "FOLDER", "FILE", "AUTO_POPULATE", "VOLUME_FILE", "VOLUME_FOLDER", "KNOWLEDGE_BASE", "KNOWLEDGE_BASE_JOB", "KNOWLEDGE_BASE_JOB_RUN", "KNOWLEDGE_BASE_OWNERSHIP", "VECTOR_STORE_CREDENTIALS", "AUDIT_LOG", "WORKFLOW", "CREDENTIAL" ] }, "objectName":{ "description":"Name of the object.", "type":"string" }, "operation":{ "type":"string", "description":"Type of operation.", "x-obmcs-top-level-enum":"#/definitions/Operation", "enum":[ "CREATE", "UPDATE", "DELETE", "VIEW", "GRANT", "REVOKE", "ATTACH", "DETACH", "VIEW_LOGS", "RENAME", "TERMINATE", "MOVE", "EXECUTE", "MANAGE_ACCESS", "QUERY", "MANAGE", "READ", "WRITE", "START", "STOP" ] }, "status":{ "type":"string", "description":"Status of log.", "x-obmcs-top-level-enum":"#/definitions/Status", "enum":[ "SUCCEEDED", "FAILED" ] }, "startedBy":{ "description":"Operation started by.", "type":"string" }, "query":{ "description":"Query to search the log.", "type":"string" }, "sortBy":{ "type":"string", "enum":[ "startedBy", "status", "operation", "objectType", "objectName", "time" ], "default":"time", "description":"The field to sort by.\n" }, "sortOrder":{ "description":"Sort order for search results.", "type":"string", "example":"DESC", "enum":[ "ASC", "DESC" ] } } }, "AuditLogSearchResultCollection":{ "description":"Search results for audit log search request.", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"Audit log search results.", "type":"array", "items":{ "$ref":"#/definitions/AuditLogSearchResultSummary" } } } }, "AuditLogSearchResultSummary":{ "description":"Search result for audit log search request.", "type":"object", "properties":{ "eventId":{ "description":"Unique ID of the result.", "type":"string" }, "timeOfLog":{ "description":"Time of the log.", "type":"string", "format":"date-time" }, "objectType":{ "type":"string", "description":"Type of object.", "enum":[ "DATA_LAKE", "ROLE", "CATALOG", "SCHEMA", "TABLE", "VOLUME", "VIEW", "WORKSPACE", "WORKSPACE_FILE", "WORKSPACE_FOLDER", "COMPUTE", "FOLDER", "FILE", "AUTO_POPULATE", "VOLUME_FILE", "VOLUME_FOLDER", "KNOWLEDGE_BASE", "KNOWLEDGE_BASE_JOB", "KNOWLEDGE_BASE_JOB_RUN", "KNOWLEDGE_BASE_OWNERSHIP", "VECTOR_STORE_CREDENTIALS", "AUDIT_LOG", "WORKFLOW", "CREDENTIAL" ], "x-obmcs-top-level-enum":"#/definitions/ObjectType" }, "objectName":{ "description":"Name of the object.", "type":"string" }, "operation":{ "type":"string", "description":"Type of operation.", "enum":[ "CREATE", "UPDATE", "DELETE", "VIEW", "GRANT", "REVOKE", "ATTACH", "DETACH", "VIEW_LOGS", "RENAME", "TERMINATE", "MOVE", "EXECUTE", "MANAGE_ACCESS", "QUERY", "MANAGE", "READ", "WRITE", "START", "STOP" ], "x-obmcs-top-level-enum":"#/definitions/Operation" }, "status":{ "type":"string", "description":"Status of log.", "enum":[ "SUCCEEDED", "FAILED" ], "x-obmcs-top-level-enum":"#/definitions/Status" }, "startedBy":{ "description":"Operation started by.", "type":"string" }, "source":{ "description":"Source of logs.", "type":"string" }, "payload":{ "description":"Payload of logs.", "type":"string" } } }, "ManageAuditLogsDetails":{ "description":"Manage audit log details.", "type":"object", "properties":{ "action":{ "type":"string", "description":"Action to enable or disable the logs.", "x-obmcs-top-level-enum":"#/definitions/Action", "enum":[ "ENABLE", "DISABLE" ] }, "retentionPeriod":{ "description":"Retention period of the audit logs.", "type":"integer" } } }, "ToolType":{ "description":"Tool type.", "type":"string", "enum":[ "RAG", "SQL", "PROMPT", "NL2SQL", "MCP", "CUSTOM", "HTTP", "REFERENCE" ] }, "Tool":{ "description":"A tool is a function that an agent can call. Tools can retrieve data, call external APIs, HTTP endpoints, execute a snippet of code, entire Python scripts, etc. | A tool is stateless, doesn't reason (it just executes), and can be reused across agents.", "type":"object", "discriminator":"toolType", "properties":{ "key":{ "description":"The unique identifier of the tool", "type":"string" }, "displayName":{ "description":"Tool name.", "type":"string" }, "workspaceKey":{ "description":"The key of the Workspace to which this tool belongs.", "type":"string" }, "description":{ "description":"Tool description.", "type":"string" }, "toolType":{ "description":"Type of tool. Managed, external or mount tool.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ToolType", "enum":[ "RAG", "SQL", "PROMPT", "NL2SQL", "MCP", "CUSTOM", "HTTP", "REFERENCE" ] }, "isReference":{ "description":"If true, this tool is a reference to a tool stored in the tool cache. | Used for backward compatibility so that the toolType for the reference can be set to the original tool type.", "type":"boolean" }, "positionX":{ "description":"Canvas X coordinate of the Tool node", "type":"number", "format":"float", "default":0 }, "positionY":{ "description":"Canvas Y coordinate of the Tool node", "type":"number", "format":"float", "default":0 }, "properties":{ "description":"A list of key-value pairs to use for configuring the tool", "type":"object", "additionalProperties":{ "type":"object" } }, "timeCreated":{ "description":"The date and time the tool was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the tool was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the tool.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the schema.", "type":"string", "minLength":1, "maxLength":255 } } }, "AuthType":{ "description":"Auth type.", "type":"string", "enum":[ "NO_AUTH", "BEARER_TOKEN", "OAUTH", "OCI_RESOURCE_PRINCIPAL" ] }, "Auth":{ "description":"agent flow to communicate with MCP using the defined auth mode", "type":"object", "discriminator":"authType", "properties":{ "authType":{ "description":"Type of auth used by MCP. Basic or bearer token or resource principal.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AuthType", "enum":[ "NO_AUTH", "BEARER_TOKEN", "OAUTH", "OCI_RESOURCE_PRINCIPAL" ] } } }, "NoAuth":{ "description":"Auth configuration while using no auth mode", "allOf":[ { "$ref":"#/definitions/Auth" }, { "discriminator":"NO_AUTH" } ] }, "OciResourcePrincipalAuth":{ "description":"Auth configuration while using AIDP resource principal for auth", "allOf":[ { "$ref":"#/definitions/Auth" }, { "discriminator":"OCI_RESOURCE_PRINCIPAL" } ] }, "BearerTokenAuth":{ "description":"Auth configuration while using bearer token", "allOf":[ { "$ref":"#/definitions/Auth" }, { "discriminator":"BEARER_TOKEN", "properties":{ "token":{ "description":"The bearer token used for auth", "type":"string" } } } ] }, "OAuth":{ "description":"Auth configuration while using oauth token", "allOf":[ { "$ref":"#/definitions/Auth" }, { "discriminator":"OAUTH", "properties":{ "clientId":{ "description":"The clientId of the confidential app for auth", "type":"string" }, "clientSecret":{ "description":"The secret of the confidential app for auth", "type":"string" }, "issuerIdpEndpoint":{ "description":"The endpoint for the issuer idp", "type":"string" }, "scopes":{ "description":"The list of scopes for oauth", "type":"array", "items":{ "type":"string" } } } } ] }, "RagTool":{ "description":"Derived model for RAG Tool", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"RAG", "properties":{ "inputSchema":{ "$ref":"#/definitions/RagToolInputSchema" }, "toolConfig":{ "$ref":"#/definitions/RagToolConfiguration" } } } ] }, "RagToolInputSchema":{ "description":"The input schema definition of a RAG Tool", "properties":{ "query":{ "description":"The user question to answer using relevant documents", "type":"string" } } }, "RagToolConfiguration":{ "description":"Tool configurations are set by the agent developer when they create the tool. | The agent does not see those configurations and can NOT modify their values", "properties":{ "catalogKey":{ "description":"The Catalog to use for KB tool execution", "type":"string" }, "schemaKey":{ "description":"The Schema to use for KB tool execution", "type":"string" }, "knowledgeBase":{ "description":"The name of the Knowledge Base to use for RAG query", "type":"string", "maxLength":1000 }, "llm":{ "$ref":"#/definitions/LlmConfig" }, "modelSettings":{ "description":"Model specific inference parameters such as temperature, top-k, max length, response format, etc.", "type":"object", "additionalProperties":{ "type":"object" } }, "topK":{ "description":"Number of top chunks to retrieve from the KB", "type":"integer", "default":5, "minimum":1, "maximum":100 } } }, "SqlTool":{ "description":"Derived model a SQL Tool", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"SQL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/SqlToolConfiguration" } } } ] }, "SqlToolConfiguration":{ "description":"Tool configurations are set by the agent developer when they create the tool. | The agent does not see those configurations and can NOT modify their values", "properties":{ "catalogKey":{ "description":"The Catalog to use for SQL query execution", "type":"string" }, "schemaKey":{ "description":"The Schema to use for SQL query execution", "type":"string" }, "query":{ "description":"The SQL query to execute", "type":"string" }, "isRowLimitEnabled":{ "description":"Whether to enforce the row limit when running the SQL tool", "type":"boolean", "default":false }, "maxRows":{ "description":"Maximum number of result rows returned per SQL tool execution to prevent oversized result sets", "type":"integer" } } }, "PromptTool":{ "description":"Derived model for Prompt Tool", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"PROMPT", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/PromptToolConfiguration" } } } ] }, "PromptToolConfiguration":{ "description":"Tool configurations are set by the agent developer when they create the tool. | The agent does not see those configurations and can not modify their values", "properties":{ "llm":{ "$ref":"#/definitions/LlmConfig" }, "promptText":{ "description":"The generative AI prompt", "type":"string" }, "modelSettings":{ "description":"Model specific inference parameters such as temperature, top-k, max length, response format, etc.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "NlToSqlTool":{ "description":"Derived model for Natural Language (NL) to SQL Tool", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"NL2SQL", "required":[ "inputSchema", "toolConfig" ], "properties":{ "inputSchema":{ "$ref":"#/definitions/NlToSqlToolInputSchema" }, "toolConfig":{ "$ref":"#/definitions/NlToSqlToolConfiguration" } } } ] }, "NlToSqlToolInputSchema":{ "description":"The input schema definition of a NL to SQL Tool", "required":[ "query" ], "properties":{ "query":{ "description":"The user question to answer using relevant documents", "type":"string" } } }, "NlToSqlToolConfiguration":{ "description":"Tool configurations are set by the agent developer when they create the tool. | The agent does not see those configurations and can NOT modify their values", "required":[ "catalogKey", "schemaKey", "tables", "columns" ], "properties":{ "catalogKey":{ "description":"The Catalog to use for SQL query execution", "type":"string" }, "schemaKey":{ "description":"The Schema to use for SQL query execution", "type":"string" }, "tables":{ "description":"The fully qualified table names to use in SQL query generation", "type":"array", "items":{ "type":"string" } }, "columns":{ "description":"The fully qualified column names to use in SQL query generation", "type":"array", "items":{ "type":"string" } }, "inContextLearning":{ "description":"Optional few-shot examples (NL ??? SQL pairs) for better generation.", "type":"string" }, "additionalInstructions":{ "description":"Additional instructions that is injected in the system prompt", "type":"string" } } }, "McpTool":{ "description":"Derived model for Mcp Tool", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"MCP", "required":[ "toolConfig" ], "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/McpToolConfiguration" } } } ] }, "AllowedToolDetails":{ "description":"The list of allowed tool names allowed on an MCP server.", "required":[ "tool" ], "properties":{ "instruction":{ "type":"string", "description":"custom instruction for tool" }, "argOverrides":{ "type":"object", "description":"Map of parameter names to their default string values.", "additionalProperties":{ "type":"string" } }, "tool":{ "$ref":"#/definitions/McpToolObject" } } }, "McpToolConfiguration":{ "description":"Tool configurations are set by the agent developer when they create the tool. | The agent does not see those configurations and can NOT modify their values", "required":[ "endpoint" ], "properties":{ "endpoint":{ "description":"The endpoint of the mcp to connect to", "type":"string" }, "auth":{ "$ref":"#/definitions/Auth" }, "allowedTools":{ "description":"The list of allowed tools on an MCP server.", "type":"array", "items":{ "$ref":"#/definitions/AllowedToolDetails" } }, "customHeaders":{ "type":"object", "description":"Map of header key value pairs.", "additionalProperties":{ "type":"string" } } } }, "CustomTool":{ "description":"Derived model for Custom Tool", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"CUSTOM", "properties":{ "toolProvider":{ "description":"The provider of the tool, default is AIDP", "type":"string" }, "toolTypeName":{ "description":"The type name for this tool", "type":"string" }, "inputSchema":{ "description":"The list of named properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/CustomToolConfiguration" } } } ] }, "CustomToolConfiguration":{ "description":"Configuration for a custom tool package uploaded to the workspace volume.", "properties":{ "displayName":{ "description":"Human-readable name for this tool package", "type":"string" }, "description":{ "description":"Description of the tool package", "type":"string" }, "version":{ "description":"Tool package version", "type":"string" }, "packagePath":{ "description":"Workspace volume path to the uploaded ZIP file", "type":"string" }, "requirementsHash":{ "description":"SHA256 hash of requirements.txt for dependency caching", "type":"string" }, "auth":{ "$ref":"#/definitions/Auth" }, "toolProvider":{ "description":"Tool provider identifier", "type":"string", "default":"AIDP" }, "tools":{ "description":"List of tool class entries in this package (multi-tool support)", "type":"array", "items":{ "$ref":"#/definitions/CustomToolEntry" } } } }, "CustomToolEntry":{ "description":"A single tool class entry within a custom tool package", "required":[ "toolClassName", "displayName" ], "properties":{ "toolClassName":{ "description":"Python class name (e.g., WeatherTool, BashTool)", "type":"string" }, "displayName":{ "description":"Human-readable tool name shown to LLM", "type":"string" }, "description":{ "description":"Tool description for LLM tool selection", "type":"string" }, "version":{ "description":"Tool version", "type":"string" }, "config":{ "description":"Tool-specific configuration values (supports template variables)", "type":"object", "additionalProperties":{ "type":"object" } }, "inputSchema":{ "description":"JSON schema for tool input parameters", "type":"object", "additionalProperties":{ "type":"object" } } } }, "HttpTool":{ "description":"Derived model for HTTP Tool", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"HTTP", "properties":{ "inputSchema":{ "description":"The list of template variable properties in the inputSchema", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/HttpToolConfiguration" } } } ] }, "HttpMethod":{ "description":"HTTP method for the request", "type":"string", "enum":[ "GET", "POST", "PUT", "DELETE", "PATCH" ] }, "HttpToolConfiguration":{ "description":"Configuration for HTTP Tool requests", "required":[ "method", "url" ], "properties":{ "method":{ "description":"HTTP method (GET, POST, PUT, DELETE, PATCH)", "type":"string", "x-obmcs-top-level-enum":"#/definitions/HttpMethod", "enum":[ "GET", "POST", "PUT", "DELETE", "PATCH" ] }, "url":{ "description":"Target URL with optional {{variable}} templates", "type":"string", "maxLength":2048 }, "headers":{ "description":"Optional custom headers", "type":"object", "additionalProperties":{ "type":"string" } }, "params":{ "description":"Optional query parameters", "type":"object", "additionalProperties":{ "type":"string" } }, "body":{ "description":"Optional request body (for POST, PUT, PATCH)", "type":"object", "additionalProperties":{ "type":"object" } }, "timeout":{ "description":"Request timeout in seconds", "type":"integer", "default":30, "minimum":1, "maximum":300 }, "auth":{ "$ref":"#/definitions/Auth" }, "responseOptimization":{ "description":"Response optimization settings", "type":"object", "additionalProperties":{ "type":"object" } } } }, "ToolReference":{ "description":"Derived model for Tool Reference", "allOf":[ { "$ref":"#/definitions/Tool" }, { "discriminator":"REFERENCE" } ] }, "ToolSummary":{ "description":"Summary information of tool in the schema.", "type":"object", "required":[ "key", "toolType", "displayName" ], "properties":{ "key":{ "description":"The unique identifier of the tool", "type":"string" }, "displayName":{ "description":"Tool name.", "type":"string" }, "toolType":{ "description":"Type of tool. Managed, external or mount tool.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ToolType", "enum":[ "RAG", "SQL", "PROMPT", "NL2SQL", "MCP", "CUSTOM", "HTTP", "REFERENCE" ] }, "workspaceKey":{ "description":"The key of the Workspace to which this tool belongs.", "type":"string" }, "description":{ "description":"Tool description.", "type":"string" }, "timeCreated":{ "description":"The date and time the tool was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the tool was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the tool.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the schema.", "type":"string", "minLength":1, "maxLength":255 } } }, "ToolCollection":{ "type":"object", "description":"Result of listing tools in a schema.", "required":[ "items" ], "properties":{ "items":{ "description":"List of tools.", "type":"array", "items":{ "$ref":"#/definitions/ToolSummary" } } } }, "CreateToolDetails":{ "description":"The data to create a tool.", "type":"object", "discriminator":"toolType", "required":[ "displayName", "toolType" ], "properties":{ "displayName":{ "description":"Tool name.", "type":"string" }, "description":{ "description":"Tool description.", "type":"string" }, "toolType":{ "description":"Type of tool. Managed, external or mount tool.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ToolType", "enum":[ "RAG", "SQL", "PROMPT", "NL2SQL", "MCP", "CUSTOM", "HTTP", "REFERENCE" ] }, "properties":{ "description":"A list of key-value pairs to use for configuring the tool", "type":"object", "additionalProperties":{ "type":"object" } } } }, "CreateSqlToolDetails":{ "description":"Details to create a SQL Tool", "allOf":[ { "$ref":"#/definitions/CreateToolDetails" }, { "discriminator":"SQL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/SqlToolConfiguration" } } } ] }, "CreateRagToolDetails":{ "description":"Details to create a SQL Tool", "allOf":[ { "$ref":"#/definitions/CreateToolDetails" }, { "discriminator":"RAG", "properties":{ "inputSchema":{ "$ref":"#/definitions/RagToolInputSchema" }, "toolConfig":{ "$ref":"#/definitions/RagToolConfiguration" } } } ] }, "CreatePromptToolDetails":{ "description":"Details to create a Prompt Tool", "allOf":[ { "$ref":"#/definitions/CreateToolDetails" }, { "discriminator":"PROMPT", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/PromptToolConfiguration" } } } ] }, "CreateNlToSqlToolDetails":{ "description":"Details to create a NL to SQL Tool", "allOf":[ { "$ref":"#/definitions/CreateToolDetails" }, { "discriminator":"NL2SQL", "properties":{ "inputSchema":{ "$ref":"#/definitions/NlToSqlToolInputSchema" }, "toolConfig":{ "$ref":"#/definitions/NlToSqlToolConfiguration" } } } ] }, "CreateCustomToolDetails":{ "description":"Details to create a Custom Tool", "allOf":[ { "$ref":"#/definitions/CreateToolDetails" }, { "discriminator":"CUSTOM", "properties":{ "toolProvider":{ "description":"The provider of the tool, default is AIDP", "type":"string" }, "toolTypeName":{ "description":"The type name for this tool", "type":"string" }, "inputSchema":{ "description":"The list of named properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/CustomToolConfiguration" } } } ] }, "UpdateToolDetails":{ "description":"The data to update a tool.", "type":"object", "discriminator":"toolType", "properties":{ "displayName":{ "description":"Tool name.", "type":"string" }, "description":{ "description":"Tool description.", "type":"string" }, "toolType":{ "description":"Type of tool. Managed, external or mount tool.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ToolType", "enum":[ "RAG", "SQL", "PROMPT", "NL2SQL", "MCP", "CUSTOM", "HTTP", "REFERENCE" ] }, "properties":{ "description":"A list of key-value pairs to use for configuring the tool", "type":"object", "additionalProperties":{ "type":"object" } } } }, "UpdateSqlToolDetails":{ "description":"Details to update a SQL Tool", "allOf":[ { "$ref":"#/definitions/UpdateToolDetails" }, { "discriminator":"SQL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/SqlToolConfiguration" } } } ] }, "UpdateRagToolDetails":{ "description":"Details to update a RAG Tool", "allOf":[ { "$ref":"#/definitions/UpdateToolDetails" }, { "discriminator":"RAG", "properties":{ "inputSchema":{ "$ref":"#/definitions/RagToolInputSchema" }, "toolConfig":{ "$ref":"#/definitions/RagToolConfiguration" } } } ] }, "UpdatePromptToolDetails":{ "description":"Details to update a Prompt Tool", "allOf":[ { "$ref":"#/definitions/UpdateToolDetails" }, { "discriminator":"PROMPT", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/PromptToolConfiguration" } } } ] }, "UpdateNlToSqlToolDetails":{ "description":"Details to update a NL to SQL Tool", "allOf":[ { "$ref":"#/definitions/UpdateToolDetails" }, { "discriminator":"NL2SQL", "properties":{ "inputSchema":{ "$ref":"#/definitions/NlToSqlToolInputSchema" }, "toolConfig":{ "$ref":"#/definitions/NlToSqlToolConfiguration" } } } ] }, "UpdateCustomToolDetails":{ "description":"Details to update a Custom Tool", "allOf":[ { "$ref":"#/definitions/UpdateToolDetails" }, { "discriminator":"CUSTOM", "properties":{ "toolProvider":{ "description":"The provider of the tool, default is AIDP", "type":"string" }, "toolTypeName":{ "description":"The type name for this tool", "type":"string" }, "inputSchema":{ "description":"The list of named properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/CustomToolConfiguration" } } } ] }, "CreateHttpToolDetails":{ "description":"Details to create an HTTP Tool", "allOf":[ { "$ref":"#/definitions/CreateToolDetails" }, { "discriminator":"HTTP", "properties":{ "inputSchema":{ "description":"The list of template variable properties in the inputSchema", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/HttpToolConfiguration" } } } ] }, "UpdateHttpToolDetails":{ "description":"Details to update an HTTP Tool", "allOf":[ { "$ref":"#/definitions/UpdateToolDetails" }, { "discriminator":"HTTP", "properties":{ "inputSchema":{ "description":"The list of template variable properties in the inputSchema", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/HttpToolConfiguration" } } } ] }, "ToolPrivilegeForManage":{ "description":"The privilege for a tool.", "type":"string", "enum":[ "READ", "MANAGE", "ADMIN" ] }, "ToolPrivilege":{ "description":"The privilege for a tool. Can be inherited privilege coming from object higher up in hierarchy.", "type":"string", "enum":[ "READ", "MANAGE", "ADMIN" ] }, "ToolPermissionCollection":{ "type":"object", "description":"List of tool permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of tool permissions.", "type":"array", "items":{ "$ref":"#/definitions/ToolPermissionSummary" } } } }, "ToolPermissionSummary":{ "description":"Information about a tool permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a tool.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ToolPrivilege", "enum":[ "READ", "MANAGE", "ADMIN" ] } }, "columns":{ "description":"The list of the columns included for permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of the columns excluded from permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "isInherited":{ "type":"boolean", "description":"If the permission listed is inherited or not from object higher up in hierarchy." }, "resourceName":{ "type":"string", "description":"Name of the object to which this permission belong to. Name of tool if permission is not inherited or name of object higher up in hierarchy if permission is inherited." } } }, "AssignToolPermissionDetails":{ "description":"The details of the permissions assigned on the tool to assignee.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ToolPrivilegeForManage", "enum":[ "READ", "MANAGE", "ADMIN" ] } }, "includeColumns":{ "description":"The list of columns to be included for the assigning of permissions", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the assigning of permissions", "type":"array", "items":{ "type":"string" } } } }, "RevokeToolPermissionDetails":{ "description":"The details of the permissions revoked from assignee for a tool.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "description":"The permissions revoked from the assignee.", "type":"array", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/ToolPrivilegeForManage", "enum":[ "READ", "MANAGE", "ADMIN" ] } }, "includeColumns":{ "description":"The list of columns to be included for the revoking of permissions.", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the revoking of permissions.", "type":"array", "items":{ "type":"string" } } } }, "ManageToolPermissionDetails":{ "description":"Information to update permissions on a tool.", "type":"object", "properties":{ "assignToolPermissionDetails":{ "$ref":"#/definitions/AssignToolPermissionDetails" }, "revokeToolPermissionDetails":{ "$ref":"#/definitions/RevokeToolPermissionDetails" } } }, "McpObjectType":{ "description":"Mcp object type.", "type":"string", "enum":[ "TOOL", "PROMPT", "RESOURCE" ] }, "FetchMcpObjectsDetails":{ "description":"The required details for testing an mcp tool", "type":"object", "required":[ "mcpTool", "type" ], "properties":{ "agentFlowId":{ "type":"string", "minLength":1, "maxLength":255, "description":"Agent flow id for which the tool is being tested" }, "type":{ "description":"Type of object. Tool, prompt or resource hosted on an MCP.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/McpObjectType", "enum":[ "TOOL", "PROMPT", "RESOURCE" ] }, "mcpTool":{ "$ref":"#/definitions/McpTool" }, "sortOrder":{ "type":"string", "description":"The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `displayName`\nsort order is case sensitive.\n", "enum":[ "ASC", "DESC" ] }, "sortBy":{ "type":"string", "enum":[ "TIME_CREATED" ], "default":"time", "description":"The field to sort by.\n" }, "limit":{ "type":"integer", "description":"For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "minimum":1, "maximum":1000, "default":100 }, "page":{ "type":"string", "minLength":1, "description":"For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, "paramValues":{ "type":"object", "description":"Map of parameter names to their string values.", "additionalProperties":{ "type":"string" } } } }, "TestToolDetails":{ "description":"Base model for testing any tool. `toolType` drives the subtype.", "type":"object", "discriminator":"toolType", "required":[ "agentFlowId", "toolType" ], "properties":{ "agentFlowId":{ "type":"string", "minLength":1, "maxLength":255, "description":"Agent flow id for which the tool is being tested" }, "toolType":{ "type":"string", "enum":[ "SQL", "PROMPT", "RAG", "MCP", "HTTP", "CUSTOM" ], "description":"Which kind of tool this test is for (chooses the subtype)." } } }, "TestSqlToolDetails":{ "description":"Request details when toolType = SQL.", "allOf":[ { "$ref":"#/definitions/TestToolDetails" }, { "discriminator":"SQL", "required":[ "config", "paramValues" ], "properties":{ "config":{ "$ref":"#/definitions/SqlToolConfiguration" }, "paramValues":{ "$ref":"#/definitions/TestToolParamValues" } } } ] }, "TestToolParamValues":{ "description":"Named parameters and their values for the test action.", "type":"object", "properties":{ "values":{ "type":"object", "description":"Map of parameter names to their string values.", "additionalProperties":{ "type":"string" } } } }, "TestPromptToolDetails":{ "description":"Request details when toolType = PROMPT.", "allOf":[ { "$ref":"#/definitions/TestToolDetails" }, { "discriminator":"PROMPT", "required":[ "config", "paramValues" ], "properties":{ "config":{ "$ref":"#/definitions/PromptToolConfiguration" }, "paramValues":{ "$ref":"#/definitions/TestToolParamValues" } } } ] }, "TestRagToolDetails":{ "description":"Request details when toolType = RAG.", "allOf":[ { "$ref":"#/definitions/TestToolDetails" }, { "discriminator":"RAG", "required":[ "config", "query" ], "properties":{ "config":{ "$ref":"#/definitions/RagToolConfiguration" }, "query":{ "type":"string", "description":"The user query or instruction to be augmented with retrieved context.", "minLength":1, "maxLength":4000 } } } ] }, "McpTestType":{ "description":"Mcp test type.", "type":"string", "enum":[ "CONNECTION", "EXTERNAL_TOOL" ] }, "TestMcpOperation":{ "type":"object", "description":"Represents a type of testing on mcp.", "discriminator":"testType", "required":[ "testType" ], "properties":{ "testType":{ "description":"Type of test supported by MCP.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/McpTestType", "enum":[ "CONNECTION", "EXTERNAL_TOOL" ] } } }, "TestMcpConnection":{ "description":"Test mcp tool connection", "allOf":[ { "$ref":"#/definitions/TestMcpOperation" }, { "discriminator":"CONNECTION" } ] }, "TestMcpExternalTool":{ "description":"Test mcp tool connection", "allOf":[ { "$ref":"#/definitions/TestMcpOperation" }, { "discriminator":"EXTERNAL_TOOL", "required":[ "externalToolName" ], "properties":{ "externalToolName":{ "type":"string", "description":"name of external tool to test" }, "paramValues":{ "$ref":"#/definitions/TestToolParamValues" } } } ] }, "TestMcpToolDetails":{ "description":"Request details when toolType = MCP", "allOf":[ { "$ref":"#/definitions/TestToolDetails" }, { "discriminator":"MCP", "required":[ "config", "mcpTest", "serverName" ], "properties":{ "config":{ "$ref":"#/definitions/McpToolConfiguration" }, "mcpTest":{ "$ref":"#/definitions/TestMcpOperation" }, "paramValues":{ "$ref":"#/definitions/TestToolParamValues" }, "serverName":{ "type":"string", "description":"name of mcp server" } } } ] }, "TestHttpToolDetails":{ "description":"Request details when toolType = HTTP", "allOf":[ { "$ref":"#/definitions/TestToolDetails" }, { "discriminator":"HTTP", "required":[ "config" ], "properties":{ "config":{ "$ref":"#/definitions/HttpToolConfiguration" }, "paramValues":{ "$ref":"#/definitions/TestToolParamValues" } } } ] }, "TestCustomToolDetails":{ "description":"Request details when toolType = CUSTOM", "allOf":[ { "$ref":"#/definitions/TestToolDetails" }, { "discriminator":"CUSTOM", "required":[ "toolConfig" ], "properties":{ "toolConfig":{ "$ref":"#/definitions/CustomToolConfiguration" }, "paramValues":{ "$ref":"#/definitions/TestToolParamValues" }, "packageContent":{ "type":"string", "description":"Base64-encoded ZIP file content for inline package upload during testing" } } } ] }, "TestToolResult":{ "description":"Base response for a test tool action.", "type":"object", "discriminator":"toolType", "required":[ "toolType" ], "properties":{ "toolType":{ "type":"string", "enum":[ "SQL", "PROMPT", "RAG", "MCP", "HTTP", "CUSTOM" ], "description":"Selects which result schema applies." } } }, "SqlTestToolResult":{ "description":"Response when toolType = SQL.", "allOf":[ { "$ref":"#/definitions/TestToolResult" }, { "discriminator":"SQL", "required":[ "result" ], "properties":{ "result":{ "$ref":"#/definitions/SqlResult" } } } ] }, "PromptTestToolResult":{ "description":"Response when toolType = PROMPT.", "allOf":[ { "$ref":"#/definitions/TestToolResult" }, { "discriminator":"PROMPT", "required":[ "result" ], "properties":{ "result":{ "$ref":"#/definitions/PromptResult" } } } ] }, "RagTestToolResult":{ "description":"Response when toolType = RAG.", "allOf":[ { "$ref":"#/definitions/TestToolResult" }, { "discriminator":"RAG", "required":[ "result" ], "properties":{ "result":{ "$ref":"#/definitions/RagResult" } } } ] }, "SqlResult":{ "description":"Rows for SQL result.", "type":"object", "properties":{ "rows":{ "type":"array", "description":"Array of result rows with dynamic columns.", "items":{ "type":"object", "additionalProperties":{ "type":"string" } } } } }, "PromptResult":{ "description":"Generated text info for prompt result.", "type":"object", "required":[ "type", "data" ], "properties":{ "type":{ "type":"string", "description":"Format of the prompt result (e.g., \"text\", \"markdown\", \"image\")." }, "data":{ "type":"string", "description":"The generated content from the prompt." } } }, "McpTestToolResult":{ "description":"Response when toolType = MCP.", "allOf":[ { "$ref":"#/definitions/TestToolResult" }, { "discriminator":"MCP", "required":[ "result" ], "properties":{ "result":{ "$ref":"#/definitions/McpResult" } } } ] }, "McpResult":{ "description":"Generated text info for mcp result.", "type":"object", "required":[ "data" ], "properties":{ "data":{ "type":"string", "description":"The generated content from the mcp." } } }, "HttpTestToolResult":{ "description":"Response when toolType = HTTP.", "allOf":[ { "$ref":"#/definitions/TestToolResult" }, { "discriminator":"HTTP", "required":[ "result" ], "properties":{ "result":{ "$ref":"#/definitions/HttpResult" } } } ] }, "HttpResult":{ "description":"Result from HTTP tool execution.", "type":"object", "properties":{ "statusCode":{ "type":"integer", "description":"HTTP response status code" }, "headers":{ "type":"object", "description":"Response headers", "additionalProperties":{ "type":"string" } }, "body":{ "type":"object", "description":"Response body", "additionalProperties":{ "type":"object" } } } }, "CustomTestToolResult":{ "description":"Response when toolType = CUSTOM.", "allOf":[ { "$ref":"#/definitions/TestToolResult" }, { "discriminator":"CUSTOM", "required":[ "result" ], "properties":{ "result":{ "$ref":"#/definitions/CustomResult" } } } ] }, "CustomResult":{ "description":"Result from custom tool execution in MCP format.", "type":"object", "properties":{ "content":{ "type":"array", "description":"MCP-formatted content blocks", "items":{ "type":"object", "additionalProperties":{ "type":"object" } } }, "structuredContent":{ "type":"object", "description":"Structured result data", "additionalProperties":{ "type":"object" } }, "isError":{ "type":"boolean", "description":"Whether the result represents an error" }, "toolName":{ "type":"string", "description":"Name of the executed tool" } } }, "RagResult":{ "description":"Structured RAG result containing generated answer and retrieved document chunks.", "type":"object", "required":[ "answer", "retrievedChunks" ], "properties":{ "answer":{ "type":"string", "description":"The synthesized response generated using retrieved documents." }, "retrievedChunks":{ "type":"array", "description":"List of document chunks retrieved during RAG processing.", "items":{ "$ref":"#/definitions/RetrievedChunk" } } } }, "RetrievedChunk":{ "type":"object", "description":"A single retrieved document chunk with metadata.", "properties":{ "documentId":{ "type":"string", "description":"Unique identifier or URI for the document chunk." }, "content":{ "type":"string", "description":"Text content of the retrieved chunk." }, "score":{ "type":"number", "format":"float", "description":"Relevance score assigned to the chunk during retrieval." } } }, "FetchMcpObjectsResult":{ "description":"Response for a list tools call", "type":"object", "properties":{ "objects":{ "description":"The list of objects to be returned.", "type":"array", "items":{ "$ref":"#/definitions/McpObject" } }, "nextPage":{ "description":"For list pagination. When this header appears in the response, additional pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" }, "previousPage":{ "description":"For list pagination. When this header appears in the response, previous pages of results remain. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"string" }, "totalItems":{ "description":"For list pagination. This header provides total number of items available. For\nimportant details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n", "type":"integer" } } }, "McpObject":{ "description":"Mcp object.", "type":"object", "discriminator":"objectType", "properties":{ "objectType":{ "description":"Type of object. Tool, prompt or resource hosted on an MCP.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/McpObjectType", "enum":[ "TOOL", "PROMPT", "RESOURCE" ] }, "name":{ "type":"string", "description":"name of the mcp object" }, "description":{ "type":"string", "description":"description of the mcp object" } } }, "McpToolObject":{ "description":"Tool exposed by an MCP server.", "allOf":[ { "$ref":"#/definitions/McpObject" }, { "discriminator":"TOOL", "properties":{ "inputSchema":{ "type":"object", "description":"representation of the input schema for a tool.", "additionalProperties":{ "type":"object" } } } } ] }, "McpPromptObject":{ "description":"Prompt exposed by an MCP server.", "allOf":[ { "$ref":"#/definitions/McpObject" }, { "discriminator":"PROMPT", "properties":{ "prompt":{ "type":"string", "description":"prompt persisted within an MCP server." } } } ] }, "McpResourceObject":{ "description":"Resource exposed by an MCP server.", "allOf":[ { "$ref":"#/definitions/McpObject" }, { "discriminator":"RESOURCE", "properties":{ "resourceSchema":{ "type":"string", "description":"serialized schema of resource persisted within an MCP server." } } } ] }, "GitBranchCollection":{ "type":"object", "description":"Collection of Git branches. Contains summary information about a Git branch.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Git branches.", "type":"array", "items":{ "$ref":"#/definitions/GitBranchSummary" } } } }, "GitBranchSummary":{ "type":"object", "description":"Git branch object summary.", "required":[ "branchName", "branchPath" ], "properties":{ "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "branchPath":{ "description":"Fully qualified branch path.", "type":"string" } } }, "GitBranch":{ "type":"object", "description":"Git branch details.", "required":[ "branchName", "gitUrl" ], "properties":{ "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "gitUrl":{ "description":"The Git repository URL corresponding to the branch.", "type":"string" }, "errorMessage":{ "description":"Git error message.", "type":"string" }, "stdOut":{ "description":"Git STDOUT message.", "type":"string" }, "stdErr":{ "description":"Git STDERR message.", "type":"string" }, "gitExitCode":{ "description":"Git exit status.", "type":"integer" } } }, "CreateGitBranch":{ "type":"object", "description":"Git branch details.", "required":[ "gitBranchName", "gitUrl" ], "properties":{ "gitBranchName":{ "description":"The name of the Git branch.", "type":"string" }, "gitUrl":{ "description":"The Git repository URL corresponding to the branch.", "type":"string" }, "errorMessage":{ "description":"Git error message.", "type":"string" }, "stdOut":{ "description":"Git STDOUT message.", "type":"string" }, "stdErr":{ "description":"Git STDERR message.", "type":"string" }, "gitExitCode":{ "description":"Git exit status.", "type":"integer" }, "gitFolderPath":{ "description":"The path of the current Git folder which has to be created for the new branch.", "type":"string" } } }, "GitFolderMetadatum":{ "type":"object", "description":"Details about a Git repository.", "required":[ "repoKey", "isAssociated" ], "properties":{ "repoKey":{ "description":"Unique repo key if folder/file path is associated with a Git folder.", "type":"string" }, "isAssociated":{ "description":"If the passed folder/file path is associated with a Git folder. (Active/Inactive)", "type":"boolean" } } }, "GitRepository":{ "type":"object", "description":"Details about a Git repository.", "required":[ "key", "workspaceKey", "branchName", "gitUrl", "gitFolderPath" ], "properties":{ "key":{ "description":"Unique key associated with repository.", "type":"string" }, "workspaceKey":{ "description":"The workspaceKey associated with the Git repository.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "gitUrl":{ "description":"The Git repository url corresponding to the branch.", "type":"string" }, "gitFolderPath":{ "description":"The path of the current Git folder which has to be created for the new branch.", "type":"string" }, "credentialKey":{ "description":"The credential setting key", "type":"string" } } }, "CreateGitBranchDetails":{ "type":"object", "description":"Information required to create a new Git branch.", "required":[ "gitBranchName" ], "properties":{ "gitBranchName":{ "description":"The name of the Git branch.", "type":"string" }, "gitFolderPath":{ "description":"The path of the current Git folder which has to be created for the new branch.", "type":"string" } } }, "CheckoutBranchDetails":{ "type":"object", "description":"Information required to checkout a new Git branch.", "required":[ "branchName", "gitFolderPath" ], "properties":{ "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "gitFolderPath":{ "description":"The path of the Git folder in the context.", "type":"string" } } }, "CommitPushDetails":{ "type":"object", "description":"Commit staged/local changes and push to remote for the given branch context.", "required":[ "commitMessage" ], "properties":{ "gitFolderPath":{ "description":"Folder path used to locate the Git worktree.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "files":{ "description":"List of file paths (repo-relative) to stage before commit. If omitted, server may commit already-staged changes only.", "type":"array", "items":{ "type":"string" } }, "commitMessage":{ "description":"Commit message.", "type":"string" }, "commitDescription":{ "description":"Commit description.", "type":"string" } } }, "ConflictResolveDetails":{ "type":"object", "description":"List of files to checkout side or mark as resolved.", "required":[ "files", "action" ], "properties":{ "files":{ "description":"List of file paths to checkout side or mark as resolved.", "type":"array", "items":{ "type":"string" } }, "action":{ "type":"string", "description":"Action for resolving conflict.", "enum":[ "LOCAL", "REMOTE", "MARK_RESOLVED" ] } } }, "ResetGitFolderStateDetails":{ "type":"object", "description":"Action to either abort an in-progress merge/rebase or discard all local changes.", "required":[ "action" ], "properties":{ "action":{ "type":"string", "description":"The action to perform.", "enum":[ "ABORT_MERGE", "ABORT_REBASE", "ABORT_PULL", "DISCARD" ] }, "discardPaths":{ "description":"List of file paths whose changes are to be discarded and reset to original.", "type":"array", "items":{ "type":"string" } }, "canIncludeIgnored":{ "type":"boolean", "description":"If true with DISCARD, also remove ignored files (-x).", "default":false } } }, "GitPullDetails":{ "type":"object", "description":"Pull remote changes for the given branch context (supports continue/abort during merge).", "properties":{ "gitFolderPath":{ "description":"Folder path used to locate the Git worktree.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "remoteBranchName":{ "description":"Remote branch to pull from. Defaults to branchName if not provided.", "type":"string" }, "pullAction":{ "type":"string", "description":"Pull behavior requested by the caller.", "enum":[ "PULL", "MERGE_CONTINUE", "MERGE_ABORT" ] }, "commitMessage":{ "description":"Commit message used only when pullAction is MERGE_CONTINUE.", "type":"string" } } }, "GitMergeDetails":{ "type":"object", "description":"Details needed to merge into the current branch for a folder context.", "required":[ "remoteBranchName" ], "properties":{ "gitFolderPath":{ "description":"Folder path used to locate the Git worktree.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "remoteBranchName":{ "description":"Remote branch name, if you want to merge a different branch.", "type":"string" }, "commitId":{ "description":"Commit ID to merge (optional).", "type":"string" } } }, "GitRebaseDetails":{ "type":"object", "description":"Details needed to perform a Git rebase for a folder context.", "required":[ "remoteBranchName" ], "properties":{ "gitFolderPath":{ "description":"Folder path used to locate the Git worktree.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "remoteBranchName":{ "description":"Remote branch name to rebase onto (optional).", "type":"string" }, "commitId":{ "description":"Commit ID to rebase onto (optional).", "type":"string" } } }, "GitResetDetails":{ "type":"object", "description":"Details needed to reset the current branch for a folder context.", "properties":{ "gitFolderPath":{ "description":"Folder path used to locate the Git worktree.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "commitId":{ "description":"Commit ID/ref to reset to. If omitted, server may default to HEAD~1 for soft reset flows.", "type":"string" }, "resetMode":{ "description":"Reset mode requested.", "type":"string", "enum":[ "SOFT", "MIXED", "HARD" ] } } }, "GitRestoreBranchDetails":{ "type":"object", "description":"Details needed to restore/discard local changes for a folder context.", "required":[ "restoreFilesList" ], "properties":{ "gitFolderPath":{ "description":"Folder path used to locate the Git worktree.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" }, "restoreFilesList":{ "description":"List of files whose local/staged changes you want to discard (repo-relative paths).", "type":"array", "items":{ "type":"string" } } } }, "GitRepairWorkTreeDetails":{ "type":"object", "description":"Details needed to repair Git work tree for a folder context.", "required":[ "gitFolderPath", "branchName" ], "properties":{ "gitFolderPath":{ "description":"Folder path used to locate the Git worktree.", "type":"string" }, "branchName":{ "description":"The name of the Git branch.", "type":"string" } } }, "UpdateGitRepositoryDetails":{ "type":"object", "description":"Update a Git repository with the provided details.", "properties":{ "gitFolderPath":{ "description":"The path of the current Git folder which has to be created for the new branch.", "type":"string" }, "gitUrl":{ "description":"The Git repository url corresponding to the branch.", "type":"string" }, "credentialKey":{ "description":"Updated PAT credential key.", "type":"string" } } }, "HistoryCollection":{ "type":"object", "description":"Collection of commits for a branch (optionally filtered by folder).", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of commit summaries.", "items":{ "$ref":"#/definitions/HistorySummary" } }, "gitUrl":{ "description":"The Git repository URL corresponding to the branch.", "type":"string" } } }, "HistorySummary":{ "type":"object", "description":"Summary information for a commit.", "required":[ "commitId", "authorName", "timeCreated", "message" ], "properties":{ "commitId":{ "type":"string", "description":"Commit SHA." }, "message":{ "type":"string", "description":"First line of commit message (subject)." }, "authorName":{ "type":"string", "description":"Commit author display name." }, "authorEmail":{ "type":"string", "description":"Commit author email (optional)." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Commit authored time (or committed time if you prefer, but be consistent)." }, "isMergeCommit":{ "type":"boolean", "description":"True if commit has multiple parents." }, "parents":{ "type":"array", "description":"Parent commit SHAs (empty for root commit). Present to explain merge commits.", "items":{ "type":"string" } } } }, "GitOperationState":{ "type":"object", "description":"Current git operation state for a repository folder context.", "required":[ "gitFolderPath", "state", "isBlocking", "isAllowed" ], "properties":{ "gitFolderPath":{ "type":"string", "description":"Folder path used to locate the Git worktree." }, "state":{ "type":"string", "description":"Current Git operation state detected.", "enum":[ "CLEAN", "MERGE_IN_PROGRESS", "REBASE_IN_PROGRESS", "PULL_IN_PROGRESS", "DETACHED_HEAD", "UNKNOWN" ] }, "isBlocking":{ "type":"boolean", "description":"Whether the detected state blocks typical write operations." }, "isAllowed":{ "type":"boolean", "description":"Whether the requested operation is allowed in the current state. If operationName is not provided, this indicates if the repository is in a generally safe state." }, "message":{ "type":"string", "description":"Human-readable hint for UI display." }, "currentBranch":{ "type":"string", "description":"Current branch name. Empty if detached HEAD." }, "headCommitId":{ "type":"string", "description":"Full commit ID of HEAD." }, "isDetached":{ "type":"boolean", "description":"Whether HEAD is detached." }, "haveConflicts":{ "type":"boolean", "description":"Indicates if unmerged/conflicted files exist. This does not include file names." }, "timeChecked":{ "type":"string", "format":"date-time", "description":"Time when the state was computed." } } }, "GitDiffSummaryCollection":{ "type":"object", "description":"Collection of Git diff summaries for files under a folder context.", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Git diff summaries.", "items":{ "$ref":"#/definitions/GitDiffSummary" } } } }, "GitDiffSummary":{ "type":"object", "description":"Summary information about a file that differs in a Git folder context.", "required":[ "gitFilePath", "changeType", "isConflict" ], "properties":{ "gitFilePath":{ "type":"string", "description":"File path relative to repository root." }, "changeType":{ "type":"string", "description":"Type of change for this file.", "enum":[ "ADDED", "MODIFIED", "DELETED", "RENAMED", "COPIED", "TYPE_CHANGED", "UNMERGED" ] }, "oldGitFilePath":{ "type":"string", "description":"Previous path if the file was renamed." }, "isConflict":{ "type":"boolean", "description":"Whether the file is currently in an unmerged/conflicted state." }, "conflictType":{ "type":"string", "description":"Conflict classification when isConflict is true.", "enum":[ "BOTH_MODIFIED", "BOTH_ADDED", "BOTH_DELETED", "ADDED_BY_US", "ADDED_BY_THEM", "DELETED_BY_US", "DELETED_BY_THEM", "UNKNOWN" ] } } }, "GitDiffDetail":{ "type":"object", "description":"Unified diff details for a Git file.", "required":[ "gitFilePath" ], "properties":{ "gitFilePath":{ "type":"string", "description":"File path relative to repository root." }, "isConflict":{ "type":"boolean", "description":"Indicates whether the file is currently in a conflicted state." }, "isBinary":{ "type":"boolean", "description":"Indicates whether the file is binary." }, "patch":{ "type":"string", "description":"Unified diff patch text." }, "isTruncated":{ "type":"boolean", "description":"Indicates whether the diff output was truncated." }, "truncatedReason":{ "type":"string", "description":"Indicates the reason for the truncated diff to be returned.", "enum":[ "MAX_PATCH_BYTES", "BINARY", "TOO_LARGE", "UNKNOWN" ] } } }, "CredentialType":{ "type":"string", "description":"The type of credential supported by the credential store.", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] }, "CredentialV2LifeCycleState":{ "description":"The current lifecycle state of the credential object.", "type":"string", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING" ] }, "CredentialDetails":{ "description":"The base object containing credential information, extended by specific credential types \nsuch as SecretTokenCredentialDetails or VaultReferenceCredentialDetails. The type of credential\nis identified by the `credentialType` property.\n", "discriminator":"credentialType", "x-obmcs-discriminator-mapping":{ "SECRET_TOKEN":"#/definitions/SecretTokenCredentialDetails", "SERVICE_ACCOUNT":"#/definitions/ServiceAccountCredentialDetails", "VAULT_REFERENCE":"#/definitions/VaultReferenceCredentialDetails" }, "required":[ "credentialType" ], "properties":{ "credentialType":{ "type":"string", "description":"Specifies the type of credential. Allowed values are defined in CredentialType.", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] } } }, "CredentialV2NameAndSecretKey":{ "description":"Represents the name of a credential and an optional secret key name used when\nretrieving details via GetDataLakeCredentialByName.\n", "type":"object", "required":[ "displayName" ], "properties":{ "displayName":{ "type":"string", "description":"The display name of the credential. Must start with a letter and contain only letters, numbers, or underscores.", "minLength":1, "maxLength":255, "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$" }, "secretKey":{ "type":"string", "description":"The secret key name to filter SecretToken credentials.", "minLength":1, "maxLength":255 } } }, "SecretPair":{ "description":"Represents a key-value pair for a secret, consisting of a secret key and its corresponding value.", "type":"object", "required":[ "secretKey", "secretValue" ], "properties":{ "secretKey":{ "type":"string", "description":"The secret key. The minimum length is 1 character and the maximum is 255 characters.", "minLength":1, "maxLength":255 }, "secretValue":{ "type":"string", "description":"The secret value. The minimum length is 1 character and the maximum is 1 MB.", "minLength":1, "maxLength":1048576, "format":"password" } } }, "SecretTokenCredentialDetails":{ "description":"Credential details for storing secret tokens or API keys. This extends the base CredentialDetails\nobject, with the credential type set as SECRET_TOKEN.\n", "allOf":[ { "$ref":"#/definitions/CredentialDetails" }, { "discriminator":"SECRET_TOKEN", "required":[ "secretTokenPair" ], "properties":{ "secretTokenPair":{ "type":"array", "description":"A list of secret key-value pairs used as secret tokens or API keys.", "items":{ "$ref":"#/definitions/SecretPair" }, "maxItems":100 } } } ] }, "ServiceAccountCredentialDetails":{ "description":"Credential details for representing service account object. This extends\nthe base CredentialDetails object, with the credential type set as SERVICE_ACCOUNT.\n", "allOf":[ { "$ref":"#/definitions/CredentialDetails" }, { "discriminator":"SERVICE_ACCOUNT", "required":[ "userId", "fingerprint", "tenancy", "region", "isReadOnly", "privateKey" ], "properties":{ "userId":{ "type":"string", "description":"The OCID of the user for the service account.", "minLength":1, "maxLength":255 }, "fingerprint":{ "type":"string", "description":"The fingerprint of the service account's API key.", "minLength":1, "maxLength":255, "format":"password" }, "tenancy":{ "type":"string", "description":"The OCID of the tenancy for the service account.", "minLength":1, "maxLength":255 }, "region":{ "type":"string", "description":"The region for the service account (e.g., us-ashburn-1).", "minLength":1, "maxLength":30 }, "isReadOnly":{ "type":"boolean", "description":"Whether the credentials are read-only." }, "privateKey":{ "type":"string", "description":"The private key associated with the service account.", "format":"password", "minLength":1 } } } ] }, "VaultReferenceCredentialDetails":{ "description":"Credential details for referencing existing secrets managed outside AI Data Platform. This extends\nthe base CredentialDetails object, with the credential type set as VAULT_REFERENCE.\n", "allOf":[ { "$ref":"#/definitions/CredentialDetails" }, { "discriminator":"VAULT_REFERENCE", "required":[ "secretId" ], "properties":{ "secretId":{ "type":"string", "description":"The OCID of the external secret to reference.", "minLength":1, "maxLength":255, "format":"password" } } } ] }, "CredentialV2":{ "description":"Represents a credential object, which holds and manages credential resources.", "type":"object", "required":[ "key", "displayName" ], "properties":{ "key":{ "description":"The unique identifier for the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.", "type":"string", "minLength":1, "maxLength":255, "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$" }, "type":{ "description":"The type of credential stored. Allowed values are defined in CredentialType.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] }, "credentialDetails":{ "$ref":"#/definitions/CredentialDetails" }, "credentialDescription":{ "description":"A brief summary of the credential object and its purpose.", "type":"string", "minLength":1, "maxLength":255 }, "lifecycleState":{ "description":"The current state of the credential object. Allowed values are defined in CredentialLifeCycleState.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialV2LifeCycleState", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING" ] }, "lifecycleStateDetails":{ "description":"Additional details or reasons regarding the current lifecycle state. Often used to provide actionable information (e.g., for resources in a Failed state).", "type":"string" }, "timeCreated":{ "description":"The date and time when the credential object was created, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time when the credential object was most recently updated, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The unique identifier of the user who created the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The unique identifier of the user who last updated the credential object.", "type":"string", "minLength":1, "maxLength":255 } } }, "CreateDataLakeCredentialDetails":{ "description":"The set of details required to create a new credential object.", "type":"object", "required":[ "displayName", "type", "credentialDetails" ], "properties":{ "displayName":{ "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.", "type":"string", "minLength":1, "maxLength":255, "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$" }, "credentialDescription":{ "description":"A brief summary of the credential object and its purpose.", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"The type of credential stored. Allowed values are defined in CredentialType.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] }, "credentialDetails":{ "$ref":"#/definitions/CredentialDetails" } } }, "UpdateDataLakeCredentialDetails":{ "description":"The set of details required to update an existing credential object.", "type":"object", "properties":{ "displayName":{ "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.", "type":"string", "minLength":1, "maxLength":255, "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$" }, "credentialDescription":{ "description":"A brief summary of the credential object and its purpose.", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"The type of credential stored. Allowed values are defined in CredentialType.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] }, "credentialDetails":{ "$ref":"#/definitions/CredentialDetails" } } }, "CredentialV2Collection":{ "type":"object", "description":"Result of CredentialV2Collection.", "required":[ "items" ], "properties":{ "items":{ "description":"List of CredentialV2 summaries.", "type":"array", "items":{ "$ref":"#/definitions/CredentialV2Summary" } } } }, "CredentialV2Summary":{ "description":"Summary of the CredentialV2 object.", "type":"object", "required":[ "key", "displayName", "credentialType" ], "properties":{ "key":{ "description":"The unique identifier for the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.", "type":"string", "minLength":1, "maxLength":255, "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$" }, "description":{ "description":"A brief summary of the credential object and its purpose.", "type":"string", "minLength":1, "maxLength":255 }, "credentialType":{ "description":"The type of credential stored. Allowed values are defined in CredentialType.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] }, "timeCreated":{ "description":"The date and time when the credential object was created, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The unique identifier of the user who created the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "timeUpdated":{ "description":"The date and time when the credential object was most recently updated, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "updatedBy":{ "description":"The unique identifier of the user who last updated the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "lifeCycleState":{ "description":"The current state of the credential object. Allowed values are defined in CredentialLifeCycleState.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialV2LifeCycleState", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING" ] } } }, "CredentialSummary":{ "description":"Summary view of a credential for public API consumers.", "type":"object", "required":[ "key", "displayName", "credentialType" ], "properties":{ "key":{ "description":"The unique identifier for the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.", "type":"string", "minLength":1, "maxLength":255, "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$" }, "description":{ "description":"A brief summary of the credential object and its purpose.", "type":"string", "minLength":1, "maxLength":255 }, "credentialType":{ "description":"The type of credential stored. Allowed values are defined in CredentialType.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] }, "timeCreated":{ "description":"The date and time when the credential object was created, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The unique identifier of the user who created the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "timeUpdated":{ "description":"The date and time when the credential object was most recently updated, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "updatedBy":{ "description":"The unique identifier of the user who last updated the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "lifeCycleState":{ "description":"The current state of the credential object. Allowed values are defined in CredentialLifecycleState.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialLifecycleState", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING" ] } } }, "CredentialCollection":{ "description":"Result set returned by listing credentials through the public API.", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"List of credential summaries.", "type":"array", "items":{ "$ref":"#/definitions/CredentialSummary" } } } }, "Credential":{ "description":"Represents a credential object for public API consumers.", "type":"object", "required":[ "key", "displayName" ], "properties":{ "key":{ "description":"The unique identifier for the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "displayName":{ "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.", "type":"string", "minLength":1, "maxLength":255, "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$" }, "type":{ "description":"The type of credential stored. Allowed values are defined in CredentialType.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ] }, "credentialDetails":{ "$ref":"#/definitions/CredentialDetails" }, "credentialDescription":{ "description":"A brief summary of the credential object and its purpose.", "type":"string", "minLength":1, "maxLength":255 }, "lifecycleState":{ "description":"The current state of the credential object. Allowed values are defined in CredentialLifecycleState.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialLifecycleState", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING" ] }, "lifecycleStateDetails":{ "description":"Additional details or reasons regarding the current lifecycle state. Often used to provide actionable information (e.g., for resources in a Failed state).", "type":"string" }, "timeCreated":{ "description":"The date and time when the credential object was created, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time when the credential object was most recently updated, in RFC 3339 timestamp format.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The unique identifier of the user who created the credential object.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The unique identifier of the user who last updated the credential object.", "type":"string", "minLength":1, "maxLength":255 } } }, "CredentialLifecycleState":{ "description":"Lifecycle state values exposed via the public credential API.", "type":"string", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING" ] }, "CredentialPrivilege":{ "description":"The privilege for a credential.", "type":"string", "enum":[ "USE", "READ", "MANAGE", "ADMIN" ] }, "AssignCredentialPermissionDetails":{ "description":"The details of the permissions assigned on the credential to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialPrivilege", "enum":[ "USE", "READ", "MANAGE", "ADMIN" ] } } } }, "RevokeCredentialPermissionDetails":{ "description":"The details of the permissions revoked from assignees for a credential.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialPrivilege", "enum":[ "USE", "READ", "MANAGE", "ADMIN" ] } } } }, "ManageCredentialPermissionDetails":{ "description":"Information to update permissions on a credential.", "type":"object", "properties":{ "assignCredentialPermissionDetails":{ "$ref":"#/definitions/AssignCredentialPermissionDetails" }, "revokeCredentialPermissionDetails":{ "$ref":"#/definitions/RevokeCredentialPermissionDetails" } } }, "PermissionSummary":{ "description":"Information about a credential permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a credential.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialPrivilege", "enum":[ "USE", "READ", "MANAGE", "ADMIN" ] } }, "isInherited":{ "type":"boolean", "description":"The permission listed is inherited or not from object up in hierarchy." }, "resourceName":{ "type":"string", "description":"Name of the object to which this permission belongs." } } }, "CredentialsPermissionCollection":{ "type":"object", "description":"List of credential permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of credential permissions.", "type":"array", "maxItems":100, "items":{ "$ref":"#/definitions/PermissionSummary" } } } }, "AgentFlow":{ "description":"An agent flow is a sequence of nodes and edges defining an end-to-end agentic application. | A flow can be composed of multiple nodes, each node being a single agent or a multi-agent system, working independently | or collaboratively to accomplish an overall objective", "type":"object", "required":[ "key", "displayName", "description", "lifecycleState", "pathInfo" ], "properties":{ "key":{ "description":"The unique identifier (UUID) of the Agent flow", "type":"string" }, "displayName":{ "description":"AgentFlow name.", "type":"string" }, "workspaceKey":{ "description":"The key of the workspace to which this Agent flow belongs.", "type":"string" }, "description":{ "description":"AgentFlow description.", "type":"string" }, "pathInfo":{ "description":"Path inside volume where the agentFlow json is written", "type":"string" }, "type":{ "description":"The type of Agent Flow (Canvas or Code)", "type":"string", "enum":[ "CANVAS", "CODE" ] }, "entryFilePath":{ "description":"The path to project entry file", "type":"string" }, "dependenciesFilePath":{ "description":"The path to dependencies file", "type":"string" }, "deploymentComputeKey":{ "description":"The key of the Compute where Agent Flow is deployed", "type":"string" }, "deploymentMode":{ "description":"Agent flow deployment mode.", "type":"string" }, "uri":{ "description":"Agent flow uri.", "type":"string" }, "uriState":{ "description":"Agent flow uri state.", "type":"string" }, "lifecycleState":{ "description":"The current state of the Agent Flow.", "type":"string", "enum":[ "DRAFT", "DEPLOYED" ] }, "lifecycleDetails":{ "description":"A message that describes the current state of the Agent Flow in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n", "type":"string" }, "timeCreated":{ "description":"The date and time the Agent flow was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Agent flow was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the Agent flow.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the schema.", "type":"string", "minLength":1, "maxLength":255 }, "computeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 }, "diagram":{ "$ref":"#/definitions/AgentFlowDiagram" }, "guardrails":{ "$ref":"#/definitions/GuardrailsConfiguration" }, "sessionConfig":{ "$ref":"#/definitions/SessionConfiguration" }, "version":{ "description":"A number indicating the version of the record. Each time the record is updated, this version will be incremented. This will be used for optimistic locking", "type":"integer" } } }, "ValidateAgentFlowResponse":{ "description":"The response object for validating the agent flow json", "required":[ "isValidAgentFlow" ], "properties":{ "isValidAgentFlow":{ "description":"true if valid, else false", "type":"boolean", "default":false }, "validationError":{ "description":"List of validation errors encountered in the diagram.", "type":"array", "items":{ "$ref":"#/definitions/ValidationError" } } } }, "AgentFlowDiagram":{ "description":"Diagrammatic representation of the Agent Flow with all node and edge details", "properties":{ "key":{ "description":"The unique identifier (UUID) of the Agent flow", "type":"string" }, "displayName":{ "description":"AgentFlow name.", "type":"string" }, "description":{ "description":"AgentFlow description.", "type":"string" }, "nodes":{ "description":"Mapping of nodeId to node objects.", "type":"object", "additionalProperties":{ "$ref":"#/definitions/AgentFlowNode" }, "default":{ } }, "edges":{ "description":"Mapping of edgeId to edge objects.", "type":"object", "additionalProperties":{ "$ref":"#/definitions/AgentFlowEdge" }, "default":{ } }, "toolMap":{ "description":"A hash map with key=tool key, value=tool definition. It is used to find the tool definition for a tool reference, where the tool is marked as a reference.", "type":"object", "additionalProperties":{ "$ref":"#/definitions/Tool" } }, "guardrailsMap":{ "description":"A hash map with key=guardrails config name, value=guardrails definition. It is used to find the guardrails definition for a guardrails reference by name.", "type":"object", "additionalProperties":{ "$ref":"#/definitions/GuardrailsConfiguration" } } } }, "SessionRetentionConfiguration":{ "description":"Session data retention configuration for agent flow", "type":"object", "properties":{ "retentionPeriodInDays":{ "description":"No. of days session data will be kept", "type":"integer", "minimum":1 }, "sessionSizeLimit":{ "description":"Max storage allocated to session data (in MB).", "type":"integer", "minimum":1 }, "threadCountLimit":{ "description":"Maximum no. of user prompt and agent response pairs per session", "type":"integer", "minimum":1 } } }, "OAuthConfiguration":{ "description":"OAuth configuration for agent flow", "type":"object", "properties":{ "issuerClaim":{ "description":"Issuer Claim of OAuthConfiguration", "type":"string" }, "audienceClaim":{ "description":"List of Audience Claim of OAuthConfiguration", "type":"array", "items":{ "type":"string", "default":[ ] } }, "jwksUri":{ "description":"JWKS URI of OAuthConfiguration", "type":"string" } } }, "GuardrailsConfiguration":{ "description":"Safety guardrails configuration for an agent flow", "type":"object", "properties":{ "name":{ "description":"Name of the guardrails configuration", "type":"string", "maxLength":255 }, "description":{ "description":"Description of the guardrails configuration", "type":"string", "maxLength":1000 }, "policies":{ "description":"List of safety policies configured in this guardrails", "type":"array", "items":{ "$ref":"#/definitions/SafetyPolicy" } } } }, "SessionConfiguration":{ "description":"Session configuration for an agent flow", "type":"object", "properties":{ "variables":{ "description":"Map of session variable name ??? variable definition", "type":"object", "additionalProperties":{ "$ref":"#/definitions/SessionVariableDetails" }, "default":{ } }, "sessionRetentionConfig":{ "$ref":"#/definitions/SessionRetentionConfiguration" } } }, "MemoryLimitStrategy":{ "description":"Type used for applying memory limits.", "type":"string", "enum":[ "TRUNCATION" ] }, "MemoryLimitConfigurationDetails":{ "description":"Configuration details for memory limits.", "type":"object", "properties":{ "messageLimit":{ "description":"Message-count limit for truncation middleware.", "type":"integer", "minimum":1 }, "tokenLimit":{ "description":"Approximate token-count limit for truncation middleware.", "type":"integer", "minimum":1 } } }, "MemoryLimitConfiguration":{ "description":"Memory limit configuration for an agent node.", "type":"object", "properties":{ "type":{ "description":"Type used for memory limiting. TRUNCATION applies truncation middleware.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/MemoryLimitStrategy", "enum":[ "TRUNCATION" ], "default":"TRUNCATION" }, "config":{ "$ref":"#/definitions/MemoryLimitConfigurationDetails" } } }, "MemoryConfiguration":{ "description":"Memory configuration for an agent node.", "type":"object", "properties":{ "isEnabled":{ "description":"Whether agent memory is enabled. When disabled, no conversation history is injected into the LLM context window.", "type":"boolean", "default":true }, "limit":{ "$ref":"#/definitions/MemoryLimitConfiguration" }, "memoryProperties":{ "description":"Some extra named memory properties.", "type":"object", "maxItems":100, "additionalProperties":{ "type":"object" } } } }, "NodeType":{ "description":"Node type.", "type":"string", "enum":[ "START_NODE", "GUARDRAILS", "AGENT", "SUPERVISOR_AGENT", "NESTED_AGENT_FLOW", "EXTERNAL_AGENT", "HUMAN_IN_THE_LOOP", "SQL_TOOL", "PROMPT_TOOL", "RAG_TOOL", "MCP_TOOL", "HTTP_TOOL", "CUSTOM_TOOL" ] }, "CopyAgentFlowDetails":{ "description":"Details to copy the agent flow to target workspace.", "type":"object", "properties":{ "targetDisplayName":{ "description":"AgentFlow name.", "type":"string" }, "targetDescription":{ "description":"AgentFlow description.", "type":"string" }, "targetPathInfo":{ "description":"Path inside volume where the agentFlow json is written", "type":"string" }, "targetWorkspaceKey":{ "description":"Key of the target workspace where the agent flow will be copied.", "type":"string" } }, "required":[ "targetWorkspaceKey", "targetPathInfo" ] }, "AgentFlowNode":{ "description":"A node in a diagram, representing logic, data, or operation.", "type":"object", "discriminator":"type", "properties":{ "type":{ "description":"Node type discriminator", "type":"string", "x-obmcs-top-level-enum":"#/definitions/NodeType", "enum":[ "START_NODE", "GUARDRAILS", "AGENT", "SUPERVISOR_AGENT", "NESTED_AGENT_FLOW", "EXTERNAL_AGENT", "HUMAN_IN_THE_LOOP", "SQL_TOOL", "PROMPT_TOOL", "RAG_TOOL", "MCP_TOOL", "HTTP_TOOL", "CUSTOM_TOOL" ] }, "nodeType":{ "description":"Type of this node.", "type":"string" }, "name":{ "description":"Name of this node.", "type":"string", "default":"New node" }, "description":{ "description":"Description of this node.", "type":"string", "default":"New node" }, "positionX":{ "description":"Canvas X coordinate.", "type":"number", "format":"float", "default":0 }, "positionY":{ "description":"Canvas Y coordinate.", "type":"number", "format":"float", "default":0 }, "isExpanded":{ "description":"Is node expanded in UI.", "type":"boolean", "default":false }, "parentNodeId":{ "description":"Parent node ID, for subgraphs.", "type":"string" }, "configuration":{ "description":"Configuration object for this node.", "type":"object", "default":{ }, "additionalProperties":{ "type":"object", "default":{ } } }, "nodeTypeId":{ "description":"Definition ID for this node type.", "type":"string" }, "key":{ "description":"Unique identifier for the node.", "type":"string" }, "timeCreated":{ "description":"RFC3339 timestamp when node was created.", "type":"string", "format":"date-time", "default":"2024-12-11T22:41:25.967777Z" }, "timeUpdated":{ "description":"RFC3339 timestamp when node was last updated.", "type":"string", "format":"date-time", "default":"2024-12-11T22:41:25.967783Z" }, "inputs":{ "description":"Array of NodeInput objects.", "type":"array", "items":{ "$ref":"#/definitions/NodeInput" }, "default":[ ] }, "outputs":{ "description":"Array of NodeOutput objects.", "type":"array", "items":{ "$ref":"#/definitions/NodeOutput" }, "default":[ ] }, "validationErrors":{ "description":"List of validation errors encountered in the diagram.", "type":"array", "items":{ "$ref":"#/definitions/ValidationError" } } }, "required":[ "key" ] }, "AgentNode":{ "description":"An Agent Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"AGENT", "properties":{ "instructions":{ "description":"System prompt written by the flow developer defining the agent???s goal(s) and what tools the agent has access to.", "type":"string" }, "llm":{ "$ref":"#/definitions/LlmConfig" }, "modelSettings":{ "description":"Model specific inference parameters such as temperature, top-k, max length, response format, etc.", "type":"object", "additionalProperties":{ "type":"object" } }, "memory":{ "$ref":"#/definitions/MemoryConfiguration" }, "tools":{ "description":"List of tools that are accessible to the agent. Provide the unique tool key", "type":"array", "maxItems":20, "items":{ "$ref":"#/definitions/Tool" } } } } ] }, "SupervisorAgentNode":{ "description":"A Supervisor Agent Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"SUPERVISOR_AGENT", "properties":{ "instructions":{ "description":"System prompt written by the flow developer defining the agent???s goal(s) and what tools the agent has access to.", "type":"string" }, "llm":{ "$ref":"#/definitions/LlmConfig" }, "modelSettings":{ "description":"Model specific inference parameters such as temperature, top-k, max length, response format, etc.", "type":"object", "additionalProperties":{ "type":"object" } }, "memory":{ "$ref":"#/definitions/MemoryConfiguration" }, "tools":{ "description":"List of tools that are accessible to the agent. Provide the unique tool key.", "type":"array", "maxItems":20, "items":{ "$ref":"#/definitions/Tool" } }, "supervisorConfig":{ "description":"Extra configuration for the supervisor node. Captured as a generic dictionary.", "type":"object", "additionalProperties":{ "type":"string" } } } } ] }, "StartNode":{ "description":"A starting point in an agent flow.", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"START_NODE", "properties":{ "startNodeConfig":{ "description":"Extra configuration for the start node.", "type":"object", "additionalProperties":{ "type":"string" } } } } ] }, "GuardrailNode":{ "description":"A node used to run guardrails on input in the agent flow.", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"GUARDRAILS", "properties":{ "guardrailsConfig":{ "description":"The name of a guardrails configuration stored in the guardrails map in the flow diagram.", "type":"string" }, "extraGuardrailsConfig":{ "description":"Extra configuration for the guardrails node.", "type":"object", "additionalProperties":{ "type":"string" } } } } ] }, "HumanInTheLoopNode":{ "description":"A node used to represent a human interaction in the flow.", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"HUMAN_IN_THE_LOOP", "properties":{ "humanInTheLoopConfig":{ "description":"Extra configuration for the human in the loop node.", "type":"object", "additionalProperties":{ "type":"string" } } } } ] }, "NestedAgentFlowNode":{ "description":"An agent node representing a nested Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"NESTED_AGENT_FLOW", "properties":{ "instructions":{ "description":"System prompt written by the flow developer defining the agent???s goal(s) and what tools the agent has access to.", "type":"string" }, "nestedAgentFlowConfig":{ "description":"Extra configuration for the nested agent flow node.", "type":"object", "additionalProperties":{ "type":"string" } } } } ] }, "ExternalAgentNode":{ "description":"An External Agent Node in an Agent Flow.", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"EXTERNAL_AGENT", "properties":{ "instructions":{ "description":"Custom prompt written by the user defining the agent???s goal(s) and what tools the agent has access to", "type":"string" }, "externalAgentConfig":{ "description":"Extra configuration for the external agent node.", "type":"object", "additionalProperties":{ "type":"string" } } } } ] }, "SqlToolNode":{ "description":"A Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"SQL_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "RagToolNode":{ "description":"A Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"RAG_TOOL", "properties":{ "inputSchema":{ "$ref":"#/definitions/RagToolInputSchema" } } } ] }, "PromptToolNode":{ "description":"A Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"PROMPT_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "McpToolNode":{ "description":"A Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"MCP_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "HttpToolNode":{ "description":"A Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"HTTP_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "CustomToolNode":{ "description":"A generic tool node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/AgentFlowNode" }, { "discriminator":"CUSTOM_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "AgentFlowEdge":{ "description":"An edge connecting two nodes in the diagram, with context and metadata.", "type":"object", "properties":{ "srcNodeId":{ "description":"Source node for this edge.", "type":"string" }, "destNodeId":{ "description":"Destination node for this edge.", "type":"string" }, "srcNodeOutput":{ "description":"Output port on the source node.", "type":"string" }, "destNodeInput":{ "description":"Input port on the destination node.", "type":"string" }, "parentNodeId":{ "description":"Parent node, if hierarchical.", "type":"string" }, "edgeHandles":{ "description":"Geometry handle coordinates.", "type":"array", "items":{ "$ref":"#/definitions/Point" }, "default":[ ] }, "edgeProperties":{ "description":"Extensible Properties of the Edge", "type":"object", "additionalProperties":{ "type":"object" } }, "edgeType":{ "description":"Style/type for edge.", "type":"string" }, "key":{ "description":"Unique edge identifier.", "type":"string" }, "timeCreated":{ "description":"RFC3339 timestamp when edge was created.", "type":"string", "format":"date-time", "default":"2024-12-11T22:41:25.622463Z" }, "timeUpdated":{ "description":"RFC3339 timestamp when edge was last updated.", "type":"string", "format":"date-time", "default":"2024-12-11T22:41:25.622470Z" }, "validationErrors":{ "description":"List of validation errors encountered in the diagram.", "type":"array", "items":{ "$ref":"#/definitions/ValidationError" } } }, "required":[ "srcNodeId", "destNodeId", "srcNodeOutput", "destNodeInput", "key" ] }, "AgentFlowDependency":{ "description":"The response object for getting the agent flow dependencies", "type":"object", "required":[ "agentFlowKey" ], "properties":{ "agentFlowKey":{ "description":"AgentFlow Key", "type":"string" }, "type":{ "description":"AgentFlow", "type":"string" }, "dependencies":{ "description":"List of AgentFlow dependencies.", "type":"array", "items":{ "$ref":"#/definitions/AgentFlowDependencyItem" } } } }, "AgentFlowDependencyItem":{ "description":"Items of AgentFlow Dependencies", "type":"object", "properties":{ "type":{ "description":"AICompute/File", "type":"string" }, "key":{ "description":"AICompute key", "type":"string" }, "location":{ "description":"Location of file/folders", "type":"string" } } }, "LlmConfig":{ "description":"Large Language Model configuration", "type":"object", "properties":{ "modelId":{ "description":"The unique identifier of the Large Language Model (LLM) to use in the Agent or Tool", "type":"string" }, "provider":{ "description":"The Large language model provider name", "type":"string" }, "regionId":{ "description":"The Large language model Region ID", "type":"string" } } }, "ValidationError":{ "description":"Validation error for a component in agent flow diagram.", "type":"object", "properties":{ "type":{ "description":"Type of error.", "type":"string" }, "message":{ "description":"Error message.", "type":"string" }, "name":{ "description":"Error name", "type":"string" }, "key":{ "description":"Id of the component that caused the error", "type":"string" } }, "required":[ "type", "message", "name", "key" ] }, "NodeInput":{ "description":"An input slot for a node, including type and requirements.", "type":"object", "properties":{ "name":{ "description":"Unique name for the input slot.", "type":"string" }, "type":{ "$ref":"#/definitions/NodeIo" }, "description":{ "description":"Documentation or tooltip shown in the UI.", "type":"string" }, "isRequired":{ "description":"True if this input is mandatory.", "type":"boolean" }, "isSingleConnection":{ "description":"True if only one connection is allowed; false allows multiple.", "type":"boolean", "default":false } }, "required":[ "name", "type", "isRequired" ] }, "NodeOutput":{ "description":"An output slot for a node, including type and requirements.", "type":"object", "properties":{ "name":{ "description":"Unique name for the output slot.", "type":"string" }, "type":{ "$ref":"#/definitions/NodeIo" }, "description":{ "description":"Documentation or tooltip shown in the UI.", "type":"string" }, "isRequired":{ "description":"True if this output is mandatory.", "type":"boolean" } }, "required":[ "name", "type", "isRequired" ] }, "NodeIo":{ "description":"Defines the data type and color for an input or output.", "type":"object", "properties":{ "dataType":{ "description":"Possible types of node inputs and outputs.", "type":"string", "enum":[ "FLOW", "STR", "INT", "BOOL", "FLOAT", "LIST", "DICT", "ANY", "TOOLS", "LLMS", "AGENTS", "PLANNER", "FLOWS" ] }, "color":{ "$ref":"#/definitions/NodeIoColor" } }, "required":[ "dataType", "color" ] }, "NodeIoColor":{ "description":"Text and background color configuration for a node input/output.", "type":"object", "properties":{ "textColor":{ "description":"Whether the text on badges should be dark or light for visibility.", "type":"string", "enum":[ "DARK", "LIGHT" ] }, "backgroundColor":{ "description":"Input/output badge background color.", "type":"string" }, "handleColor":{ "description":"Input/output connector handle color.", "type":"string" } }, "required":[ "textColor", "backgroundColor", "handleColor" ] }, "Point":{ "description":"A 2D point for edge handles on diagram elements.", "type":"object", "properties":{ "x":{ "description":"X coordinate.", "type":"number", "format":"float" }, "y":{ "description":"Y coordinate.", "type":"number", "format":"float" } }, "required":[ "x", "y" ] }, "CreateAgentFlowEdgeDetails":{ "description":"Details required to create a new edge in a diagram.\n\nExcludes computed fields such as id, timeCreated, and timeUpdated.\n- srcNodeId: Source node identifier\n- destNodeId: Destination node identifier\n- srcNodeOutput: Source node's output port name\n- destNodeInput: Destination node's input port name\n", "type":"object", "properties":{ "srcNodeId":{ "description":"Source node for this edge.", "type":"string" }, "destNodeId":{ "description":"Destination node for this edge.", "type":"string" }, "srcNodeOutput":{ "description":"Output port on the source node.", "type":"string" }, "destNodeInput":{ "description":"Input port on the destination node.", "type":"string" }, "parentNodeId":{ "description":"Parent node, if hierarchical.", "type":"string" }, "edgeHandles":{ "description":"Geometry handle coordinates.", "type":"array", "items":{ "$ref":"#/definitions/Point" }, "default":[ ] }, "edgeType":{ "description":"Style/type for edge.", "type":"string" } }, "required":[ "srcNodeId", "destNodeId", "srcNodeOutput", "destNodeInput" ] }, "CreateAgentFlowNodeDetails":{ "description":"Details required to create a new node in a diagram.", "type":"object", "discriminator":"type", "properties":{ "type":{ "description":"Node type discriminator", "type":"string", "x-obmcs-top-level-enum":"#/definitions/NodeType", "enum":[ "START_NODE", "GUARDRAILS", "AGENT", "SUPERVISOR_AGENT", "NESTED_AGENT_FLOW", "EXTERNAL_AGENT", "HUMAN_IN_THE_LOOP", "SQL_TOOL", "PROMPT_TOOL", "RAG_TOOL", "MCP_TOOL", "HTTP_TOOL", "CUSTOM_TOOL" ] }, "nodeType":{ "description":"Type of this node.", "type":"string" }, "name":{ "description":"Name of this node.", "type":"string", "default":"New node" }, "description":{ "description":"Description of this node.", "type":"string", "default":"New node" }, "positionX":{ "description":"Canvas X coordinate.", "type":"number", "format":"float", "default":0 }, "positionY":{ "description":"Canvas Y coordinate.", "type":"number", "format":"float", "default":0 }, "isExpanded":{ "description":"Is node expanded in UI.", "type":"boolean", "default":false }, "parentNodeId":{ "description":"Parent node ID, for subgraphs.", "type":"string" }, "srcNodeId":{ "description":"Source node to which this node is connected", "type":"string" }, "configuration":{ "description":"Configuration object for this node.", "type":"object", "default":{ }, "additionalProperties":{ "type":"object", "default":{ } } }, "nodeTypeId":{ "description":"Definition ID for this node type.", "type":"string" } } }, "CreateAgentNodeDetails":{ "description":"Details to create an Agent Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/CreateAgentFlowNodeDetails" }, { "discriminator":"AGENT", "properties":{ "instructions":{ "description":"Custom prompt written by the user defining the agent???s goal(s) and what tools the agent has access to", "type":"string" }, "llm":{ "$ref":"#/definitions/LlmConfig" }, "modelSettings":{ "description":"Model specific inference parameters such as temperature, top-k, max length, response format, etc.", "type":"object", "additionalProperties":{ "type":"object" } }, "memory":{ "$ref":"#/definitions/MemoryConfiguration" }, "tools":{ "description":"List of tools that are accessible to the agent. Provide the unique tool key.", "type":"array", "maxItems":20, "items":{ "$ref":"#/definitions/Tool" } } } } ] }, "CreateSqlToolNodeDetails":{ "description":"Details to create a SQL Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/CreateAgentFlowNodeDetails" }, { "discriminator":"SQL_TOOL", "properties":{ "toolKey":{ "description":"The unique identifier (key) of the saved AI tool", "type":"string" }, "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/SqlToolConfiguration" } } } ] }, "CreateRagToolNodeDetails":{ "description":"Details to create a RAG Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/CreateAgentFlowNodeDetails" }, { "discriminator":"RAG_TOOL", "properties":{ "toolKey":{ "description":"The unique identifier (key) of the saved AI tool", "type":"string" }, "inputSchema":{ "$ref":"#/definitions/RagToolInputSchema" }, "toolConfig":{ "$ref":"#/definitions/RagToolConfiguration" } } } ] }, "CreatePromptToolNodeDetails":{ "description":"Details to create a Prompt Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/CreateAgentFlowNodeDetails" }, { "discriminator":"PROMPT_TOOL", "properties":{ "toolKey":{ "description":"The unique identifier (key) of the saved AI tool", "type":"string" }, "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/PromptToolConfiguration" } } } ] }, "CreateMcpToolNodeDetails":{ "description":"Details to create a MCP Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/CreateAgentFlowNodeDetails" }, { "discriminator":"MCP_TOOL", "properties":{ "toolKey":{ "description":"The unique identifier (key) of the saved AI tool", "type":"string" }, "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/McpToolConfiguration" } } } ] }, "CreateHttpToolNodeDetails":{ "description":"Details to create a HTTP Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/CreateAgentFlowNodeDetails" }, { "discriminator":"HTTP_TOOL", "properties":{ "toolKey":{ "description":"The unique identifier (key) of the saved AI tool", "type":"string" }, "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/HttpToolConfiguration" } } } ] }, "CreateCustomToolNodeDetails":{ "description":"Details to create a Custom Tool Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/CreateAgentFlowNodeDetails" }, { "discriminator":"CUSTOM_TOOL", "properties":{ "toolKey":{ "description":"The unique identifier (key) of the saved AI tool", "type":"string" }, "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/CustomToolConfiguration" } } } ] }, "UpdateAgentFlowNodeDetails":{ "description":"Fields that can be updated in an existing node.", "type":"object", "discriminator":"type", "properties":{ "type":{ "description":"Node type discriminator", "type":"string", "x-obmcs-top-level-enum":"#/definitions/NodeType", "enum":[ "START_NODE", "GUARDRAILS", "AGENT", "SUPERVISOR_AGENT", "NESTED_AGENT_FLOW", "EXTERNAL_AGENT", "HUMAN_IN_THE_LOOP", "SQL_TOOL", "PROMPT_TOOL", "RAG_TOOL", "MCP_TOOL", "HTTP_TOOL", "CUSTOM_TOOL" ] }, "nodeType":{ "description":"Type of this node.", "type":"string" }, "name":{ "description":"Name of this node.", "type":"string", "default":"New node" }, "description":{ "description":"Description of this node.", "type":"string", "default":"New node" }, "positionX":{ "description":"Canvas X coordinate.", "type":"number", "format":"float", "default":0 }, "positionY":{ "description":"Canvas Y coordinate.", "type":"number", "format":"float", "default":0 }, "isExpanded":{ "description":"Is node expanded in UI.", "type":"boolean", "default":false }, "parentNodeId":{ "description":"Parent node ID, for subgraphs.", "type":"string" }, "configuration":{ "description":"Configuration object for this node.", "type":"object", "default":{ }, "additionalProperties":{ "type":"object", "default":{ } } }, "nodeTypeId":{ "description":"Definition ID for this node type.", "type":"string" } } }, "UpdateAgentNodeDetails":{ "description":"Details to update an Agent Node in an Agent Flow", "allOf":[ { "$ref":"#/definitions/UpdateAgentFlowNodeDetails" }, { "discriminator":"AGENT", "properties":{ "instructions":{ "description":"Custom prompt written by the user defining the agent???s goal(s) and what tools the agent has access to", "type":"string" }, "llm":{ "$ref":"#/definitions/LlmConfig" }, "modelSettings":{ "description":"Model specific inference parameters such as temperature, top-k, max length, response format, etc.", "type":"object", "additionalProperties":{ "type":"object" } }, "memory":{ "$ref":"#/definitions/MemoryConfiguration" }, "tools":{ "description":"List of tools that are accessible to the agent. Provide the unique tool key.", "type":"array", "maxItems":20, "items":{ "$ref":"#/definitions/Tool" } } } } ] }, "UpdateSqlToolNodeDetails":{ "description":"Details to update a SQL Tool node", "allOf":[ { "$ref":"#/definitions/UpdateAgentFlowNodeDetails" }, { "discriminator":"SQL_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "UpdateRagToolNodeDetails":{ "description":"Details to update a RAG Tool", "allOf":[ { "$ref":"#/definitions/UpdateAgentFlowNodeDetails" }, { "discriminator":"RAG_TOOL", "properties":{ "inputSchema":{ "$ref":"#/definitions/RagToolInputSchema" } } } ] }, "UpdatePromptToolNodeDetails":{ "description":"Details to update a Prompt Tool", "allOf":[ { "$ref":"#/definitions/UpdateAgentFlowNodeDetails" }, { "discriminator":"PROMPT_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "UpdateMcpToolNodeDetails":{ "description":"Details to update a MCP Tool node", "allOf":[ { "$ref":"#/definitions/UpdateAgentFlowNodeDetails" }, { "discriminator":"MCP_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "UpdateHttpToolNodeDetails":{ "description":"Details to update a HTTP Tool node", "allOf":[ { "$ref":"#/definitions/UpdateAgentFlowNodeDetails" }, { "discriminator":"HTTP_TOOL", "properties":{ "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } } } } ] }, "UpdateCustomToolNodeDetails":{ "description":"Details to update a Custom Tool", "allOf":[ { "$ref":"#/definitions/UpdateAgentFlowNodeDetails" }, { "discriminator":"CUSTOM_TOOL", "properties":{ "toolKey":{ "description":"The unique identifier (key) of the saved AI tool", "type":"string" }, "inputSchema":{ "description":"The list of properties in the inputSchema, along with the default value and description of each property", "type":"object", "additionalProperties":{ "type":"object" } }, "toolConfig":{ "$ref":"#/definitions/CustomToolConfiguration" } } } ] }, "AgentFlowSummary":{ "description":"Summary information of Agent flow in the schema.", "type":"object", "required":[ "key", "displayName" ], "properties":{ "key":{ "description":"The unique identifier (UUID) of the Agent flow", "type":"string" }, "displayName":{ "description":"AgentFlow name.", "type":"string" }, "description":{ "description":"AgentFlow description.", "type":"string" }, "workspaceKey":{ "description":"The key of the workspace to which this Agent flow belongs.", "type":"string" }, "pathInfo":{ "description":"Path inside volume where the agentFlow json is written", "type":"string" }, "type":{ "description":"The type of Agent Flow (Canvas or Code)", "type":"string", "enum":[ "CANVAS", "CODE" ] }, "deploymentComputeKey":{ "description":"The key of the Compute where Agent Flow is deployed", "type":"string" }, "deploymentMode":{ "description":"Agent flow deployment mode.", "type":"string" }, "uri":{ "description":"Agent flow uri.", "type":"string" }, "uriState":{ "description":"Agent flow uri state.", "type":"string" }, "entryFilePath":{ "description":"The path to project entry file", "type":"string" }, "dependenciesFilePath":{ "description":"The path to dependencies file", "type":"string" }, "lifecycleState":{ "type":"string", "description":"The current state of the Agent Flow.", "x-obmcs-enumref":"#/definitions/AgentFlow/lifecycleState" }, "lifecycleDetails":{ "description":"A message that describes the current state of the Agent Flow in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n", "type":"string" }, "computeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 }, "timeCreated":{ "description":"The date and time the Agent flow was created.", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"The date and time the Agent flow was updated.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the Agent flow.", "type":"string", "minLength":1, "maxLength":255 }, "updatedBy":{ "description":"The ID of the user who last updated the schema.", "type":"string", "minLength":1, "maxLength":255 } } }, "AgentFlowCollection":{ "type":"object", "description":"Result of listing Agent flows in a schema.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Agent flows.", "type":"array", "items":{ "$ref":"#/definitions/AgentFlowSummary" } } } }, "CreateAgentFlowDetails":{ "description":"The data to create a Agent flow.", "type":"object", "required":[ "displayName", "pathInfo" ], "properties":{ "displayName":{ "description":"AgentFlow name.", "type":"string" }, "description":{ "description":"AgentFlow description.", "type":"string" }, "pathInfo":{ "description":"Path inside volume where the agentFlow json is written", "type":"string" }, "type":{ "description":"The type of Agent Flow (Canvas or Code)", "type":"string", "enum":[ "CANVAS", "CODE" ] }, "entryFilePath":{ "description":"The path to project entry file", "type":"string" }, "dependenciesFilePath":{ "description":"The path to dependencies file", "type":"string" }, "computeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 }, "guardrails":{ "$ref":"#/definitions/GuardrailsConfiguration" }, "sessionConfig":{ "$ref":"#/definitions/SessionConfiguration" }, "diagram":{ "$ref":"#/definitions/AgentFlowDiagram" } } }, "UpdateAgentFlowDetails":{ "description":"The data to update a Agent flow.", "type":"object", "properties":{ "displayName":{ "description":"AgentFlow name.", "type":"string" }, "description":{ "description":"AgentFlow description.", "type":"string" }, "computeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 }, "diagram":{ "$ref":"#/definitions/AgentFlowDiagram" }, "entryFilePath":{ "description":"The path to project entry file", "type":"string" }, "dependenciesFilePath":{ "description":"The path to dependencies file", "type":"string" }, "deletedNodes":{ "description":"List of node keys that were removed from the flow.", "type":"array", "items":{ "type":"string", "default":[ ] } }, "updatedNodes":{ "description":"List of node keys that were updated in the flow.", "type":"array", "items":{ "type":"string", "default":[ ] } }, "addedNodes":{ "description":"List of node keys that were newly added to the flow.", "type":"array", "items":{ "type":"string", "default":[ ] } }, "guardrails":{ "$ref":"#/definitions/GuardrailsConfiguration" }, "sessionConfig":{ "$ref":"#/definitions/SessionConfiguration" } } }, "AgentFlowPrivilegeForManage":{ "description":"The privilege for a Agent flow.", "type":"string", "enum":[ "READ", "MANAGE", "ADMIN", "USE" ] }, "AgentFlowPrivilege":{ "description":"The privilege for a Agent flow. Can be inherited privilege coming from object higher up in hierarchy.", "type":"string", "enum":[ "READ", "MANAGE", "ADMIN", "USE" ] }, "AgentFlowPermissionCollection":{ "type":"object", "description":"List of Agent flow permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Agent flow permissions.", "type":"array", "items":{ "$ref":"#/definitions/AgentFlowPermissionSummary" } } } }, "AgentFlowPermissionSummary":{ "description":"Information about a Agent flow permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The OCID of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a Agent flow.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/AgentFlowPrivilege", "enum":[ "READ", "MANAGE", "ADMIN", "USE" ] } }, "columns":{ "description":"The list of the columns included for permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of the columns excluded from permission assignment.", "type":"array", "maxItems":100, "items":{ "type":"string" } }, "isInherited":{ "type":"boolean", "description":"If the permission listed is inherited or not from object higher up in hierarchy." }, "resourceName":{ "type":"string", "description":"Name of the object to which this permission belong to. Name of Agent flow if permission is not inherited or name of object higher up in hierarchy if permission is inherited." } } }, "AssignAgentFlowPermissionDetails":{ "description":"The details of the permissions assigned on the Agent flow to assignee.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/AgentFlowPrivilegeForManage", "enum":[ "READ", "MANAGE", "ADMIN", "USE" ] } }, "includeColumns":{ "description":"The list of columns to be included for the assigning of permissions", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the assigning of permissions", "type":"array", "items":{ "type":"string" } } } }, "RevokeAgentFlowPermissionDetails":{ "description":"The details of the permissions revoked from assignee for a Agent flow.", "type":"object", "required":[ "assignees", "permissions", "includeColumns", "excludeColumns" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "description":"The permissions revoked from the assignee.", "type":"array", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/AgentFlowPrivilegeForManage", "enum":[ "READ", "MANAGE", "ADMIN", "USE" ] } }, "includeColumns":{ "description":"The list of columns to be included for the revoking of permissions.", "type":"array", "items":{ "type":"string" } }, "excludeColumns":{ "description":"The list of columns to be excluded for the revoking of permissions.", "type":"array", "items":{ "type":"string" } } } }, "ManageAgentFlowPermissionDetails":{ "description":"Information to update permissions on a Agent flow.", "type":"object", "properties":{ "assignAgentFlowPermissionDetails":{ "$ref":"#/definitions/AssignAgentFlowPermissionDetails" }, "revokeAgentFlowPermissionDetails":{ "$ref":"#/definitions/RevokeAgentFlowPermissionDetails" } } }, "AttachComputeDetails":{ "description":"Details required to attach an agent flow to a compute", "type":"object", "required":[ "agentFlowComputeKey" ], "properties":{ "agentFlowComputeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 } } }, "AgentFlowAttachment":{ "description":"Attachment info of an Agent Flow.", "type":"object", "required":[ "agentFlowKey", "agentFlowComputeKey" ], "properties":{ "agentFlowComputeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 }, "agentFlowKey":{ "description":"The unique identifier (UUID) of the Agent flow", "type":"string" } } }, "DetachComputeDetails":{ "description":"Details required to detach an agent flow to a compute", "type":"object", "required":[ "agentFlowComputeKey" ], "properties":{ "agentFlowComputeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 } } }, "AgentFlowDetachment":{ "description":"Detachment info of an Agent Flow.", "type":"object", "required":[ "agentFlowKey", "agentFlowComputeKey" ], "properties":{ "agentFlowComputeKey":{ "description":"The key of the Agent Flow Compute associated with this Agent Flow", "type":"string", "minLength":1, "maxLength":255 }, "agentFlowKey":{ "description":"The unique identifier (UUID) of the Agent flow", "type":"string" } } }, "DeploymentLifecycleState":{ "description":"LifecycleState of an Agent Flow Session or Deployment.", "type":"string", "enum":[ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ] }, "DeploymentType":{ "description":"Type of an Agent Flow Deployment.", "type":"string", "enum":[ "TEST", "PROD", "CODE" ] }, "AgentFlowSession":{ "description":"Agent flow session.", "type":"object", "required":[ "displayName", "key", "agentFlowKey", "endpointUrl", "lifecycleState", "agentFlowComputeKey" ], "properties":{ "displayName":{ "description":"Display name.", "type":"string" }, "key":{ "description":"Agent Flow Session identifier.", "type":"string" }, "agentFlowKey":{ "description":"The Agent Flow key for which the session is started.", "type":"string" }, "endpointUrl":{ "description":"The endpointUrl where the client should connect to communicate with the Agent.", "type":"string" }, "lifecycleState":{ "description":"LifecycleState of an Agent Flow Session or Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentLifecycleState", "enum":[ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ] }, "agentFlowComputeKey":{ "description":"The Agent Flow Compute Key where client can run or test the Agent Flow.", "type":"string" }, "timeCreated":{ "description":"The date and time the Agent flow session was created.", "type":"string", "format":"date-time" }, "updatedBy":{ "description":"OCID of the user who updated this record", "type":"string" }, "createdBy":{ "description":"The OCID of the user/principal who created the Agent flow session.", "type":"string", "minLength":1, "maxLength":255 }, "timeUpdated":{ "description":"The date and time the Agent flow session was updated.", "type":"string", "format":"date-time" }, "timeStarted":{ "description":"The date and time the session was started", "type":"string", "format":"date-time" }, "timeEnded":{ "description":"The date and time the session was ended", "type":"string", "format":"date-time" }, "context":{ "$ref":"#/definitions/AgentFlowSessionContext" } } }, "AgentFlowSessionContext":{ "description":"Agent flow session context.", "type":"object", "properties":{ "retentionConfig":{ "$ref":"#/definitions/SessionRetentionConfiguration" } } }, "PlaygroundCache":{ "description":"Playground cache for an Agent Flow session.", "type":"object", "required":[ "variables" ], "properties":{ "variables":{ "description":"Map of variable name to value for this session's playground cache.", "type":"object", "additionalProperties":{ "$ref":"#/definitions/SessionVariable" }, "default":{ } } } }, "UpdateAgentFlowSessionPlaygroundCacheDetails":{ "description":"Playground cache for an Agent Flow session.", "allOf":[ { "$ref":"#/definitions/PlaygroundCache" } ] }, "SessionVariable":{ "description":"Session Variable for each Session Context.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Name of the Session Variable.", "type":"string" }, "value":{ "description":"Value of this Session Variable for this session", "type":"string" } } }, "SessionVariableDetails":{ "description":"Session Variable Details.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Name of the Session Variable.", "type":"string" }, "description":{ "description":"Description of the Session Variable", "type":"string" }, "isRequired":{ "description":"If this Variable is required or not", "type":"boolean", "default":false }, "shouldLog":{ "description":"If we should log this Session Variable or not", "type":"boolean", "default":true }, "isSystem":{ "description":"True if Session Variable is defined by System", "type":"boolean", "default":false }, "value":{ "description":"Default Value of this Session Variable", "type":"string" } } }, "AgentFlowSessionSummary":{ "description":"Agent flow session summary.", "type":"object", "required":[ "displayName", "key", "agentFlowKey", "timeCreated", "createdBy" ], "properties":{ "displayName":{ "description":"Display name.", "type":"string" }, "key":{ "description":"Agent Flow Session identifier.", "type":"string" }, "agentFlowKey":{ "description":"The Agent Flow key for which the session is started.", "type":"string" }, "lifecycleState":{ "description":"LifecycleState of an Agent Flow Session or Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentLifecycleState", "enum":[ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ] }, "agentFlowComputeKey":{ "description":"The Agent Flow Compute Key where client can run or test the Agent Flow.", "type":"string" }, "endpointUrl":{ "description":"The endpointUrl where the client should connect to communicate with the Agent.", "type":"string" }, "timeCreated":{ "description":"The date and time the Agent flow session was created.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the Agent flow session.", "type":"string", "minLength":1, "maxLength":255 }, "timeStarted":{ "description":"The date and time the session was started", "type":"string", "format":"date-time" }, "timeEnded":{ "description":"The date and time the session was ended", "type":"string", "format":"date-time" }, "duration":{ "description":"Agent flow session duration", "type":"number", "format":"float" }, "tokens":{ "description":"Agent flow session token usage", "type":"integer", "format":"int64" } } }, "AgentFlowSessionCollection":{ "type":"object", "description":"Result of listing Agent flows in a schema.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Agent flow sessions.", "type":"array", "items":{ "$ref":"#/definitions/AgentFlowSessionSummary" } } } }, "AgentFlowDeployment":{ "description":"Agentflow deployment details.", "type":"object", "required":[ "displayName", "agentFlowKey", "key", "endpointUrl", "lifecycleState", "deploymentType", "deploymentVersion", "timeCreated", "createdBy" ], "properties":{ "key":{ "description":"Identifier, generally uuid.", "type":"string" }, "displayName":{ "description":"Display name.", "type":"string" }, "agentFlowKey":{ "description":"The Agent Flow key for which the session is started.", "type":"string" }, "agentFlowComputeKey":{ "description":"The Agent Flow Compute Key where client can run or test the Agent Flow.", "type":"string" }, "endpointUrl":{ "description":"The endpointUrl where the client should connect to communicate with the Agent.", "type":"string" }, "description":{ "description":"deployment description.", "type":"string" }, "deploymentType":{ "description":"Type of an Agent Flow Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentType", "enum":[ "TEST", "PROD", "CODE" ] }, "lifecycleState":{ "description":"LifecycleState of an Agent Flow Session or Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentLifecycleState", "enum":[ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ] }, "deploymentVersion":{ "description":"version of agent flow deployed on compute.", "type":"string" }, "timeCreated":{ "description":"The date and time the Agent flow session was created.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the Agent flow session.", "type":"string", "minLength":1, "maxLength":255 }, "timeUpdated":{ "description":"The date and time the Agent flow deployment was updated.", "type":"string", "format":"date-time" }, "updatedBy":{ "description":"The OCID of the user/principal who re-deployed the existing Agent flow deployment.", "type":"string", "minLength":1, "maxLength":255 }, "sessionRetentionConfig":{ "$ref":"#/definitions/SessionRetentionConfiguration" }, "oAuthConfig":{ "$ref":"#/definitions/OAuthConfiguration" } } }, "AgentFlowDeploymentSummary":{ "description":"Agent flow deployment summary.", "type":"object", "required":[ "displayName", "key", "lifecycleState", "deploymentType", "deploymentVersion", "timeCreated", "createdBy" ], "properties":{ "displayName":{ "description":"Display name.", "type":"string" }, "description":{ "description":"deployment description.", "type":"string" }, "key":{ "description":"Identifier, generally uuid.", "type":"string" }, "lifecycleState":{ "description":"LifecycleState of an Agent Flow Session or Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentLifecycleState", "enum":[ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ] }, "deploymentType":{ "description":"Type of an Agent Flow Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentType", "enum":[ "TEST", "PROD", "CODE" ] }, "agentFlowComputeKey":{ "description":"The Agent Flow Compute Key where client can run or test the Agent Flow.", "type":"string" }, "agentFlowKey":{ "description":"The Agent Flow key for which the session is started.", "type":"string" }, "endpointUrl":{ "description":"The endpointUrl where the client should connect to communicate with the Agent.", "type":"string" }, "deploymentVersion":{ "description":"version of agent flow deployed on compute.", "type":"string" }, "timeCreated":{ "description":"The date and time the Agent flow session was created.", "type":"string", "format":"date-time" }, "createdBy":{ "description":"The OCID of the user/principal who created the Agent flow session.", "type":"string", "minLength":1, "maxLength":255 } } }, "AgentFlowDeploymentCollection":{ "type":"object", "description":"Result of listing agent flow deployments of an agent flow.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Agent Flow Deployments.", "type":"array", "items":{ "$ref":"#/definitions/AgentFlowDeploymentSummary" } } } }, "DeployAgentFlowDetails":{ "description":"Agentflow details to deploy an agentflow.", "type":"object", "required":[ "agentFlowKey", "deploymentType" ], "properties":{ "displayName":{ "description":"Display name.", "type":"string" }, "description":{ "description":"deployment description.", "type":"string" }, "agentFlowComputeKey":{ "description":"The Agent Flow Compute Key where client can run or test the Agent Flow.", "type":"string" }, "agentFlowKey":{ "description":"The Agent Flow key for which the session is started.", "type":"string" }, "deploymentType":{ "description":"Type of an Agent Flow Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentType", "enum":[ "TEST", "PROD", "CODE" ] }, "sessionRetentionConfig":{ "$ref":"#/definitions/SessionRetentionConfiguration" }, "oAuthConfig":{ "$ref":"#/definitions/OAuthConfiguration" } } }, "UpdateAgentFlowDeploymentDetails":{ "description":"Details required to update the deployment of an Agent Flow.", "type":"object", "required":[ "agentFlowKey", "deploymentType" ], "properties":{ "displayName":{ "description":"Display name.", "type":"string" }, "description":{ "description":"deployment description.", "type":"string" }, "agentFlowComputeKey":{ "description":"The Agent Flow Compute Key where client can run or test the Agent Flow.", "type":"string" }, "agentFlowKey":{ "description":"The Agent Flow key for which the session is started.", "type":"string" }, "deploymentType":{ "description":"Type of an Agent Flow Deployment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentType", "enum":[ "TEST", "PROD", "CODE" ] }, "oAuthConfig":{ "$ref":"#/definitions/OAuthConfiguration" } } }, "CreateAgentFlowSessionDetails":{ "description":"Details required to create a new session of an Agent Flow.", "type":"object", "required":[ "agentFlowKey" ], "properties":{ "displayName":{ "description":"Display name.", "type":"string" }, "agentFlowKey":{ "description":"The Agent Flow key for which the session is started.", "type":"string" }, "context":{ "$ref":"#/definitions/AgentFlowSessionContext" } } }, "UpdateAgentFlowSessionDetails":{ "description":"Details required to update a new session of an Agent Flow.", "type":"object", "properties":{ "displayName":{ "description":"Display name.", "type":"string" }, "timeStarted":{ "description":"The date and time the session was started", "type":"string", "format":"date-time" }, "timeEnded":{ "description":"The date and time the session was ended", "type":"string", "format":"date-time" }, "context":{ "$ref":"#/definitions/AgentFlowSessionContext" } } }, "TraceDetails":{ "type":"object", "description":"Trace object", "properties":{ "traceId":{ "type":"string", "description":"trace id" }, "parentSessionId":{ "type":"string", "description":"session id" }, "spans":{ "type":"array", "description":"collections of spans", "items":{ "$ref":"#/definitions/SpanDetails" } }, "startTime":{ "type":"integer", "format":"int64", "description":"startTime" }, "endTime":{ "type":"integer", "format":"int64", "description":"endTime" }, "resources":{ "type":"object", "description":"Map of properties", "additionalProperties":{ "type":"object" } } }, "required":[ "traceId", "parentSessionId", "startTime", "endTime", "spans" ] }, "SpanStatus":{ "type":"object", "description":"span status", "properties":{ "code":{ "type":"string", "description":"span status code" }, "message":{ "type":"string", "description":"span message" } } }, "SpanDetails":{ "type":"object", "description":"Span details", "properties":{ "parentTraceId":{ "type":"string", "description":"trace id" }, "spanId":{ "type":"string", "description":"span id" }, "parentSpanId":{ "type":"string", "description":"parent span id" }, "startTime":{ "type":"integer", "format":"int64", "description":"start time" }, "endTime":{ "type":"integer", "format":"int64", "description":"end time" }, "kind":{ "type":"string", "description":"type of span" }, "spanName":{ "type":"string", "description":"span name" }, "attributes":{ "type":"object", "description":"span attributes", "additionalProperties":{ "type":"object" } }, "events":{ "type":"array", "description":"collections of trace objects", "items":{ "$ref":"#/definitions/TraceEvent" } }, "status":{ "$ref":"#/definitions/SpanStatus" } }, "required":[ "parentTraceId", "spanId", "startTime", "endTime", "kind", "spanName", "attributes", "events", "status" ] }, "TraceEvent":{ "type":"object", "description":"event object details", "properties":{ "name":{ "type":"string", "description":"event name" }, "timestamp":{ "type":"string", "format":"date-time", "description":"event start time" }, "attributes":{ "type":"object", "description":"event attributes", "additionalProperties":{ "type":"object" } } } }, "SessionChatHistoryCollection":{ "type":"object", "description":"A paginated collection of chat messages.", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Collection of chat messages", "items":{ "$ref":"#/definitions/SessionChatHistorySummary" } } } }, "SessionChatHistorySummary":{ "type":"object", "description":"A single message in a chat session history. Does not include internal state.", "required":[ "key", "sessionKey", "role", "content", "timeCreated" ], "properties":{ "key":{ "type":"string", "description":"Unique identifier for the message." }, "sessionKey":{ "type":"string", "description":"Identifier of the chat session this message belongs to." }, "role":{ "type":"string", "description":"Role associated with the message, such as user, assistant, system, or tool." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time the message was created." }, "content":{ "type":"array", "description":"Message content.", "items":{ "$ref":"#/definitions/ChatMessage" } }, "toolName":{ "type":"string", "description":"Name of the tool, if this is a tool message." }, "toolCallId":{ "type":"string", "description":"Identifier of the tool call, if applicable." }, "metadata":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Optional key-value metadata associated with the message" } } }, "ChatMessage":{ "description":"The content of the chat query sent by the user.", "type":"object", "required":[ "type" ], "properties":{ "type":{ "description":"Type of input.", "type":"string", "enum":[ "INPUT_TEXT", "INPUT_IMAGE", "INPUT_FILE" ] }, "text":{ "description":"Text input from the user. Set this parameter when type is input_text.", "type":"string", "minLength":1, "maxLength":1048576 }, "imageUrl":{ "description":"Image URL for the image user intends to query. Set this parameter when type is input_image.", "type":"string" }, "fileUrl":{ "description":"File URL for the image user intends to query. Set this parameter when type is input_file.", "type":"string" } } }, "StopAgentFlowSessionDetails":{ "description":"Details required to stop a session of an Agent Flow.", "type":"object" }, "PolicyType":{ "description":"Type of safety guardrail policy", "type":"string", "enum":[ "CONTENT_MODERATION", "PROMPT_ATTACKS_PREVENTION", "PII_DETECTION", "DENIED_TOPICS", "WORD_FILTERS", "CONTEXTUAL_GROUNDING", "CUSTOM_POLICY" ] }, "PolicyScope":{ "description":"Scope of policy application", "type":"string", "enum":[ "USER_REQUEST", "AGENT_RESPONSE", "BOTH" ] }, "PolicyAction":{ "description":"Action to take when policy is violated", "type":"string", "enum":[ "BLOCK", "INFORM", "MASK" ] }, "ContentModerationCategory":{ "description":"Content moderation categories", "type":"string", "enum":[ "HATE_SPEECH", "HARASSMENT", "VIOLENCE", "SEXUAL", "DEROGATORY", "TOXIC" ] }, "SafetyPolicy":{ "description":"Individual safety policy configuration", "type":"object", "discriminator":"policyType", "required":[ "policyType", "scope", "action" ], "properties":{ "policyType":{ "description":"Type of safety policy", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyType", "enum":[ "CONTENT_MODERATION", "PROMPT_ATTACKS_PREVENTION", "PII_DETECTION", "DENIED_TOPICS", "WORD_FILTERS", "CONTEXTUAL_GROUNDING", "CUSTOM_POLICY" ] }, "policyName":{ "description":"Custom name for the policy", "type":"string", "maxLength":255 }, "policyDescription":{ "description":"Description of the policy", "type":"string", "maxLength":1000 }, "scope":{ "description":"Scope of policy application", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyScope", "enum":[ "USER_REQUEST", "AGENT_RESPONSE", "BOTH" ] }, "action":{ "description":"Action to take when policy is violated", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyAction", "enum":[ "BLOCK", "INFORM", "MASK" ] }, "threshold":{ "description":"Threshold value for policy violation (0.0 to 1.0)", "type":"number", "format":"float", "minimum":0, "maximum":1, "default":0.5 } } }, "ContentModerationPolicy":{ "description":"Content moderation safety policy", "allOf":[ { "$ref":"#/definitions/SafetyPolicy" }, { "discriminator":"CONTENT_MODERATION", "properties":{ "categories":{ "description":"Content moderation categories and their configurations", "type":"array", "items":{ "$ref":"#/definitions/ContentModerationCategoryConfig" } } } } ] }, "ContentModerationCategoryConfig":{ "description":"Configuration for a content moderation category", "type":"object", "required":[ "category", "isEnabled", "threshold", "action" ], "properties":{ "category":{ "description":"Content moderation category", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ContentModerationCategory", "enum":[ "HATE_SPEECH", "HARASSMENT", "VIOLENCE", "SEXUAL", "DEROGATORY", "TOXIC" ] }, "isEnabled":{ "description":"Whether this category is enabled", "type":"boolean", "default":true }, "threshold":{ "description":"Threshold value for this category (0.0 to 1.0)", "type":"number", "format":"float", "minimum":0, "maximum":1, "default":0.5 }, "action":{ "description":"Action to take for this category", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyAction", "enum":[ "BLOCK", "INFORM", "MASK" ] } } }, "PiiDetectionPolicy":{ "description":"PII detection safety policy", "allOf":[ { "$ref":"#/definitions/SafetyPolicy" }, { "discriminator":"PII_DETECTION", "properties":{ "piiCategories":{ "description":"List of PII categories to detect", "type":"array", "items":{ "$ref":"#/definitions/PiiCategory" } }, "customPiiRules":{ "description":"Custom PII detection rules", "type":"array", "items":{ "$ref":"#/definitions/CustomPiiRule" } } } } ] }, "PiiCategory":{ "description":"PII category configuration", "type":"object", "required":[ "category", "isEnabled", "action" ], "properties":{ "category":{ "description":"PII category name (e.g., SSN, EMAIL, PHONE_NUMBER)", "type":"string" }, "isEnabled":{ "description":"Whether this category is enabled", "type":"boolean", "default":true }, "action":{ "description":"Action to take for this category", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyAction", "enum":[ "BLOCK", "INFORM", "MASK" ] }, "threshold":{ "description":"Detection threshold for this category", "type":"number", "format":"float", "minimum":0, "maximum":1, "default":0.5 } } }, "CustomPiiRule":{ "description":"Custom PII detection rule", "type":"object", "required":[ "name", "pattern" ], "properties":{ "name":{ "description":"Name of the custom rule", "type":"string" }, "pattern":{ "description":"Regex pattern for detection", "type":"string" }, "prefix":{ "description":"Prefix pattern to match", "type":"string" }, "suffix":{ "description":"Suffix pattern to match", "type":"string" }, "isCaseSensitive":{ "description":"Whether the pattern is case sensitive", "type":"boolean", "default":false }, "maxDistance":{ "description":"Maximum distance for pattern matching", "type":"integer" }, "priority":{ "description":"Priority of this rule", "type":"integer" } } }, "PromptAttacksPreventionPolicy":{ "description":"Prompt attacks prevention safety policy", "allOf":[ { "$ref":"#/definitions/SafetyPolicy" }, { "discriminator":"PROMPT_ATTACKS_PREVENTION" } ] }, "DeniedTopicsPolicy":{ "description":"Denied topics safety policy", "allOf":[ { "$ref":"#/definitions/SafetyPolicy" }, { "discriminator":"DENIED_TOPICS", "properties":{ "topics":{ "description":"List of denied topics", "type":"array", "items":{ "$ref":"#/definitions/DeniedTopic" } } } } ] }, "DeniedTopic":{ "description":"Denied topic configuration", "type":"object", "required":[ "name", "definition" ], "properties":{ "name":{ "description":"Name of the denied topic", "type":"string" }, "definition":{ "description":"Definition of the denied topic", "type":"string" }, "examples":{ "description":"Examples of content that would violate this topic", "type":"array", "items":{ "type":"string" } } } }, "WordFiltersPolicy":{ "description":"Word filters safety policy", "allOf":[ { "$ref":"#/definitions/SafetyPolicy" }, { "discriminator":"WORD_FILTERS", "properties":{ "words":{ "description":"List of banned words or regex patterns", "type":"array", "items":{ "type":"string" } }, "regexPatterns":{ "description":"List of regex patterns to filter", "type":"array", "items":{ "type":"string" } } } } ] }, "AgentFlowGuardrailsCollection":{ "description":"Result of listing Guardrails available for configuration", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"List of safety policies available to configure in this guardrails", "type":"array", "items":{ "$ref":"#/definitions/AgentFlowGuardrailsSummary" } } } }, "AgentFlowGuardrailsSummary":{ "description":"Guardrails Summary information", "type":"object", "properties":{ "policyType":{ "description":"Type of safety policy", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyType", "enum":[ "CONTENT_MODERATION", "PROMPT_ATTACKS_PREVENTION", "PII_DETECTION", "DENIED_TOPICS", "WORD_FILTERS", "CONTEXTUAL_GROUNDING", "CUSTOM_POLICY" ] }, "policyName":{ "description":"Custom name for the policy", "type":"string", "maxLength":255 }, "policyDescription":{ "description":"Description of the policy", "type":"string", "maxLength":1000 }, "action":{ "description":"Action to take when policy is violated", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyAction", "enum":[ "BLOCK", "INFORM", "MASK" ] }, "scope":{ "description":"Scope of policy application", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyScope", "enum":[ "USER_REQUEST", "AGENT_RESPONSE", "BOTH" ] }, "threshold":{ "description":"Threshold value for policy violation (0.0 to 1.0)", "type":"number", "format":"float", "minimum":0, "maximum":1, "default":0.5 }, "categories":{ "description":"Guardrail categories for this policy and their configurations", "type":"array", "items":{ "$ref":"#/definitions/CategoryConfig" } } } }, "CategoryConfig":{ "description":"Configuration for a guardrail category", "type":"object", "properties":{ "category":{ "description":"Category", "type":"string" }, "isEnabled":{ "description":"Whether this category is enabled", "type":"boolean", "default":true }, "threshold":{ "description":"Threshold value for this category (0.0 to 1.0)", "type":"number", "format":"float", "minimum":0, "maximum":1, "default":0.5 }, "action":{ "description":"Action to take for this category", "type":"string", "x-obmcs-top-level-enum":"#/definitions/PolicyAction", "enum":[ "BLOCK", "INFORM", "MASK" ] } } }, "AgentFlowSessionMetric":{ "description":"Session Metrics data for a agentFlow.", "type":"object", "required":[ "totalSessions", "successfulSessions", "failedSessions" ], "properties":{ "totalSessions":{ "type":"integer", "description":"The total number of sessions for the agent flow" }, "successfulSessions":{ "type":"integer", "description":"The number of successful sessions for the agent flow" }, "failedSessions":{ "type":"integer", "description":"The number of failed sessions for the agent flow" }, "totalTokenUsage":{ "type":"integer", "description":"The total token usage for all sessions" }, "totalInputTokenCount":{ "type":"integer", "description":"The total input token usage count" }, "totalOutputTokenCount":{ "type":"integer", "description":"The total input token usage count" }, "avgTotalToken":{ "type":"number", "format":"float", "description":"The average total token usage by session" }, "avgInputToken":{ "type":"number", "format":"float", "description":"The average input token usage by session" }, "avgOutputToken":{ "type":"number", "format":"float", "description":"The average output token usage by session" }, "avgSessionDuration":{ "type":"number", "format":"float", "description":"The average duration of sessions" }, "minSessionDuration":{ "type":"number", "format":"float", "description":"The min duration of sessions" }, "maxSessionDuration":{ "type":"number", "format":"float", "description":"The max duration of sessions" }, "sessionDurationP50":{ "type":"number", "format":"float", "description":"The 50th percentile duration of sessions" }, "sessionDurationP95":{ "type":"number", "format":"float", "description":"The 95th percentile duration of sessions" }, "avgSessionLatency":{ "type":"number", "format":"float", "description":"The average Latency of sessions" }, "minSessionLatency":{ "type":"number", "format":"float", "description":"The min Latency of sessions" }, "maxSessionLatency":{ "type":"number", "format":"float", "description":"The max Latency of sessions" }, "sessionLatencyP50":{ "type":"number", "format":"float", "description":"The 50th percentile Latency of sessions" }, "sessionLatencyP95":{ "type":"number", "format":"float", "description":"The 95th percentile Latency of sessions" }, "totalSessionRequests":{ "type":"integer", "description":"The total requests for all sessions" }, "successfulSessionRequests":{ "type":"integer", "description":"The successful requests for all sessions" }, "failedSessionRequests":{ "type":"integer", "description":"The failed requests for all sessions" }, "totalErrorCount":{ "type":"integer", "description":"The total error count for all sessions" }, "userErrorCount":{ "type":"integer", "description":"The user error count" }, "systemErrorCount":{ "type":"integer", "description":"The system error count" }, "range":{ "$ref":"#/definitions/AgentFlowSessionMetricsRange" }, "dataPoints":{ "type":"array", "description":"Ordered list of time-series. Each entry is keyed by the same name as the KPI it represents.\n", "items":{ "$ref":"#/definitions/KeyedTimeSeries" } } } }, "AgentFlowSessionMetricsRange":{ "type":"object", "description":"Time range and granularity used for Metrics time-series data", "required":[ "timeBegin", "timeEnd", "granularity", "timezone" ], "properties":{ "timeBegin":{ "type":"string", "description":"Start time for Metrics data", "format":"date-time", "example":"2025-12-16T23:35:26Z" }, "timeEnd":{ "type":"string", "description":"End time for Metrics data", "format":"date-time", "example":"2025-12-17T23:35:26Z" }, "granularity":{ "type":"string", "description":"Granularity within the selected time range", "example":"1h, 1d" }, "timezone":{ "type":"string", "description":"Time zone used for metrics data", "example":"UTC" } } }, "KeyedTimeSeries":{ "type":"object", "description":"keyed time series", "required":[ "key", "aggregatedTimeSeriesDataPoints" ], "properties":{ "key":{ "type":"string", "description":"KPI field name (e.g., totalSessions, totalInputTokenCount)" }, "aggregatedTimeSeriesDataPoints":{ "description":"aggregated time series data points", "type":"array", "items":{ "$ref":"#/definitions/AggregatedTimeSeriesDataPoint" } } } }, "AggregatedTimeSeriesDataPoint":{ "type":"object", "description":"Aggregated time series data point", "required":[ "timestamp", "value" ], "properties":{ "timestamp":{ "type":"string", "format":"date-time", "description":"Bucket start timestamp in UTC", "example":"2025-12-17T12:30:00.000Z" }, "value":{ "type":"number", "format":"float", "description":"Value for that time bucket" } } }, "KnowledgeBaseType":{ "type":"string", "description":"Type of KnowledgeBase supported", "enum":[ "NATIVE" ] }, "KnowledgeBaseJobLifecycleState":{ "type":"string", "description":"Lifecycle state for KB JOB", "enum":[ "ACTIVE", "INACTIVE", "CREATING", "DELETING" ] }, "KnowledgeBaseJobRunTriggerType":{ "type":"string", "description":"Type of KB Job Run Trigger supported", "enum":[ "NOTEBOOK", "OTHER" ] }, "KnowledgeBaseJobType":{ "type":"string", "description":"Type of KnowledgeBase Job Definition supported", "enum":[ "SCHEDULED", "ON_DEMAND" ] }, "KnowledgeBaseSourceType":{ "type":"string", "description":"Type of KnowledgeBase Sources", "enum":[ "VOLUME", "TABLE" ] }, "KnowledgeBaseModality":{ "type":"string", "description":"Type of modalities supported in KnowledgeBase", "enum":[ "TEXT" ] }, "KnowledgeBaseEmbeddingModelSourceType":{ "type":"string", "description":"Type of Sources supported where Embedding is generated", "enum":[ "ADW_23_AI", "ADW_26_AI", "GEN_AI" ] }, "KnowledgeBaseVectorDbType":{ "type":"string", "description":"Type of Vector Store supported where Embedding is stored", "enum":[ "ADW_23_AI", "ADW_26_AI" ] }, "KnowledgeBaseVectorIndexType":{ "type":"string", "description":"Type of Vector Index", "enum":[ "HNSW", "IVF" ] }, "KnowledgeBaseJobGoalType":{ "type":"string", "description":"Type of KB Job Goal supported", "enum":[ "ADD_REFRESH_SOURCE", "DELETE_SOURCE" ] }, "KnowledgeBaseVectorIndexDetails":{ "description":"Index configuration details", "type":"object", "properties":{ "type":{ "description":"Type of vector index (HNSW or IVF)", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseVectorIndexType", "enum":[ "HNSW", "IVF" ] }, "hnswDetails":{ "$ref":"#/definitions/KbVHnswIndexDetails" }, "ivfDetails":{ "$ref":"#/definitions/KbVIvfIndexDetails" } } }, "KnowledgeBaseJobRunLifecycleState":{ "type":"string", "description":"Lifecycle state for KnowledgeBase Job Run", "enum":[ "ACCEPTED", "CANCELING", "CANCELED", "FAILED", "SUCCEEDED", "IN_PROGRESS" ] }, "KnowledgeBaseLifecycleState":{ "type":"string", "description":"Lifecycle state for KnowledgeBase", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "NEEDS_ATTENTION", "DELETED", "FAILED" ] }, "KnowledgeBaseSourceMetadataDetails":{ "description":"The information about a source to be added to a KnowledgeBase", "type":"object", "required":[ "name", "key", "type", "location" ], "properties":{ "key":{ "description":"key for the source", "type":"string", "minLength":1, "maxLength":255 }, "name":{ "description":"name for the source", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"New description of KnowledgeBase", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"The type of source", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseSourceType", "enum":[ "VOLUME", "TABLE" ] }, "location":{ "description":"location on volume or name of the table", "type":"string", "minLength":1, "maxLength":1000 }, "workspaceKey":{ "description":"The id of the workspace associated with the source.", "type":"string" }, "clusterKey":{ "description":"The id of the cluster associated with the source.", "type":"string" }, "chunkSize":{ "description":"Chunk size at source level settings", "type":"integer", "format":"int64" }, "chunkOverlap":{ "description":"Chunk Overlap at source level settings", "type":"integer", "format":"int64" }, "sourceFilePattern":{ "description":"Applicable for Native KnowledgeBase where source type is KnowledgeBase", "type":"string" }, "timeCreated":{ "description":"The time at which KnowledgeBase was created. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "createdBy":{ "description":"Identifier for KnowledgeBase creator", "type":"string" } } }, "CreateKnowledgeBaseDetails":{ "description":"The information about new KnowledgeBase.", "type":"object", "required":[ "displayName", "catalogKey", "schemaKey", "workspaceKey", "clusterKey", "type" ], "properties":{ "displayName":{ "description":"Name of KnowledgeBase", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"The description of KnowledgeBase.", "type":"string" }, "catalogKey":{ "description":"The key of the catalog containing the KnowledgeBase.", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"type of KnowledgeBase", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseType", "enum":[ "NATIVE" ] }, "schemaKey":{ "description":"The key of the schema containing the Knowledgebase.", "type":"string", "minLength":1, "maxLength":255 }, "workspaceKey":{ "description":"The id of the workspace associated with the KnowledgeBase.", "type":"string" }, "clusterKey":{ "description":"The id of the cluster associated with the KnowledgeBase.", "type":"string" }, "modality":{ "description":"Modality of the data in this KnowledgeBase", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseModality", "enum":[ "TEXT" ] }, "embeddingModelSourceType":{ "description":"Information about where embedding model is located", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseEmbeddingModelSourceType", "enum":[ "ADW_23_AI", "ADW_26_AI", "GEN_AI" ] }, "embeddingModelName":{ "description":"Name of the embedding model", "type":"string" }, "chunkSize":{ "description":"Chunk size at KnowledgeBase level which can be overridden by source level settings", "type":"integer", "format":"int64" }, "chunkOverlap":{ "description":"Chunk Overlap at KnowledgeBase level which can be overridden by source level settings", "type":"integer", "format":"int64" }, "sourceFilePattern":{ "description":"Applicable for Native KnowledgeBase where source type is KnowledgeBase", "type":"string" }, "indexDetails":{ "$ref":"#/definitions/KnowledgeBaseVectorIndexDetails" } } }, "KnowledgeBase":{ "description":"Description of KnowledgeBase.", "type":"object", "required":[ "key", "displayName", "catalogKey", "workspaceKey", "clusterKey", "schemaKey", "timeCreated", "createdBy" ], "properties":{ "key":{ "description":"The Unique identifier for this KnowledgeBase resource", "type":"string" }, "displayName":{ "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.", "type":"string" }, "description":{ "description":"A user-friendly description about this KnowledgeBase resource", "type":"string" }, "catalogKey":{ "description":"The key of the catalog containing the KnowledgeBase.", "type":"string" }, "schemaKey":{ "description":"The key of the schema containing the KnowledgeBase.", "type":"string" }, "type":{ "description":"type of Knowledgebase", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseType", "enum":[ "NATIVE" ] }, "workspaceKey":{ "description":"The id of the workspace associated with the KnowledgeBase.", "type":"string" }, "clusterKey":{ "description":"The id of the cluster associated with the KnowledgeBase.", "type":"string" }, "modality":{ "description":"Modality of the data in this Knowledgebase", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseModality", "enum":[ "TEXT" ] }, "embeddingModelSourceType":{ "description":"Information about where embedding model is located", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseEmbeddingModelSourceType", "enum":[ "ADW_23_AI", "ADW_26_AI", "GEN_AI" ] }, "embeddingModelName":{ "description":"Name of the embedding model", "type":"string" }, "vectorDbType":{ "description":"Information about where embeddings of data are located", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseVectorDbType", "enum":[ "ADW_23_AI", "ADW_26_AI" ] }, "vectorTable":{ "description":"Name of the embedding table", "type":"string" }, "docTable":{ "description":"Name of the table to track documents/records for which embeddings are generated", "type":"string" }, "chunkSize":{ "description":"Chunk size at KnowledgeBase level which can be overridden by source level settings", "type":"integer", "format":"int64" }, "chunkOverlap":{ "description":"Chunk Overlap at KnowledgeBase level which can be overridden by source level settings", "type":"integer", "format":"int64" }, "sourceFilePattern":{ "description":"Applicable for Native KnowledgeBase where source type is KnowledgeBase", "type":"string" }, "timeLastEmbedding":{ "description":"Timestamp for last job run", "type":"string", "format":"date-time" }, "indexType":{ "description":"Type of Index if present, supported types:\n* HNSW (Hierarchical Navigable Small World)\n* IVF (Inverted File)\n", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseVectorIndexType", "enum":[ "HNSW", "IVF" ] }, "indexName":{ "description":"Name of Index if present", "type":"string" }, "timeLastIndexing":{ "description":"Timestamp for last index", "type":"string", "format":"date-time" }, "indexDistance":{ "description":"Distance metric for the vector index", "type":"string" }, "indexTargetAccuracy":{ "description":"Target accuracy percentage for the index (1-100)", "type":"integer", "minimum":1, "maximum":100 }, "indexNeighborPartitions":{ "description":"Number of partitions (clusters) for IVF index", "type":"integer", "minimum":1 }, "indexNeighbors":{ "description":"Maximum number of neighbors for HNSW index", "type":"integer", "minimum":1, "maximum":2048 }, "indexEfConstruction":{ "description":"Maximum number of closest vector candidates for HNSW index construction", "type":"integer", "minimum":1, "maximum":65535 }, "indexNeighborPartitionProbes":{ "description":"Maximum number of partitions to probe for IVF index", "type":"integer", "minimum":1 }, "timeCreated":{ "description":"Timestamp when KnowledgeBase was created", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Timestamp when KnowledgeBase was updated", "type":"string", "format":"date-time" }, "createdBy":{ "description":"Identifier for KnowledgeBase creator", "type":"string" }, "updatedBy":{ "description":"Identifier for principal who updated the KnowledgeBase", "type":"string" }, "currentProcessedItems":{ "description":"Count of items/documents processed by KB for which embeddings are present", "type":"integer", "format":"int64" }, "lifecycleState":{ "description":"Lifecycle of KnowledgeBase", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseLifecycleState", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "NEEDS_ATTENTION", "DELETED", "FAILED" ] }, "lifecycleStateDetails":{ "description":"Additional information about the current state of KnowledgeBase", "type":"string" }, "version":{ "description":"Version to track schemas of Embedding and Doc table", "type":"integer", "format":"int64" }, "sources":{ "description":"Source information", "type":"array", "items":{ "$ref":"#/definitions/KnowledgeBaseSourceMetadataDetails" } }, "indexDetails":{ "$ref":"#/definitions/KnowledgeBaseVectorIndexDetails" }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "KnowledgeBaseCollection":{ "type":"object", "description":"Results of a knowledgebase search. Contains both KnowledgeBaseSummary items and other data.", "required":[ "items" ], "properties":{ "items":{ "description":"List of knowledgeBase Summaries.", "type":"array", "items":{ "$ref":"#/definitions/KnowledgeBaseSummary" } }, "nextStartPage":{ "description":"token for next opc page.", "type":"string" } } }, "KnowledgeBaseSummary":{ "description":"Summary of the KnowledgeBase.", "type":"object", "required":[ "key", "displayName", "lifecycleState", "timeCreated" ], "properties":{ "key":{ "description":"Immutable Unique identifier generated at creation", "type":"string" }, "displayName":{ "description":"KnowledgeBase Identifier, can be renamed", "type":"string" }, "catalogKey":{ "description":"the catalog hosting the KnowledgeBase", "type":"string" }, "schemaKey":{ "description":"the schema inside the catalog hosting the KnowledgeBase", "type":"string" }, "description":{ "description":"The description of KnowledgeBase.", "type":"string" }, "timeCreated":{ "description":"The time at which KnowledgeBase was created. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "createdBy":{ "description":"Identifier for KnowledgeBase creator", "type":"string" }, "timeUpdated":{ "description":"The time at which KnowledgeBase was updated. An RFC3339 formatted datetime string", "type":"string", "format":"date-time" }, "updatedBy":{ "description":"Identifier for principal who updated the KnowledgeBase", "type":"string" }, "currentProcessedItems":{ "description":"Count of items/documents processed by KB for which embeddings are present", "type":"integer", "format":"int64" }, "lifecycleState":{ "description":"The current state of the KnowledgeBase.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseLifecycleState", "enum":[ "CREATING", "ACTIVE", "UPDATING", "DELETING", "NEEDS_ATTENTION", "DELETED", "FAILED" ] }, "systemTags":{ "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n", "type":"object", "additionalProperties":{ "type":"object", "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n", "additionalProperties":{ "type":"object", "description":"The value of the tag. Only the String type is supported.\n" } } } } }, "UpdateKnowledgeBaseAddSourceDetails":{ "description":"The information about a source to be added to a KnowledgeBase", "type":"object", "required":[ "name", "type", "location" ], "properties":{ "name":{ "description":"name for source", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"New description of KnowledgeBase", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"The type of source", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseSourceType", "enum":[ "VOLUME", "TABLE" ] }, "shouldRunIngestionJobInline":{ "description":"Optional boolean flag to indicate if ingestion job should run inline.", "type":"boolean", "default":true }, "workspaceKey":{ "description":"The id of the workspace associated with the source.", "type":"string" }, "clusterKey":{ "description":"The id of the cluster associated with the source.", "type":"string" }, "location":{ "description":"location on volume or name of the table", "type":"string", "minLength":1, "maxLength":1000 }, "chunkSize":{ "description":"Chunk size at KnowledgeBase level which can be overridden by source level settings", "type":"integer", "format":"int64" }, "chunkOverlap":{ "description":"Chunk Overlap at KnowledgeBase level which can be overridden by source level settings", "type":"integer", "format":"int64" }, "sourceFilePattern":{ "description":"Applicable for Native KnowledgeBase where source type is KnowledgeBase", "type":"string" } } }, "UpdateKnowledgeBaseDeleteSourceDetails":{ "description":"The information about a source to be delete from a KnowledgeBase", "type":"object", "required":[ "name", "type" ], "properties":{ "name":{ "description":"name for source", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"The type of source", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseSourceType", "enum":[ "VOLUME", "TABLE" ] } } }, "KnowledgeBaseSourceUpdateOperationType":{ "type":"string", "description":"Update action type supported on sources in KnowledgeBase", "enum":[ "ADD_SOURCE", "DELETE_SOURCE" ] }, "UpdateKnowledgeBaseSourceUpdateDetailsItem":{ "description":"The information to be updated for KnowledgeBase source.", "type":"object", "required":[ "action" ], "properties":{ "action":{ "description":"Source update action type", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseSourceUpdateOperationType", "enum":[ "ADD_SOURCE", "DELETE_SOURCE" ] }, "updateKnowledgeBaseAddSourceDetails":{ "$ref":"#/definitions/UpdateKnowledgeBaseAddSourceDetails" }, "updateKnowledgeBaseDeleteSourceDetails":{ "$ref":"#/definitions/UpdateKnowledgeBaseDeleteSourceDetails" } } }, "UpdateKnowledgeBaseSourceUpdateDetails":{ "description":"The information to be updated for KnowledgeBase source.", "type":"object", "properties":{ "sources":{ "description":"Batch Payload for updating KnowledgeBase sources. Items marked for deletion are processed before items marked for addition", "type":"array", "items":{ "$ref":"#/definitions/UpdateKnowledgeBaseSourceUpdateDetailsItem" } } } }, "UpdateKnowledgeBaseMetadataUpdateDetails":{ "description":"The information about a source metad", "type":"object", "properties":{ "name":{ "description":"new name for source", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"new description for source", "type":"string", "minLength":1, "maxLength":255 } } }, "KnowledgeBaseUpdateOperationType":{ "type":"string", "description":"Update supported in KnowledgeBase/source", "enum":[ "METADATA_UPDATE", "SOURCES_UPDATE", "ADD_INDEX", "DROP_INDEX" ] }, "UpdateKnowledgeBaseDetails":{ "description":"The information to be updated.", "type":"object", "required":[ "action" ], "properties":{ "action":{ "description":"The update operation we want to perform on KnowledgeBase.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseUpdateOperationType", "enum":[ "METADATA_UPDATE", "SOURCES_UPDATE", "ADD_INDEX", "DROP_INDEX" ] }, "indexDetails":{ "$ref":"#/definitions/KnowledgeBaseVectorIndexDetails" }, "updateKnowledgeBaseMetadataUpdateDetails":{ "$ref":"#/definitions/UpdateKnowledgeBaseMetadataUpdateDetails" }, "updateKnowledgeBaseSourceUpdateDetails":{ "$ref":"#/definitions/UpdateKnowledgeBaseSourceUpdateDetails" } } }, "CreateKnowledgeBaseJobDetails":{ "description":"Request body for creating a new job definition for a KnowledgeBase.", "type":"object", "required":[ "displayName", "type" ], "properties":{ "displayName":{ "description":"Name of KnowledgeBase Job Definition", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"The description of KnowledgeBase Job", "type":"string" }, "type":{ "description":"type of KB Job", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobType", "enum":[ "SCHEDULED", "ON_DEMAND" ] }, "goal":{ "description":"type of KB Job Goal, if missing it is considered that job aims to add/refresh the sources", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobGoalType", "enum":[ "ADD_REFRESH_SOURCE", "DELETE_SOURCE" ] }, "sources":{ "description":"Name of the source, \"*\" should be provided to create a DEFAULT JOB and sourceKey can be left null/empty for DEFAULT Job", "type":"string" }, "sourceKey":{ "description":"Id of the source, should be provided for all jobs except DEFAULT JOB (which is supposed to run at all sources of KB)", "type":"string" }, "schedule":{ "description":"If the job type is SCHEDULED, this field is used to provide schedule information in cron style. For example, \"0 0 * * *\" means 12:00 AM daily", "type":"string" } } }, "KnowledgeBaseJob":{ "description":"Description of KB Job Definition.", "type":"object", "required":[ "key", "displayName", "type", "catalogKey", "schemaKey", "knowledgeBaseKey", "timeCreated", "createdBy" ], "properties":{ "key":{ "description":"The Unique identifier for this KnowledgeBase Job resource", "type":"string" }, "workflowJobKey":{ "description":"The Unique identifier for this KnowledgeBase Job resource's mapped WF job", "type":"string" }, "displayName":{ "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.", "type":"string" }, "description":{ "description":"A user-friendly description about this KnowledgeBase Job resource", "type":"string" }, "knowledgeBaseKey":{ "description":"The name of the KnowledgeBase", "type":"string" }, "catalogKey":{ "description":"The name of the catalog containing the KnowledgeBase.", "type":"string" }, "schemaKey":{ "description":"The name of the schema containing the KnowledgeBase.", "type":"string" }, "type":{ "description":"type of knowledgeBase Job Definition", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobType", "enum":[ "SCHEDULED", "ON_DEMAND" ] }, "goal":{ "description":"type of KB Job Goal", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobGoalType", "enum":[ "ADD_REFRESH_SOURCE", "DELETE_SOURCE" ] }, "sources":{ "description":"Name of the source, \"*\" for Default job", "type":"string" }, "sourceKey":{ "description":"Id of the source, should be provided for all jobs except DEFAULT JOB (which is supposed to run at all sources of KB)", "type":"string" }, "schedule":{ "description":"If the job type is SCHEDULED, this field is used to provide schedule information in cron style. For example, \"0 0 * * *\" means 12:00 AM daily", "type":"string" }, "timeCreated":{ "description":"Timestamp when knowledgeBase job was created", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Timestamp when knowledgeBase job was updated", "type":"string", "format":"date-time" }, "createdBy":{ "description":"Identifier for knowledgeBase job creator", "type":"string" }, "updatedBy":{ "description":"Identifier for principal who updated the knowledgeBase job", "type":"string" }, "lifecycleState":{ "description":"Lifecycle of knowledgeBase Job.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobLifecycleState", "enum":[ "ACTIVE", "INACTIVE", "CREATING", "DELETING" ] }, "lifecycleStateDetails":{ "description":"Additional information about the current state of KB job", "type":"string" } } }, "KnowledgeBaseJobSummary":{ "description":"Description of KB Job Definition.", "type":"object", "required":[ "key", "displayName", "type", "knowledgeBaseKey", "catalogKey", "schemaKey", "timeCreated", "createdBy" ], "properties":{ "key":{ "description":"The Unique identifier for this KnowledgeBase Job resource", "type":"string" }, "displayName":{ "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.", "type":"string" }, "description":{ "description":"A user-friendly description about this KnowledgeBase Job resource", "type":"string" }, "catalogKey":{ "description":"The name of the catalog containing the KnowledgeBase.", "type":"string" }, "schemaKey":{ "description":"The name of the schema containing the KnowledgeBase.", "type":"string" }, "knowledgeBaseKey":{ "description":"The name of the KnowledgeBase", "type":"string" }, "type":{ "description":"type of knowledgeBase Job Definition", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobType", "enum":[ "SCHEDULED", "ON_DEMAND" ] }, "sources":{ "description":"Name of the source, \"*\" for Default job", "type":"string" }, "sourceKey":{ "description":"Id of the source, should be provided for all jobs except DEFAULT JOB (which is supposed to run at all sources of KB)", "type":"string" }, "timeCreated":{ "description":"Timestamp when knowledgeBase job was created", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Timestamp when knowledgeBase job was updated", "type":"string", "format":"date-time" }, "createdBy":{ "description":"Identifier for knowledgeBase job creator", "type":"string" }, "updatedBy":{ "description":"Identifier for principal who updated the knowledgeBase job", "type":"string" }, "lifecycleState":{ "description":"Lifecycle of knowledgeBase Job.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobLifecycleState", "enum":[ "ACTIVE", "INACTIVE", "CREATING", "DELETING" ] }, "lifecycleStateDetails":{ "description":"Additional information about the current state of KB job", "type":"string" } } }, "KnowledgeBaseJobCollection":{ "type":"object", "description":"Results of a knowledgebaseJOb search. Contains both KnowledgeBaseJobSummary items and other data.", "required":[ "items" ], "properties":{ "items":{ "description":"List of knowledgeBaseJob Summaries.", "type":"array", "items":{ "$ref":"#/definitions/KnowledgeBaseJobSummary" } }, "nextStartPage":{ "description":"token for next opc page.", "type":"string" } } }, "KnowledgeBaseJobRunData":{ "description":"Description of KB Job Run Statistics.", "type":"object", "properties":{ "recordsAdded":{ "description":"Number of records/files added as part of this job run", "type":"integer", "format":"int64" }, "recordsDeleted":{ "description":"Number of records/files deleted as part of this job run", "type":"integer", "format":"int64" }, "recordsUpdated":{ "description":"Number of records/files updated as part of this job run", "type":"integer", "format":"int64" }, "recordsAddedUpdatedSize":{ "description":"Size of all the records/files processed as part of this job run", "type":"integer", "format":"int64" }, "triggerType":{ "description":"Hint for how job run is getting started.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobRunTriggerType", "enum":[ "NOTEBOOK", "OTHER" ] } } }, "CreateKnowledgeBaseJobRunDetails":{ "description":"Request body for creating a new job run for a job in a KnowledgeBase.", "type":"object", "properties":{ "description":{ "description":"The description of KB Job", "type":"string" } } }, "KnowledgeBaseJobRun":{ "description":"Description of KnowledgeBase Job Run.", "type":"object", "required":[ "key", "knowledgeBaseJobKey", "knowledgeBaseKey", "catalogKey", "schemaKey", "timeCreated", "createdBy" ], "properties":{ "key":{ "description":"The Unique identifier for this KnowledgeBase Job run", "type":"string" }, "knowledgeBaseJobKey":{ "description":"The name of the KnowledgeBase Job definition", "type":"string" }, "description":{ "description":"A user-friendly description about this KnowledgeBase Job run", "type":"string" }, "catalogKey":{ "description":"The name of the catalog containing the KnowledgeBase.", "type":"string" }, "schemaKey":{ "description":"The name of the schema containing the KnowledgeBase.", "type":"string" }, "knowledgeBaseKey":{ "description":"The name of the KnowledgeBase", "type":"string" }, "timeCreated":{ "description":"Timestamp when KnowledgeBase job run was created", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Timestamp when KnowledgeBase job run was updated", "type":"string", "format":"date-time" }, "timeFinished":{ "description":"Timestamp when KnowledgeBase job run was updated", "type":"string", "format":"date-time" }, "createdBy":{ "description":"Identifier for KnowledgeBase job run creator", "type":"string" }, "updatedBy":{ "description":"Identifier for principal who updated the KnowledgeBase", "type":"string" }, "lifecycleState":{ "description":"Lifecycle of KnowledgeBase Job Run.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobRunLifecycleState", "enum":[ "ACCEPTED", "CANCELING", "CANCELED", "FAILED", "SUCCEEDED", "IN_PROGRESS" ] }, "lifecycleStateDetails":{ "description":"Additional information about the current state of KnowledgeBase job run", "type":"string" }, "runData":{ "$ref":"#/definitions/KnowledgeBaseJobRunData" } } }, "KnowledgeBaseJobRunSummary":{ "description":"Description of KB Job Run.", "type":"object", "required":[ "key", "knowledgeBaseJobKey", "knowledgeBaseKey", "catalogKey", "schemaKey", "timeCreated", "createdBy" ], "properties":{ "key":{ "description":"The Unique identifier for this KnowledgeBase Job run", "type":"string" }, "knowledgeBaseJobKey":{ "description":"The name of the KnowledgeBase Job definition", "type":"string" }, "description":{ "description":"A user-friendly description about this KnowledgeBase Job run", "type":"string" }, "catalogKey":{ "description":"The name of the catalog containing the KnowledgeBase.", "type":"string" }, "schemaKey":{ "description":"The name of the schema containing the KnowledgeBase.", "type":"string" }, "knowledgeBaseKey":{ "description":"The name of the KnowledgeBase", "type":"string" }, "timeCreated":{ "description":"Timestamp when KnowledgeBase job run was created", "type":"string", "format":"date-time" }, "timeUpdated":{ "description":"Timestamp when KnowledgeBase job run was updated", "type":"string", "format":"date-time" }, "timeFinished":{ "description":"Timestamp when KnowledgeBase job run was updated", "type":"string", "format":"date-time" }, "createdBy":{ "description":"Identifier for KnowledgeBase job run creator", "type":"string" }, "updatedBy":{ "description":"Identifier for principal who updated the KnowledgeBase", "type":"string" }, "lifecycleState":{ "description":"Lifecycle of KnowledgeBase Job Run.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobRunLifecycleState", "enum":[ "ACCEPTED", "CANCELING", "CANCELED", "FAILED", "SUCCEEDED", "IN_PROGRESS" ] }, "lifecycleStateDetails":{ "description":"Additional information about the current state of KnowledgeBase job run", "type":"string" }, "runData":{ "$ref":"#/definitions/KnowledgeBaseJobRunData" } } }, "KnowledgeBasePrivilege":{ "description":"The privilege for a Volume", "type":"string", "enum":[ "SELECT", "MANAGE", "ADMIN" ] }, "AllKnowledgeBasePrivilege":{ "description":"The privilege for a Knowledge Base which could be an inherited privilege coming from object up in hierarchy.", "type":"string", "enum":[ "WRITE", "ADMIN", "SELECT", "MANAGE" ] }, "KnowledgeBaseJobRunCollection":{ "description":"Collection of KnowledgeBase Job Run definitions.", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"Array of KnowledgeBase Runs.", "type":"array", "items":{ "$ref":"#/definitions/KnowledgeBaseJobRunSummary" } } } }, "KnowledgeBasePermissionCollection":{ "type":"object", "description":"List of Knowledge Base permissions.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Knowledge Base permissions.", "type":"array", "items":{ "$ref":"#/definitions/KnowledgeBasePermissionSummary" } } } }, "KnowledgeBasePermissionSummary":{ "description":"Information about a Knowledge Base Permission.", "type":"object", "required":[ "grantee", "granteeType", "granteePermissions" ], "properties":{ "grantee":{ "description":"The ocid of user/group and name in case of role.", "type":"string", "minLength":1, "maxLength":255 }, "granteeName":{ "description":"The simplified name of the grantee.", "type":"string", "minLength":1, "maxLength":255 }, "granteeType":{ "description":"The type of grantee.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GranteeType", "enum":[ "USER", "ROLE", "GROUP" ] }, "granteePermissions":{ "type":"array", "description":"The selected permissions for a Knowledge Base.", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/AllKnowledgeBasePrivilege", "enum":[ "WRITE", "ADMIN", "SELECT", "MANAGE" ] } }, "isInherited":{ "type":"boolean", "description":"The permission listed is inherited or not from object up in hierarchy." }, "resourceName":{ "type":"string", "description":"name of the object to which this permission belong to. This would be the name of table if permission is not inherited or name of object up in hierarchy if permission is inherited." } } }, "AssignKnowledgeBasePermissionDetails":{ "description":"The details of the permissions assigned on the Knowledge Base to assignee.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions assigned to the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBasePrivilege", "enum":[ "SELECT", "MANAGE", "ADMIN" ] } } } }, "RevokeKnowledgeBasePermissionDetails":{ "description":"The details of the permissions revoked from assignees for a Knowledge Base.", "type":"object", "required":[ "assignees", "permissions" ], "properties":{ "assignees":{ "$ref":"#/definitions/PermissionAssignees" }, "permissions":{ "type":"array", "description":"The permissions revoked from the assignees", "maxItems":100, "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBasePrivilege", "enum":[ "SELECT", "MANAGE", "ADMIN" ] } } } }, "ManageKnowledgeBasePermissionDetails":{ "description":"Information to update permissions on a Knowledge Base.", "type":"object", "properties":{ "assignKnowledgeBasePermissionDetails":{ "$ref":"#/definitions/AssignKnowledgeBasePermissionDetails" }, "revokeKnowledgeBasePermissionDetails":{ "$ref":"#/definitions/RevokeKnowledgeBasePermissionDetails" } } }, "KbVHnswIndexDetails":{ "description":"HNSW (Hierarchical Navigable Small World) index parameters", "type":"object", "properties":{ "distance":{ "description":"Distance metric for the vector index", "type":"string", "enum":[ "COSINE", "EUCLIDEAN", "L2_SQUARED", "DOT", "MANHATTAN", "HAMMING", "JACCARD" ], "default":"COSINE" }, "targetAccuracy":{ "description":"Target accuracy percentage for the index (1-100)", "type":"integer", "minimum":1, "maximum":100, "default":95 }, "neighbors":{ "description":"Maximum number of neighbors each vector can have on any layer (M parameter)", "type":"integer", "minimum":1, "maximum":2048, "default":32 }, "efConstruction":{ "description":"Maximum number of closest vector candidates considered during index construction", "type":"integer", "minimum":1, "maximum":65535, "default":200 } } }, "KbVIvfIndexDetails":{ "description":"IVF (Inverted File Flat) index parameters", "type":"object", "properties":{ "distance":{ "description":"Distance metric for the vector index", "type":"string", "enum":[ "COSINE", "EUCLIDEAN", "L2_SQUARED", "DOT", "MANHATTAN", "HAMMING", "JACCARD" ], "default":"COSINE" }, "targetAccuracy":{ "description":"Target accuracy percentage for the index (1-100)", "type":"integer", "minimum":1, "maximum":100, "default":95 }, "neighborPartitions":{ "description":"Number of partitions (clusters) to divide the vector data into", "type":"integer", "minimum":1 }, "neighborPartitionProbes":{ "description":"Maximum number of partitions to probe during a search. Higher values increase accuracy but may reduce performance", "type":"integer", "minimum":1 } } }, "Experiment":{ "description":"Details of an MLflow experiment.", "type":"object", "required":[ "experiment_id", "name" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." }, "name":{ "type":"string", "description":"Name of the experiment." }, "artifact_location":{ "type":"string", "description":"Location where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default." }, "lifecycle_stage":{ "type":"string", "description":"Lifecycle stage of the experiment, e.g., 'active' or 'deleted'." }, "creation_time":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the experiment was created." }, "last_update_time":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the experiment was last updated." }, "tags":{ "type":"array", "description":"List of tags set on the experiment.", "items":{ "$ref":"#/definitions/ExperimentTag" } } } }, "ExperimentTag":{ "description":"A tag associated with an experiment.", "type":"object", "required":[ "key" ], "properties":{ "key":{ "type":"string", "description":"Key of the experiment tag." }, "value":{ "type":"string", "description":"Value of the experiment tag." } } }, "ExperimentResponse":{ "description":"Response object for getting an experiment.", "type":"object", "required":[ "experiment" ], "properties":{ "experiment":{ "$ref":"#/definitions/Experiment" } } }, "CreateExperimentDetails":{ "description":"The data to create an experiment.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Name of the experiment." }, "artifact_location":{ "type":"string", "description":"Location where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default." }, "tags":{ "type":"array", "description":"List of tags set on the experiment.", "items":{ "$ref":"#/definitions/ExperimentTag" } } } }, "CreateExperimentResponseDetails":{ "description":"Response object for creating an experiment.", "type":"object", "required":[ "experiment_id" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." } } }, "DeleteExperimentDetails":{ "description":"Details of the experiment to delete.", "type":"object", "required":[ "experiment_id" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." } } }, "DeleteExperimentResponseDetails":{ "description":"Response object for deleting an experiment.", "type":"object" }, "UpdateExperimentDetails":{ "description":"The data to update an experiment.", "type":"object", "required":[ "experiment_id" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." }, "new_name":{ "type":"string", "description":"If provided, name of the experiment is changed to the new name. The new name must be unique." } } }, "UpdateExperimentResponseDetails":{ "description":"Response object for updating an experiment.", "type":"object" }, "ListExperimentsDetails":{ "description":"Details of experiments to fetch.", "type":"object", "properties":{ "max_results":{ "type":"integer", "format":"int64", "description":"Maximum number of experiments desired. Servers may select a default. All servers are guaranteed to \nsupport a max_results threshold of at least 1,000 but may support more. Callers are encouraged to \npass max_results explicitly and leverage page_token to iterate.\n" }, "page_token":{ "type":"string", "description":"Token indicating the page of experiments to fetch." }, "filter":{ "type":"string", "description":"A filter expression over experiment attributes and tags that allows returning a subset of experiments.\nThe syntax is a subset of SQL that supports ANDing together binary operations between an attribute or tag and a constant.\nExample: name LIKE 'test-%' AND tags.key = 'value'\nColumns with special characters (hyphen, space, period, etc.) can be selected using double quotes or backticks.\nExample: tags.\"extra-key\" = 'value' or tags.`extra-key` = 'value'\nSupported operators are =, !=, LIKE, and ILIKE.\n" }, "order_by":{ "type":"array", "items":{ "type":"string" }, "description":"List of columns for ordering search results, which can include experiment name and ID with\nan optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default. Tiebreaks are done by experiment ID DESC.\n" }, "view_type":{ "description":"Qualifier for type of experiments to be returned. If unspecified, returns only active experiments.", "type":"string", "enum":[ "ACTIVE_ONLY", "DELETED_ONLY", "ALL" ] } } }, "ExperimentCollection":{ "type":"object", "description":"Result of listing experiments.", "required":[ "experiments" ], "properties":{ "experiments":{ "description":"Experiments that match the search criteria.", "type":"array", "items":{ "$ref":"#/definitions/Experiment" } }, "next_page_token":{ "description":"Token that can be used to retrieve the next page of experiments. An empty token means that no more experiments are available for retrieval.", "type":"string" } } }, "RestoreExperimentDetails":{ "description":"Details of the experiment to restore.", "type":"object", "required":[ "experiment_id" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." } } }, "RestoreExperimentResponseDetails":{ "description":"Response object for restoring an experiment.", "type":"object" }, "SetExperimentTagDetails":{ "description":"Tag details to set on an experiment.", "type":"object", "required":[ "experiment_id", "key", "value" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." }, "key":{ "type":"string", "description":"Key of the experiment tag." }, "value":{ "type":"string", "description":"Value of the experiment tag." } } }, "SetExperimentTagResponseDetails":{ "description":"Response object for setting tag on an experiment.", "type":"object" }, "DeleteExperimentTagDetails":{ "description":"Tag details to delete on an experiment.", "type":"object", "required":[ "experiment_id", "key" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." }, "key":{ "type":"string", "description":"Key of the experiment tag." } } }, "DeleteExperimentTagResponseDetails":{ "description":"Response object for deleting tag on an experiment.", "type":"object" }, "UpdateExperimentTagsDetails":{ "description":"Details of the Experiment tags to update.", "type":"object", "required":[ "experiment_id" ], "properties":{ "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." }, "set_tags":{ "description":"Experiment tags to set.", "type":"array", "items":{ "$ref":"#/definitions/ExperimentTag" } }, "delete_tags":{ "description":"Experiment tags to delete.", "type":"array", "items":{ "$ref":"#/definitions/ExperimentTagKey" } } } }, "ExperimentTagKey":{ "description":"Key of the experiment tag.", "type":"object", "required":[ "key" ], "properties":{ "key":{ "description":"Tag key.", "type":"string" } } }, "UpdateExperimentTagsResponseDetails":{ "description":"Response object for updating tags of an experiment.", "type":"object" }, "ExperimentRunStatus":{ "type":"string", "description":"Status of the run.", "enum":[ "RUNNING", "SCHEDULED", "FINISHED", "FAILED", "KILLED", "INTERNAL_ERROR" ] }, "ExperimentRun":{ "description":"Details of an experiment run.", "type":"object", "properties":{ "info":{ "$ref":"#/definitions/ExperimentRunInfo" }, "data":{ "$ref":"#/definitions/ExperimentRunData" }, "inputs":{ "$ref":"#/definitions/ExperimentRunInputs" }, "outputs":{ "$ref":"#/definitions/ExperimentRunOutputs" } } }, "ExperimentRunInfo":{ "description":"Run metadata.", "type":"object", "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "run_name":{ "type":"string", "description":"Name of the run." }, "experiment_id":{ "type":"string", "description":"ID of the associated experiment." }, "status":{ "description":"Status of the run.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ExperimentRunStatus", "enum":[ "RUNNING", "SCHEDULED", "FINISHED", "FAILED", "KILLED", "INTERNAL_ERROR" ] }, "start_time":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the run started." }, "end_time":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the run ended." }, "artifact_uri":{ "type":"string", "description":"Artifact URI of the run." }, "lifecycle_stage":{ "type":"string", "description":"Lifecycle stage of the experiment, e.g., 'active' or 'deleted'." }, "run_uuid":{ "type":"string", "description":"UUID of the run." }, "user_id":{ "type":"string", "description":"User ID that created the run." } } }, "ExperimentRunData":{ "description":"Run data.", "type":"object", "properties":{ "metrics":{ "type":"array", "description":"Metrics logged for the run.", "items":{ "$ref":"#/definitions/ExperimentRunMetric" } }, "params":{ "type":"array", "description":"Parameters logged for the run.", "items":{ "$ref":"#/definitions/ExperimentRunParam" } }, "tags":{ "type":"array", "description":"Tags to log.", "items":{ "$ref":"#/definitions/ExperimentRunTag" } } } }, "ExperimentRunMetric":{ "type":"object", "description":"Run metric.", "properties":{ "key":{ "description":"Name of the metric.", "type":"string" }, "value":{ "description":"Value of the metric.", "type":"number", "format":"double" }, "timestamp":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when this metric was recorded." }, "step":{ "type":"integer", "format":"int64", "description":"Step at which to log the metric." } } }, "ExperimentRunParam":{ "type":"object", "description":"Run param.", "properties":{ "key":{ "description":"Key of the parameter.", "type":"string" }, "value":{ "description":"Value of the parameter.", "type":"string" } } }, "ExperimentRunTag":{ "type":"object", "description":"Run tag.", "properties":{ "key":{ "description":"Key of the run tag.", "type":"string" }, "value":{ "description":"Value of the run tag.", "type":"string" } } }, "ExperimentRunInputs":{ "description":"Run inputs.", "type":"object", "properties":{ "dataset_inputs":{ "type":"array", "description":"Dataset inputs for the run.", "items":{ "$ref":"#/definitions/DatasetInput" } }, "model_inputs":{ "type":"array", "description":"Model inputs for the run.", "items":{ "$ref":"#/definitions/ModelInput" } } } }, "DatasetInput":{ "description":"DatasetInput", "type":"object", "required":[ "dataset" ], "properties":{ "dataset":{ "$ref":"#/definitions/Dataset" }, "tags":{ "type":"array", "description":"Tags for the dataset input.", "items":{ "$ref":"#/definitions/InputTag" } } } }, "InputTag":{ "type":"object", "description":"Run tag.", "required":[ "key", "value" ], "properties":{ "key":{ "description":"Key of the tag.", "type":"string" }, "value":{ "description":"Value of the tag.", "type":"string" } } }, "Dataset":{ "type":"object", "description":"Dataset. Represents a reference to data used for training, testing, or evaluation during the model development process.", "required":[ "name", "digest", "source_type", "source" ], "properties":{ "name":{ "description":"Name of the dataset.", "type":"string" }, "digest":{ "description":"Digest (hash) of the dataset.", "type":"string" }, "source_type":{ "description":"Type of the dataset source.", "type":"string" }, "source":{ "description":"URI or path to the dataset source.", "type":"string" }, "schema":{ "description":"Schema of the dataset.", "type":"string" }, "profile":{ "description":"Profile of the dataset.", "type":"string" } } }, "ModelInput":{ "type":"object", "description":"Model input.", "required":[ "model_id" ], "properties":{ "model_id":{ "description":"ID of the model input.", "type":"string" } } }, "ExperimentRunOutputs":{ "description":"Run outputs.", "type":"object", "properties":{ "model_outputs":{ "type":"array", "description":"Model outputs for the run.", "items":{ "$ref":"#/definitions/ModelOutput" } } } }, "ModelOutput":{ "type":"object", "description":"Model output.", "required":[ "model_id" ], "properties":{ "model_id":{ "description":"ID of the model input.", "type":"string" }, "step":{ "type":"integer", "format":"int64", "description":"Step at which the model was produced." } } }, "CreateExperimentRunDetails":{ "description":"Details of run to create.", "type":"object", "properties":{ "run_name":{ "type":"string", "description":"Name of the run." }, "experiment_id":{ "type":"string", "description":"ID of the associated experiment." }, "start_time":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the run started." }, "tags":{ "type":"array", "description":"Tags to log.", "items":{ "$ref":"#/definitions/ExperimentRunTag" } } } }, "CreateExperimentRunResponseDetails":{ "description":"Details of created run.", "type":"object", "required":[ "run" ], "properties":{ "run":{ "$ref":"#/definitions/ExperimentRun" } } }, "GetExperimentRunResponseDetails":{ "description":"Details of run.", "type":"object", "required":[ "run" ], "properties":{ "run":{ "$ref":"#/definitions/ExperimentRun" } } }, "DeleteExperimentRunDetails":{ "description":"Details of the experiment run to delete.", "type":"object", "required":[ "run_id" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." } } }, "DeleteExperimentRunResponseDetails":{ "description":"Response object for deleting experiment run.", "type":"object" }, "RestoreExperimentRunDetails":{ "description":"Details of the experiment run to restore.", "type":"object", "required":[ "run_id" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." } } }, "RestoreExperimentRunResponseDetails":{ "description":"Response object for restoring experiment run.", "type":"object" }, "SetExperimentRunTagDetails":{ "description":"Tag details to set on an experiment run.", "type":"object", "required":[ "run_id", "key", "value" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "key":{ "description":"Key of the run tag.", "type":"string" }, "value":{ "description":"Value of the run tag.", "type":"string" } } }, "SetExperimentRunTagResponseDetails":{ "description":"Response object for setting experiment run tag.", "type":"object" }, "DeleteExperimentRunTagDetails":{ "description":"Tag details to delete on an experiment run.", "type":"object", "required":[ "run_id", "key" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "key":{ "description":"Key of the run tag.", "type":"string" } } }, "DeleteExperimentRunTagResponseDetails":{ "description":"Response object for deleting experiment run tag", "type":"object" }, "UpdateExperimentRunTagsDetails":{ "description":"Details of the ExperimentRun tags to update.", "type":"object", "required":[ "run_id" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "set_tags":{ "description":"ExperimentRun tags to set", "type":"array", "items":{ "$ref":"#/definitions/ExperimentRunTag" } }, "delete_tags":{ "description":"ExperimentRun tags to delete", "type":"array", "items":{ "$ref":"#/definitions/ExperimentRunTagKey" } } } }, "ExperimentRunTagKey":{ "description":"Key of the ExperimentRun tag.", "type":"object", "required":[ "key" ], "properties":{ "key":{ "description":"Tag key.", "type":"string" } } }, "UpdateExperimentRunTagsResponseDetails":{ "description":"Response object for updating tags of an ExperimentRun.", "type":"object" }, "UpdateExperimentRunDetails":{ "description":"The data to update an experiment run.", "type":"object", "required":[ "run_id" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "status":{ "description":"Updated status of the run.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ExperimentRunStatus", "enum":[ "RUNNING", "SCHEDULED", "FINISHED", "FAILED", "KILLED", "INTERNAL_ERROR" ] }, "end_time":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the run ended." }, "run_name":{ "description":"Updated name of the run.", "type":"string" } } }, "UpdateExperimentRunResponseDetails":{ "description":"Details of updated run info.", "type":"object", "required":[ "run_info" ], "properties":{ "run_info":{ "$ref":"#/definitions/ExperimentRunInfo" } } }, "LogExperimentRunMetricDetails":{ "type":"object", "description":"Details of an experiment run metric.", "required":[ "run_id", "key", "value", "timestamp" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "key":{ "description":"Name of the metric.", "type":"string" }, "value":{ "description":"Value of the metric.", "type":"number", "format":"double" }, "timestamp":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when this metric being recorded." }, "step":{ "type":"integer", "format":"int64", "description":"Step at which to log the metric." } } }, "LogExperimentRunMetricResponseDetails":{ "description":"Response object for logging experiment run metric.", "type":"object" }, "LogExperimentRunModelDetails":{ "type":"object", "description":"Details of an experiment run model.", "required":[ "run_id", "model_json" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "model_json":{ "description":"Model file in JSON format", "type":"string" } } }, "LogExperimentRunModelResponseDetails":{ "description":"Response object for logging experiment run model.", "type":"object" }, "LogExperimentRunParamDetails":{ "type":"object", "description":"Details of an experiment run param.", "required":[ "run_id", "key", "value" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "key":{ "description":"Name of the param.", "type":"string" }, "value":{ "description":"Value of the param.", "type":"string" } } }, "LogExperimentRunParamResponseDetails":{ "description":"Response object for logging experiment run param.", "type":"object" }, "LogExperimentRunInputsDetails":{ "description":"Run inputs.", "type":"object", "required":[ "run_id" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "dataset_inputs":{ "type":"array", "description":"Dataset inputs for the run.", "items":{ "$ref":"#/definitions/DatasetInput" } } } }, "LogExperimentRunInputsResponseDetails":{ "description":"Response object for logging experiment run inputs.", "type":"object" }, "LogExperimentRunBatchDetails":{ "description":"Run batch data to log.", "type":"object", "required":[ "run_id" ], "properties":{ "run_id":{ "type":"string", "description":"Unique identifier for the run." }, "metrics":{ "type":"array", "description":"Metrics to log.", "items":{ "$ref":"#/definitions/ExperimentRunMetric" } }, "params":{ "type":"array", "description":"Params to log.", "items":{ "$ref":"#/definitions/ExperimentRunParam" } }, "tags":{ "type":"array", "description":"Tags to log.", "items":{ "$ref":"#/definitions/ExperimentRunTag" } } } }, "LogExperimentRunBatchResponseDetails":{ "description":"Response object for logging experiment run batch.", "type":"object" }, "ListExperimentRunsDetails":{ "description":"Details of experiment runs to fetch.", "type":"object", "properties":{ "experiment_ids":{ "type":"array", "items":{ "type":"string" }, "description":"List of experiment IDs to search over." }, "max_results":{ "type":"integer", "format":"int32", "description":"Maximum number of runs desired. If unspecified, defaults to 1000. All servers are guaranteed to \nsupport a max_results threshold of at least 50,000 but may support more. Callers are encouraged to \npass max_results explicitly and leverage page_token to iterate.\n" }, "page_token":{ "type":"string", "description":"Token indicating the page of experiment runs to fetch." }, "filter":{ "type":"string", "description":"A filter expression over params, metrics, and tags, that allows returning a subset of runs. The syntax is \na subset of SQL that supports ANDing together binary operations between a param, metric, or tag and a constant.\nExample: metrics.rmse < 1 and params.model_class = 'LogisticRegression'\nYou can select columns with special characters (hyphen, space, period, etc.) by using \ndouble quotes: metrics.\"model class\" = 'LinearRegression' and tags.\"user-name\" = 'Tomas'\nSupported operators are =, !=, >, >=, <, and <=.\n" }, "order_by":{ "type":"array", "items":{ "type":"string" }, "description":"List of columns to be ordered by, including attributes, params, metrics, and tags with an \noptional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default. \nExample: [\"params.input DESC\", \"metrics.alpha ASC\", \"metrics.rmse\"] \nTiebreaks are done by start_time DESC followed by run_id for runs with the same start time (and this is \nthe default ordering criterion if order_by is not provided).\n" }, "run_view_type":{ "description":"Qualifier for type of runs to be returned. If unspecified, returns only active runs.", "type":"string", "enum":[ "ACTIVE_ONLY", "DELETED_ONLY", "ALL" ] } } }, "ExperimentRunCollection":{ "type":"object", "description":"Result of listing experiment runs.", "required":[ "runs" ], "properties":{ "runs":{ "description":"Runs that match the search criteria.", "type":"array", "items":{ "$ref":"#/definitions/ExperimentRun" } }, "next_page_token":{ "description":"Token that can be used to retrieve the next page of runs. An empty token means that no more runs are available for retrieval.", "type":"string" } } }, "ArtifactList":{ "type":"object", "description":"Result of listing artifacts.", "properties":{ "root_uri":{ "description":"Root artifact directory for the run.", "type":"string" }, "files":{ "description":"File location and metadata for artifacts.", "type":"array", "items":{ "$ref":"#/definitions/ArtifactFileInfo" } }, "next_page_token":{ "description":"Token that can be used to retrieve the next page of artifact results.", "type":"string" } } }, "ArtifactFileInfo":{ "type":"object", "description":"File info of artifact.", "properties":{ "path":{ "description":"Path relative to the root artifact directory run.", "type":"string" }, "is_dir":{ "description":"Whether the path is a directory.", "type":"boolean" }, "file_size":{ "description":"Size in bytes. Unset for directories.", "type":"integer", "format":"int64" } } }, "ModelVersionStatus":{ "type":"string", "description":"Status of the run.", "enum":[ "PENDING_REGISTRATION", "FAILED_REGISTRATION", "READY" ] }, "DeploymentJobState":{ "type":"string", "description":"Status of the job.", "enum":[ "DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED", "NOT_SET_UP", "CONNECTED", "NOT_FOUND", "REQUIRED_PARAMETERS_CHANGED" ] }, "DeploymentJobRunState":{ "type":"string", "description":"Status of the run.", "enum":[ "DEPLOYMENT_JOB_RUN_STATE_UNSPECIFIED", "NO_VALID_DEPLOYMENT_JOB_FOUND", "RUNNING", "SUCCEEDED", "FAILED", "PENDING", "APPROVAL" ] }, "CreateRegisteredModelDetails":{ "description":"The data to create a registered model.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Register models under this name.", "type":"string" }, "tags":{ "description":"Tags for the registered model.", "type":"array", "items":{ "$ref":"#/definitions/RegisteredModelTag" } }, "description":{ "description":"Description for the registered model.", "type":"string" }, "deployment_job_id":{ "description":"Deployment job ID for this model.", "type":"string" } } }, "RegisteredModelTag":{ "type":"object", "description":"Tag for the registered model.", "properties":{ "key":{ "description":"Key of the registered model tag.", "type":"string" }, "value":{ "description":"Value of the registered model tag.", "type":"string" } } }, "CreateRegisteredModelResponseDetails":{ "description":"Response object for creating a RegisteredModel", "type":"object", "required":[ "registered_model" ], "properties":{ "registered_model":{ "$ref":"#/definitions/RegisteredModel" } } }, "RegisteredModel":{ "description":"Details of the registered model", "type":"object", "properties":{ "name":{ "description":"Unique name for the model.", "type":"string" }, "creation_timestamp":{ "description":"Timestamp in milliseconds when the model was created.", "type":"integer", "format":"int64" }, "last_updated_timestamp":{ "description":"Timestamp in milliseconds when metadata for the model was last updated.", "type":"integer", "format":"int64" }, "description":{ "description":"Description of the registered model.", "type":"string" }, "latest_versions":{ "description":"Collection of latest model versions for each stage. Only contains models with current READY status.", "type":"array", "items":{ "$ref":"#/definitions/ModelVersion" } }, "aliases":{ "description":"Aliases pointing to model versions associated with this registered_model.", "type":"array", "items":{ "$ref":"#/definitions/RegisteredModelAlias" } }, "deployment_job_id":{ "description":"Deployment job ID.", "type":"string" }, "deployment_job_state":{ "description":"Job state.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentJobState", "enum":[ "DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED", "NOT_SET_UP", "CONNECTED", "NOT_FOUND", "REQUIRED_PARAMETERS_CHANGED" ] }, "tags":{ "description":"Tags for the registered model.", "type":"array", "items":{ "$ref":"#/definitions/RegisteredModelTag" } } } }, "RegisteredModelAlias":{ "description":"Alias of the registered model", "type":"object", "properties":{ "alias":{ "description":"The name of the alias.", "type":"string" }, "version":{ "description":"The model version number that the alias points to.", "type":"string" } } }, "ModelVersion":{ "description":"Details of the model version.", "type":"object", "properties":{ "name":{ "description":"Unique name for the model.", "type":"string" }, "version":{ "description":"Model???s version number.", "type":"string" }, "creation_timestamp":{ "description":"Timestamp in milliseconds when the model version was created.", "type":"integer", "format":"int64" }, "last_updated_timestamp":{ "description":"Timestamp in milliseconds when metadata for the model version was last updated.", "type":"integer", "format":"int64" }, "user_id":{ "description":"User that created this model version.", "type":"string" }, "current_stage":{ "description":"Current stage for this model version.", "type":"string" }, "description":{ "description":"Description of this model version.", "type":"string" }, "source":{ "description":"URI indicating the location of the source model artifacts, used when creating model version.", "type":"string" }, "run_id":{ "description":"Run ID used when creating model version.", "type":"string" }, "status":{ "description":"Current status of model version.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ModelVersionStatus", "enum":[ "PENDING_REGISTRATION", "FAILED_REGISTRATION", "READY" ] }, "status_message":{ "description":"Details on current status, if it is pending or failed.", "type":"string" }, "tags":{ "type":"array", "description":"Tags of model version.", "items":{ "$ref":"#/definitions/ModelVersionTag" } }, "run_link":{ "description":"Direct link to the run that generated this version.", "type":"string" }, "aliases":{ "description":"Aliases pointing to this version.", "type":"array", "items":{ "type":"string" } }, "model_id":{ "description":"Model ID for model version that is used to link the registered model to the source logged model.", "type":"string" }, "model_metrics":{ "type":"array", "description":"Metrics logged for the model.", "items":{ "$ref":"#/definitions/ModelMetric" } }, "model_params":{ "type":"array", "description":"Parameters logged for the model.", "items":{ "$ref":"#/definitions/ModelParam" } }, "deployment_job_state":{ "$ref":"#/definitions/ModelVersionDeploymentJobState" } } }, "ModelMetric":{ "type":"object", "description":"Model metric.", "properties":{ "key":{ "description":"Name of the metric.", "type":"string" }, "value":{ "description":"Value of the metric.", "type":"number", "format":"double" }, "timestamp":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when this metric was recorded." }, "step":{ "type":"integer", "format":"int64", "description":"Step at which to log the metric." } } }, "ModelParam":{ "type":"object", "description":"Model param.", "properties":{ "name":{ "description":"Name of the parameter.", "type":"string" }, "value":{ "description":"Value of the parameter.", "type":"string" } } }, "ModelVersionTag":{ "type":"object", "description":"ModelVersion tag.", "properties":{ "key":{ "description":"Key of the tag.", "type":"string" }, "value":{ "description":"Value of the tag.", "type":"string" } } }, "ModelVersionDeploymentJobState":{ "type":"object", "description":"ModelVersion tag.", "properties":{ "job_id":{ "description":"Job ID.", "type":"string" }, "run_id":{ "description":"Run ID.", "type":"string" }, "job_state":{ "description":"Job state.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentJobState", "enum":[ "DEPLOYMENT_JOB_CONNECTION_STATE_UNSPECIFIED", "NOT_SET_UP", "CONNECTED", "NOT_FOUND", "REQUIRED_PARAMETERS_CHANGED" ] }, "run_state":{ "description":"Run state.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentJobRunState", "enum":[ "DEPLOYMENT_JOB_RUN_STATE_UNSPECIFIED", "NO_VALID_DEPLOYMENT_JOB_FOUND", "RUNNING", "SUCCEEDED", "FAILED", "PENDING", "APPROVAL" ] }, "current_task_name":{ "description":"Current task name.", "type":"string" } } }, "GetRegisteredModelResponseDetails":{ "description":"Response object for getting a RegisteredModel", "type":"object", "required":[ "registered_model" ], "properties":{ "registered_model":{ "$ref":"#/definitions/RegisteredModel" } } }, "UpdateRegisteredModelDetails":{ "description":"The data to update a RegisteredModel.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Registered model unique name.", "type":"string" }, "description":{ "description":"Description for the registered model.", "type":"string" }, "deployment_job_id":{ "description":"Deployment job id for this model.", "type":"string" } } }, "UpdateRegisteredModelResponseDetails":{ "description":"Response object for updating a registered model.", "type":"object", "required":[ "registered_model" ], "properties":{ "registered_model":{ "$ref":"#/definitions/RegisteredModel" } } }, "RenameRegisteredModelDetails":{ "description":"The data to rename a registered model.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Current name of the registered model.", "type":"string" }, "new_name":{ "description":"New name for the registered model.", "type":"string" } } }, "RenameRegisteredModelResponseDetails":{ "description":"Response object for renaming a registered model.", "type":"object", "required":[ "registered_model" ], "properties":{ "registered_model":{ "$ref":"#/definitions/RegisteredModel" } } }, "DeleteRegisteredModelDetails":{ "description":"Details of the registered model to delete.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" } } }, "DeleteRegisteredModelResponseDetails":{ "description":"Response object for deleting a registered model.", "type":"object" }, "SetRegisteredModelTagDetails":{ "description":"Details of the registered model tag.", "type":"object", "required":[ "name", "key", "value" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "key":{ "description":"Tag key.", "type":"string" }, "value":{ "description":"Tag value.", "type":"string" } } }, "SetRegisteredModelTagResponseDetails":{ "description":"Response object for tagging a registered model.", "type":"object" }, "DeleteRegisteredModelTagDetails":{ "description":"Details of the registered model tag.", "type":"object", "required":[ "name", "key" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "key":{ "description":"Tag key.", "type":"string" } } }, "DeleteRegisteredModelTagResponseDetails":{ "description":"Response object for deleting tag of a registered model", "type":"object" }, "UpdateRegisteredModelTagsDetails":{ "description":"Details of the registered model tags to update.", "type":"object", "required":[ "name" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "set_tags":{ "description":"Registered model tags to set.", "type":"array", "items":{ "$ref":"#/definitions/RegisteredModelTag" } }, "delete_tags":{ "description":"Registered model tags to delete.", "type":"array", "items":{ "$ref":"#/definitions/RegisteredModelTagKey" } } } }, "RegisteredModelTagKey":{ "description":"Key of the registered model tag.", "type":"object", "required":[ "key" ], "properties":{ "key":{ "description":"Tag key.", "type":"string" } } }, "UpdateRegisteredModelTagsResponseDetails":{ "description":"Response object for updating tags of a registered model.", "type":"object" }, "RegisteredModelCollection":{ "type":"object", "description":"Result of listing RegisteredModels.", "required":[ "registered_models" ], "properties":{ "registered_models":{ "description":"Registered models that match the search criteria.", "type":"array", "items":{ "$ref":"#/definitions/RegisteredModel" } }, "next_page_token":{ "description":"Token that can be used to retrieve the next page of registered models.", "type":"string" } } }, "CreateModelVersionDetails":{ "description":"The data to create a model version.", "type":"object", "required":[ "name", "source" ], "properties":{ "name":{ "description":"Register models under this name.", "type":"string" }, "description":{ "description":"Description of this model version.", "type":"string" }, "source":{ "description":"URI indicating the location of the source model artifacts.", "type":"string" }, "run_id":{ "description":"Run ID that generated the model version.", "type":"string" }, "tags":{ "type":"array", "description":"Tags of model version.", "items":{ "$ref":"#/definitions/ModelVersionTag" } }, "run_link":{ "description":" Direct link to the run that generated this version.", "type":"string" }, "model_id":{ "description":"Model ID for model version that is used to link the registered model to the source logged model.", "type":"string" } } }, "CreateModelVersionResponseDetails":{ "type":"object", "description":"Created model version details.", "required":[ "model_version" ], "properties":{ "model_version":{ "$ref":"#/definitions/ModelVersion" } } }, "GetModelVersionResponseDetails":{ "type":"object", "description":"Model version details.", "required":[ "model_version" ], "properties":{ "model_version":{ "$ref":"#/definitions/ModelVersion" } } }, "UpdateModelVersionDetails":{ "description":"Details of the model version.", "type":"object", "required":[ "name", "version" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "version":{ "description":"Model version number.", "type":"string" }, "description":{ "description":"New description for the model version.", "type":"string" } } }, "UpdateModelVersionResponseDetails":{ "type":"object", "description":"Updated model version details.", "required":[ "model_version" ], "properties":{ "model_version":{ "$ref":"#/definitions/ModelVersion" } } }, "DeleteModelVersionDetails":{ "description":"Details of the model version to delete.", "type":"object", "required":[ "name", "version" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "version":{ "description":"Model version number.", "type":"string" } } }, "DeleteModelVersionResponseDetails":{ "type":"object", "description":"Response object for deleting a model version." }, "TransitionModelVersionStageDetails":{ "description":"Transition details of the model version.", "type":"object", "required":[ "name", "version", "stage", "archive_existing_versions" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "version":{ "description":"Model???s version number.", "type":"string" }, "stage":{ "description":"New stage for the model version.", "type":"string" }, "archive_existing_versions":{ "description":"Whether to archive existing versions in the target stage.", "type":"boolean" } } }, "TransitionModelVersionStageResponseDetails":{ "type":"object", "description":"Updated model version details.", "required":[ "model_version" ], "properties":{ "model_version":{ "$ref":"#/definitions/ModelVersion" } } }, "ModelVersionCollection":{ "type":"object", "description":"Result of listing model versions.", "required":[ "model_versions" ], "properties":{ "model_versions":{ "description":"Model versions that match the search criteria.", "type":"array", "items":{ "$ref":"#/definitions/ModelVersion" } }, "next_page_token":{ "description":"Token that can be used to retrieve the next page of model versions.", "type":"string" } } }, "SetModelVersionTagDetails":{ "description":"Details of the model version tag.", "type":"object", "required":[ "name", "version", "key", "value" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "version":{ "description":"Model version number.", "type":"string" }, "key":{ "description":"Tag key.", "type":"string" }, "value":{ "description":"Tag value.", "type":"string" } } }, "SetModelVersionTagResponseDetails":{ "description":"Response object for setting tag of a model version", "type":"object" }, "DeleteModelVersionTagDetails":{ "description":"Details of the model version tag.", "type":"object", "required":[ "name", "version", "key" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "version":{ "description":"Model version number.", "type":"string" }, "key":{ "description":"Tag key.", "type":"string" } } }, "DeleteModelVersionTagResponseDetails":{ "description":"Response object for deleting tag of a model version", "type":"object" }, "UpdateModelVersionTagsDetails":{ "description":"Details of the model version tags to update.", "type":"object", "required":[ "name", "version" ], "properties":{ "name":{ "description":"Name of the registered model.", "type":"string" }, "version":{ "description":"Model version number.", "type":"string" }, "set_tags":{ "description":"Model version tags to set.", "type":"array", "items":{ "$ref":"#/definitions/ModelVersionTag" } }, "delete_tags":{ "description":"Model version tags to delete.", "type":"array", "items":{ "$ref":"#/definitions/ModelVersionTagKey" } } } }, "ModelVersionTagKey":{ "description":"Key of the model version tag.", "type":"object", "required":[ "key" ], "properties":{ "key":{ "description":"Tag key.", "type":"string" } } }, "UpdateModelVersionTagsResponseDetails":{ "description":"Response object for updating tags of a model version.", "type":"object" }, "ListLoggedModelsDetails":{ "description":"Details of logged models to fetch.", "type":"object", "properties":{ "experiment_ids":{ "type":"array", "items":{ "type":"string" }, "description":"Fetch logged-models under list of experiments.\n" }, "max_results":{ "type":"integer", "format":"int64", "description":"Maximum number of logged-models desired. Servers may select a default. Callers are encouraged to \npass max_results explicitly and leverage page_token to iterate.\n" }, "page_token":{ "type":"string", "description":"Token indicating the page of logged-models to fetch." }, "filter":{ "type":"string", "description":"A filter expression over logged-models attributes.\n" }, "order_by":{ "type":"array", "items":{ "$ref":"#/definitions/LoggedModelOrder" }, "description":"List of attributes for ordering search results.\n" } } }, "LoggedModelOrder":{ "type":"object", "description":"LoggedModelOrder.", "required":[ "field_name" ], "properties":{ "field_name":{ "description":"Field name. Allowed values are creation_time.", "type":"string" }, "ascending":{ "description":"Whether the order is ascending.", "type":"boolean" } } }, "LoggedModelCollection":{ "type":"object", "description":"Result of listing logged-models.", "properties":{ "models":{ "description":"Logged models that match the search criteria", "type":"array", "items":{ "$ref":"#/definitions/LoggedModel" } }, "next_page_token":{ "description":"Token that can be used to retrieve the next page of logged-models. An empty token means that no more logged-models are available for retrieval.", "type":"string" } } }, "LoggedModel":{ "type":"object", "description":"Details of the logged model.", "properties":{ "info":{ "$ref":"#/definitions/LoggedModelInfo" }, "data":{ "description":"Details of the logged model data.", "type":"object", "additionalProperties":true } } }, "LoggedModelInfo":{ "type":"object", "description":"Details of the logged model info.", "properties":{ "model_id":{ "description":"ID of logged model.", "type":"string" }, "experiment_id":{ "type":"string", "description":"Unique identifier for the experiment." }, "name":{ "description":"Name of logged model.", "type":"string" }, "creation_timestamp_ms":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the logged model was created." }, "last_updated_timestamp_ms":{ "type":"integer", "format":"int64", "description":"Unix timestamp in milliseconds when the logged model was last updated." }, "artifact_uri":{ "description":"Artifact URI.", "type":"string" }, "status":{ "description":"Status of logged model.", "type":"string" }, "model_type":{ "description":"Model type of logged model.", "type":"string" }, "source_run_id":{ "description":"Source run ID of logged model.", "type":"string" }, "tags":{ "description":"Tags of logged model.", "type":"array", "items":{ "$ref":"#/definitions/LoggedModelTag" } } } }, "LoggedModelTag":{ "type":"object", "description":"Logged model tag.", "required":[ "key", "value" ], "properties":{ "key":{ "description":"Key of the tag.", "type":"string" }, "value":{ "description":"Value of the tag.", "type":"string" } } }, "ExperimentRunMetricHistoryCollection":{ "type":"object", "description":"Result of history of ExperimentRun metrics.", "properties":{ "metrics":{ "description":"Logged values for the metric.", "type":"array", "items":{ "$ref":"#/definitions/ExperimentRunMetric" } }, "next_page_token":{ "description":"Token that can be used to retrieve the next page of metric history. An empty token means that no more metric history are available for retrieval.", "type":"string" } } }, "Bundle":{ "description":"A Bundle is a portable package containing AIDP resource definitions.\n", "type":"object" }, "CreateBundleDetails":{ "description":"Request body to create a new bundle.", "type":"object", "required":[ "name", "path", "bundledResources" ], "properties":{ "name":{ "description":"Name for the new bundle.", "type":"string" }, "description":{ "description":"Description for the bundle.", "type":"string" }, "path":{ "description":"Target folder for the new bundle.", "type":"string" }, "bundledResources":{ "description":"List of workspace resource descriptors (jobs, agentflows) to be included.\nEach has minimally resourceType and resourceKey.\n", "type":"array", "items":{ "$ref":"#/definitions/BundledResource" } } } }, "BundledResource":{ "description":"Descriptor for a workspace resource (Job/Agentflow) to include in a bundle.", "type":"object", "required":[ "resourceType", "resourceKey" ], "properties":{ "resourceType":{ "description":"Type of resource (job or agentflow).", "type":"string", "enum":[ "JOB", "AGENTFLOW" ] }, "resourceKey":{ "description":"Workspace unique key for the resource.", "type":"string" } } }, "DeployBundleDetails":{ "description":"Request payload for bundle deploy.", "type":"object", "required":[ "path" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" } } }, "ComputeOverrideItem":{ "description":"Aggregated override candidate for a compute dependency.", "type":"object", "required":[ "name", "variableName", "defaultValue", "overrideValue" ], "properties":{ "name":{ "description":"Compute dependency name.", "type":"string" }, "variableName":{ "description":"Variable name used for this override candidate.", "type":"string" }, "defaultValue":{ "type":"string", "description":"Canonical dependency token using `.key`." }, "overrideValue":{ "description":"Current override value resolved from `.aidp/overrides.yaml` if present.", "type":"string" }, "jobs":{ "description":"Top-level jobs that reference this compute dependency.", "type":"array", "items":{ "type":"string" } } } }, "AiComputeOverrideItem":{ "description":"Aggregated override candidate for an aicompute dependency.", "type":"object", "required":[ "name", "variableName", "defaultValue", "overrideValue" ], "properties":{ "name":{ "description":"Aicompute dependency name.", "type":"string" }, "variableName":{ "description":"Variable name used for this override candidate.", "type":"string" }, "defaultValue":{ "type":"string", "description":"Canonical dependency token using `.key`." }, "overrideValue":{ "description":"Current override value resolved from `.aidp/overrides.yaml` if present.", "type":"string" }, "agentflows":{ "description":"Top-level agentflows that reference this aicompute dependency.", "type":"array", "items":{ "type":"string" } } } }, "PurgeBundleDetails":{ "description":"Request payload for bundle purge.", "type":"object", "required":[ "path" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" } } }, "SyncBundleDetails":{ "description":"Request payload for bundle sync.", "type":"object", "required":[ "path" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" } } }, "ValidateBundleDetails":{ "description":"Request payload for bundle validate.", "type":"object", "required":[ "path" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" } } }, "BundleValidationResult":{ "description":"Result of validating bundle structure/resources. Contains status and lists of error or warning messages.\n", "type":"object", "required":[ "status" ], "properties":{ "status":{ "description":"Validation status.", "type":"string", "enum":[ "VALID", "INVALID", "WARNINGS" ] }, "errors":{ "description":"List of validation error messages.", "type":"array", "items":{ "type":"string" } }, "warnings":{ "description":"List of validation warning messages.", "type":"array", "items":{ "type":"string" } } } }, "FetchBundleDeploymentStatusDetails":{ "description":"Request payload for fetch BundleDeploymentStatus.", "type":"object", "required":[ "path" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" } } }, "BundleDeploymentStatus":{ "description":"Summary of the most recent completed bundle deployment.\n", "type":"object", "required":[ "status", "timeStarted", "timeCompleted" ], "properties":{ "status":{ "type":"string", "description":"Overall status of the last deployment.", "enum":[ "SUCCEEDED", "FAILED", "IN_PROGRESS", "NOT_DEPLOYED" ] }, "timeStarted":{ "type":"string", "description":"The deployment start time", "format":"date-time" }, "timeCompleted":{ "type":"string", "description":"The deployment end time", "format":"date-time" }, "message":{ "type":"string", "description":"Optional summary message for the last deployment." }, "resources":{ "description":"List of resources from the last deployment.", "type":"array", "items":{ "$ref":"#/definitions/BundleDeployedResource" } } } }, "BundleDeployedResource":{ "description":"Reference to a deployed resource.", "type":"object", "required":[ "type", "name" ], "properties":{ "type":{ "description":"Type of resource", "type":"string", "enum":[ "JOB", "AGENTFLOW" ] }, "key":{ "description":"Workspace unique key for the resource", "type":"string" }, "name":{ "type":"string", "description":"Resource name" } } }, "BundleOverrides":{ "description":"Override candidates grouped by dependency for compute and aicompute.", "type":"object", "required":[ "compute", "aicompute" ], "properties":{ "compute":{ "description":"Compute override candidates grouped by dependency.", "type":"array", "items":{ "$ref":"#/definitions/ComputeOverrideItem" } }, "aicompute":{ "description":"Aicompute override candidates grouped by dependency.", "type":"array", "items":{ "$ref":"#/definitions/AiComputeOverrideItem" } } } }, "GetBundleOverridesDetails":{ "description":"Request payload for fetching bundle overrides.", "type":"object", "required":[ "path" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" } } }, "CreateOrUpdateBundleOverridesDetails":{ "description":"Request payload for creating or updating bundle overrides.", "type":"object", "required":[ "path", "overrides" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" }, "overrides":{ "$ref":"#/definitions/BundleOverrides" } } }, "BundleOverridesWithPath":{ "description":"Response payload for creating or updating bundle overrides.", "type":"object", "required":[ "path", "overrides" ], "properties":{ "path":{ "description":"Target folder for the new bundle.", "type":"string" }, "overrides":{ "$ref":"#/definitions/BundleOverrides" } } }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The date and time when the setting was created." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The date and time when the setting was most recently updated." }, "SettingType":{ "type":"string", "enum":[ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT", "OAUTH" ], "description":"The type of setting data." }, "GitAccountProviderName":{ "description":"The name of the Git provider.", "type":"string", "enum":[ "GITHUB", "BITBUCKET", "GITLAB", "OCI_DEVOPS" ] }, "Setting":{ "type":"object", "description":"Setting details.", "required":[ "key", "name", "isDefault" ], "properties":{ "key":{ "type":"string", "description":"The unique identifier for the setting." }, "name":{ "type":"string", "description":"A user-friendly name for the setting." }, "isDefault":{ "type":"boolean", "description":"Indicates whether this setting is the default.", "default":false }, "data":{ "$ref":"#/definitions/SettingData" } } }, "SettingData":{ "type":"object", "description":"Setting Data", "discriminator":"type", "required":[ "type" ], "properties":{ "type":{ "description":"Setting data type discriminator", "type":"string", "enum":[ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT", "OAUTH" ], "x-obmcs-top-level-enum":"#/definitions/SettingType" } } }, "UserSetting":{ "description":"User Setting", "type":"object", "allOf":[ { "$ref":"#/definitions/Setting" } ] }, "IamUserCredentialUserSetting":{ "description":"IAM user credential setting details.", "allOf":[ { "$ref":"#/definitions/SettingData" }, { "discriminator":"IAM_USER_CREDENTIAL", "required":[ "userId", "tenancy", "region", "fingerprint", "privateApiKey" ], "properties":{ "userId":{ "type":"string", "description":"User OCID or User Name." }, "tenancy":{ "type":"string", "description":"Tenancy of the user." }, "region":{ "type":"string", "description":"Region of the user." }, "fingerprint":{ "type":"string", "description":"Fingerprint." }, "privateApiKey":{ "type":"string", "description":"Private API Key." } } } ] }, "GitAccountUserSetting":{ "description":"Git account setting details.", "allOf":[ { "$ref":"#/definitions/SettingData" }, { "discriminator":"GIT_ACCOUNT", "required":[ "providerName", "entityType" ], "properties":{ "providerName":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/GitAccountProviderName", "enum":[ "GITHUB", "BITBUCKET", "GITLAB", "OCI_DEVOPS" ], "description":"The name of the Git provider." }, "entityType":{ "type":"string", "enum":[ "PERSONAL_ACCESS_TOKEN" ], "description":"The type of Git account entity." }, "username":{ "type":"string", "description":"The username for the Git account." }, "personalAccessToken":{ "type":"string", "description":"The personal access token for the Git account." } } } ] }, "OAuthAdminSetting":{ "description":"OAuth admin setting details.", "allOf":[ { "$ref":"#/definitions/SettingData" }, { "discriminator":"OAUTH", "required":[ "identityProviderUrl", "retrieveJksUrl" ], "properties":{ "identityProviderUrl":{ "type":"string", "description":"Issuer / authorization server base URL." }, "retrieveJksUrl":{ "type":"string", "description":"URL to retrieve JKS keystore." } } } ] }, "CreateSettingDetails":{ "type":"object", "description":"Details of creating setting.", "required":[ "name", "isDefault", "data" ], "properties":{ "name":{ "type":"string", "description":"A user-friendly name for the setting." }, "isDefault":{ "type":"boolean", "description":"Indicates whether this setting is the default.", "default":false }, "data":{ "$ref":"#/definitions/SettingData" } } }, "CreateUserSettingDetails":{ "type":"object", "description":"Settings details for the new user.", "allOf":[ { "$ref":"#/definitions/CreateSettingDetails" } ] }, "UpdateSettingDetails":{ "type":"object", "description":"Details of updating setting.", "required":[ "name", "isDefault", "data" ], "properties":{ "name":{ "type":"string", "description":"A user-friendly name for the setting." }, "isDefault":{ "type":"boolean", "description":"Indicates whether this setting is the default.", "default":false }, "data":{ "$ref":"#/definitions/SettingData" } } }, "UpdateUserSettingDetails":{ "type":"object", "description":"Setting details to update for the user.", "allOf":[ { "$ref":"#/definitions/UpdateSettingDetails" } ] }, "UserSettingSummary":{ "type":"object", "description":"Summary of user settings.", "required":[ "key", "name", "type", "isDefault", "timeCreated", "timeUpdated" ], "properties":{ "key":{ "type":"string", "description":"The unique identifier for the setting." }, "name":{ "type":"string", "description":"A user-friendly name for the setting." }, "type":{ "description":"Setting data type discriminator", "type":"string", "enum":[ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT", "OAUTH" ], "x-obmcs-top-level-enum":"#/definitions/SettingType" }, "isDefault":{ "type":"boolean", "description":"Indicates whether this setting is the default.", "default":false }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The date and time when the setting was created." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The date and time when the setting was most recently updated." }, "properties":{ "description":"A generic property bag associated with the setting resource.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "UserSettingCollection":{ "type":"object", "description":"Result of listing settings.", "required":[ "items" ], "properties":{ "items":{ "description":"List of settings.", "type":"array", "items":{ "$ref":"#/definitions/UserSettingSummary" } } } }, "AdminSetting":{ "description":"Admin settings.", "type":"object", "allOf":[ { "$ref":"#/definitions/Setting" } ] }, "CreateAdminSettingDetails":{ "type":"object", "description":"Settings details for the new admin.", "allOf":[ { "$ref":"#/definitions/CreateSettingDetails" } ] }, "UpdateAdminSettingDetails":{ "type":"object", "description":"Settings details to update for the admin.", "allOf":[ { "$ref":"#/definitions/UpdateSettingDetails" } ] }, "AdminSettingSummary":{ "type":"object", "description":"Summary of admin settings.", "required":[ "key", "name", "type", "isDefault", "timeCreated", "timeUpdated" ], "properties":{ "key":{ "type":"string", "description":"The unique identifier for the setting." }, "name":{ "type":"string", "description":"A user-friendly name for the setting." }, "type":{ "description":"Setting data type discriminator", "type":"string", "enum":[ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT", "OAUTH" ], "x-obmcs-top-level-enum":"#/definitions/SettingType" }, "isDefault":{ "type":"boolean", "description":"Indicates whether this setting is the default.", "default":false }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The date and time when the setting was created." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The date and time when the setting was most recently updated." }, "properties":{ "description":"A generic property bag associated with the setting resource.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "AdminSettingCollection":{ "type":"object", "description":"Result of listing settings.", "required":[ "items" ], "properties":{ "items":{ "description":"List of settings.", "type":"array", "items":{ "$ref":"#/definitions/AdminSettingSummary" } } } } }, "parameters":{ "DataLakeIdentifierPathParam":{ "name":"dataLakeId", "type":"string", "in":"path", "required":true, "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DataLake." }, "AiDataPlatformIdentifierPathParam":{ "name":"aiDataPlatformId", "type":"string", "in":"path", "required":true, "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance." }, "WorkspaceKeyPathParam":{ "name":"workspaceKey", "type":"string", "in":"path", "required":true, "description":"The key of the Workspace" }, "AsyncOperationKeyPathParam":{ "name":"asyncOperationKey", "type":"string", "in":"path", "required":true, "description":"The unique identifier of an async operation" }, "CompartmentIdQueryParam":{ "name":"compartmentId", "in":"query", "type":"string", "x-default-description":"null", "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, "WorkRequestIdQueryParam":{ "name":"workRequestId", "in":"query", "type":"string", "x-default-description":"null", "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, "RequestIdHeader":{ "name":"opc-request-id", "in":"header", "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n" }, "RetryTokenHeader":{ "description":"A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n", "in":"header", "maxLength":64, "minLength":1, "name":"opc-retry-token", "required":false, "type":"string" }, "IfMatchHeader":{ "description":"For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n", "in":"header", "name":"if-match", "required":false, "type":"string" }, "SortOrderQueryParam":{ "name":"sortOrder", "in":"query", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SortOrder", "enum":[ "ASC", "DESC" ], "x-default-description":"The default value depends upon `sortBy`, and\nin general is `DESC` when sorting by time and `ASC` otherwise.\n", "description":"The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, "PaginationLimitQueryParam":{ "name":"limit", "in":"query", "type":"integer", "minimum":1, "maximum":1000, "default":100, "description":"For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, "PaginationTokenQueryParam":{ "name":"page", "in":"query", "type":"string", "minLength":1, "x-default-description":"null", "description":"For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, "DisplayNameQueryParam":{ "in":"query", "maxLength":255, "minLength":1, "name":"displayName", "type":"string", "x-default-description":"null", "description":"A filter to return only resources that match the given display name exactly." }, "DisplayNameContainsQueryParam":{ "in":"query", "name":"displayNameContains", "type":"string", "required":false, "x-default-description":"null", "description":"A filter to return only resources that have a display name containing the text provided." }, "FolderQueryParam":{ "name":"folder", "type":"string", "in":"query", "x-default-description":"null", "description":"The folder path from which objects will be listed" }, "FolderHeader":{ "in":"header", "maxLength":255, "minLength":1, "name":"folder", "type":"string", "x-default-description":"null", "description":"The absolute path of the Folder" }, "DisplayNameHeader":{ "in":"header", "maxLength":255, "minLength":1, "name":"display-name", "type":"string", "x-default-description":"null", "description":"Display name of the Workspace Object" }, "PathQueryParam":{ "name":"path", "type":"string", "in":"query", "required":true, "description":"The absolute path of the file or folder" }, "PathHeader":{ "name":"path", "type":"string", "in":"header", "maxLength":255, "minLength":1, "required":true, "description":"The absolute path of the file or folder" }, "IsOverwriteQueryParam":{ "name":"isOverwrite", "in":"query", "required":false, "type":"boolean", "default":false, "description":"A boolean which decides if overwrite is allowed" }, "IsOverwriteHeader":{ "name":"is-overwrite", "in":"header", "required":false, "type":"boolean", "default":false, "description":"A boolean which decides if overwrite is allowed" }, "SchemaKeyQueryParam":{ "name":"schemaKey", "type":"string", "in":"query", "required":true, "x-default-description":"null", "description":"The fully qualified name of the Data Lake Schema in the format ." }, "RecentResourceUsageHeader":{ "name":"should-update-recent", "in":"header", "description":"A flag to identify if the recent list should be updated.", "required":false, "type":"boolean", "default":false }, "UserPrincipalHeader":{ "description":"The DH User Principal Header .", "name":"dh-user-principal", "required":false, "type":"string", "in":"header", "x-default-description":"This optional request header with base64 encoded serialized Principal object\n" }, "IsUploadFileDetailsBase64EncodedHeader":{ "name":"is-upload-file-base64-encoded", "in":"header", "description":"A flag to identify if the upload file is base64 encoded", "required":false, "type":"boolean", "default":false }, "isForcedHeader":{ "name":"is-forced", "in":"header", "description":"A boolean which decides if an entity should be deleted with Cascade effect", "required":false, "type":"boolean", "default":false }, "WorkspaceKeyQueryParam":{ "name":"workspaceKey", "type":"string", "in":"query", "x-default-description":"null", "description":"The key of the Workspace" }, "ClusterKeyQueryParam":{ "name":"clusterKey", "type":"string", "in":"query", "x-default-description":"null", "description":"Cluster key." }, "GranteeTypeQueryParam":{ "name":"granteeType", "in":"query", "type":"string", "enum":[ "USER", "ROLE", "GROUP" ], "x-obmcs-top-level-enum":"#/definitions/GranteeType", "default":"USER", "description":"This filter parameter can be used to filter by Grantee Type.\n" }, "DataLakeWorkspacePrivilegeQueryParam":{ "name":"workspacePrivilege", "in":"query", "type":"string", "enum":[ "USER", "PRIVILEGED_USER", "ADMINISTRATOR" ], "x-obmcs-top-level-enum":"#/definitions/WorkspacePrivilege", "default":"USER", "description":"The privilege for a workspace" }, "WorkspaceSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "WorkspacePermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "granteeName" ], "default":"granteeName", "description":"The field to sort by. You can provide only one sort order. Default order for `granteeName`\nis ascending.\n" }, "WorkspaceLifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"string", "x-obmcs-enumref":"#/definitions/Workspace/lifecycleState", "x-default-description":"null", "description":"A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, "ResourceTypeQueryParam":{ "name":"resourceType", "in":"query", "required":false, "x-default-description":"null", "type":"string", "x-obmcs-enumref":"#/definitions/RecentResourceItem/resourceType", "description":"Type of the resource to filter by." }, "WorkspaceTypeQueryParam":{ "name":"type", "in":"query", "required":false, "type":"string", "description":"When no value is provided, all workspaces are returned. Otherwise, workspace of selected value is returned.", "x-obmcs-enumref":"#/definitions/Workspace/type", "x-default-description":"When no type filter is present, all the workspaces are shown" }, "WorkspacePrivateNetworkEnabledQueryParam":{ "name":"isPrivateNetworkEnabled", "type":"boolean", "in":"query", "default":false, "required":false, "description":"A flag to filter the workspaces which are private network enabled or disabled" }, "TimeDeletedHeader":{ "name":"time-data-lake-deletion", "in":"header", "description":"Deletion time in the case that a workspace is deleted during AI Data Platform Workbench deletion.", "required":false, "type":"string", "format":"date-time", "x-default-description":"Defaults to null." }, "TaskRunKeyPathParam":{ "name":"taskRunKey", "type":"string", "in":"path", "required":true, "description":"Task run key." }, "JobKeyPathParam":{ "name":"jobKey", "type":"string", "in":"path", "required":true, "description":"Job key." }, "JobRunKeyPathParam":{ "name":"jobRunKey", "type":"string", "in":"path", "required":true, "description":"Job run key." }, "TaskRunOutputKeyPathParam":{ "name":"taskRunOutputKey", "type":"string", "in":"path", "required":true, "description":"Task run output key." }, "JobRunPaginationLimitQueryParam":{ "name":"limit", "in":"query", "type":"integer", "minimum":1, "maximum":25, "default":10, "description":"For list pagination. The maximum number of results per page, or items to return in a paginated List call." }, "SortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName", "status" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "TaskKeyQueryParam":{ "name":"taskKey", "in":"query", "type":"string", "x-default-description":"null", "description":"The field to filter based on task key." }, "JobKeyQueryParam":{ "name":"jobKey", "in":"query", "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi", "required":false, "x-default-description":"null", "description":"The field to filter based on job key." }, "JobTagQueryParam":{ "name":"jobTag", "in":"query", "description":"Indicates tag to filter the job on.", "type":"string", "required":false, "x-default-description":"If no value is provided for tag, only the jobs without the SYSTEM tag are returned." }, "JobKeyQueryMandateParam":{ "name":"jobKey", "in":"query", "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi", "required":true, "x-default-description":"null", "description":"The field to filter based on job key." }, "JobRunKeyQueryParam":{ "name":"jobRunKey", "in":"query", "type":"string", "required":true, "x-default-description":"null", "description":"The field to filter based on job run key." }, "ParentJobRunKeyQueryParam":{ "name":"parentJobRunKey", "in":"query", "type":"string", "x-default-description":"null", "description":"The field to filter based on parent job run key." }, "RootJobRunKeyQueryParam":{ "name":"rootJobRunKey", "in":"query", "type":"string", "x-default-description":"null", "description":"The field to filter based on root job run key." }, "StateQueryParam":{ "name":"status", "in":"query", "type":"array", "items":{ "type":"string", "enum":[ "PENDING", "RUNNING", "SKIPPED", "INTERNAL_ERROR", "BLOCKED", "SUCCESS", "FAILED", "CANCELED", "UPSTREAM_CANCELED", "UPSTREAM_FAILED", "EXCLUDED" ] }, "x-default-description":"null", "description":"The field to filter based on state." }, "JobDefinitionPathQueryParam":{ "name":"path", "in":"query", "type":"string", "required":false, "description":"The fully qualified path where the job is stored.", "x-default-description":"If no job definition path is specified, then all Objects are considered irrespective of the location where the job definition is stored." }, "NestedPathLookupQueryParam":{ "name":"isNestedPathLookup", "in":"query", "type":"boolean", "default":false, "required":false, "description":"If the nestedPathLookup query param is set to true, based on the path query param value, the response will contain all the jobs that are residing in the current folder and its child folders.", "x-default-description":"If no value is provided for isNestedPathLookup and the path query param value is provided, then the response will contain only the jobs residing in the folder mentioned in the path query param." }, "CreatedByQueryParam":{ "description":"A filter to return only resources that are created by given user with username that matches exactly.", "in":"query", "name":"createdBy", "type":"string", "required":false, "x-default-description":"If no CreatedByQueryParam is specified, then all Objects are considered irrespective of the username of the creator" }, "UpdatedByQueryParam":{ "description":"A filter to return only resources that was last updated by given user with username that matches exactly.", "in":"query", "name":"updatedBy", "type":"string", "required":false, "x-default-description":"If no UpdatedByQueryParam is specified, then all Objects are considered irrespective of the updator username of the job" }, "TimeCreatedGreaterThanOrEqualToQueryParam":{ "name":"timeCreatedGreaterThanOrEqualTo", "format":"date-time", "type":"string", "in":"query", "description":"Fetch objects from repository that were created after or at the exact timestamp provided in parameter", "x-default-description":"Fetch objects that were created after or at the exact timestamp provided in parameter." }, "TimeCreatedLessThanOrEqualToQueryParam":{ "name":"timeCreatedLessThanOrEqualTo", "format":"date-time", "type":"string", "in":"query", "description":"Fetch objects from repository that were created before or at the exact timestamp provided in parameter.", "x-default-description":"Fetch objects that were created before or at the exact timestamp provided in parameter." }, "RecordCountQueryParam":{ "name":"recordCount", "in":"query", "type":"integer", "minimum":1, "maximum":10, "default":5, "description":"The number of records to fetch.", "x-default-description":"The number of records to fetch." }, "JobPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order." }, "ClusterKeyPathParam":{ "name":"clusterKey", "type":"string", "in":"path", "required":true, "description":"Cluster key." }, "ClusterTypeQueryParam":{ "name":"type", "in":"query", "required":false, "type":"string", "description":"Cluster type. When the filter is not provided list shows all type of cluster - USER else it show only\ncluster of type chosen. Only clusters of type USER are attachable to a workspace notebook.\n", "x-obmcs-top-level-enum":"#/definitions/ClusterType", "x-default-description":"When no type filter is present - all the cluster are shown" }, "ClusterSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "ClusterPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "ClusterLibrarySortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "ClusterStateQueryParam":{ "name":"state", "in":"query", "required":false, "type":"string", "x-obmcs-enumref":"#/definitions/Cluster/state", "x-default-description":"null", "description":"A filter to return only resources that match the given lifecycle state. The state value is case-insensitive." }, "WorkspaceObjectPathQueryParam":{ "name":"path", "type":"string", "in":"query", "required":true, "description":"The file path of the workspace object." }, "ObjectKeyPathParam":{ "name":"objectKey", "type":"string", "in":"path", "required":true, "description":"The key of the workspace object." }, "ObjectPathParam":{ "name":"objectPath", "type":"string", "in":"path", "required":true, "description":"The fully qualified path of the workspace object." }, "ObjectDescriptionParam":{ "name":"objectDescription", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"The description of the workspace object" }, "IncludeMetadataQueryParam":{ "in":"query", "name":"shouldIncludeMetadata", "required":false, "default":false, "type":"boolean", "description":"Path to list all metadata for a file or folder." }, "WorkspaceObjectKeyQueryParam":{ "name":"objectKey", "type":"string", "in":"query", "x-default-description":"null", "description":"The key of the workspace object." }, "WorkspaceObjectTypeQueryParam":{ "name":"type", "type":"string", "in":"query", "x-default-description":"null", "description":"Filter by object type. For example, NOTEBOOK, LIBRARY, or FILE." }, "FileMetadataKeysQueryParam":{ "name":"metadataKeys", "in":"query", "required":false, "x-default-description":"null", "type":"string", "description":"Comma separated keys to have in list response." }, "WorkspaceObjectSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "WorkspaceObjectPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "TypeHeader":{ "in":"header", "maxLength":255, "minLength":1, "name":"type", "type":"string", "x-default-description":"null", "description":"The type of workspace object." }, "WorkspaceObjectKeyHeader":{ "in":"header", "maxLength":255, "minLength":1, "name":"type", "type":"string", "x-default-description":"null", "description":"The key of workspace object." }, "KernelIdentifierPathParam":{ "name":"kernelId", "required":true, "in":"path", "description":"UUID of the running kernel for which details is requested.", "type":"string" }, "SessionIdentifierPathParam":{ "name":"sessionId", "description":"The ID of the Data Lake Notebook Session", "type":"string", "in":"path", "required":true }, "ContentPathPathParam":{ "name":"contentPath", "description":"The path to the notebook file.", "type":"string", "in":"path", "required":true }, "ContentTypeQueryParam":{ "name":"type", "description":"Content type. Either file, directory, or notebook.", "in":"query", "type":"string", "x-default-description":"null", "enum":[ "file", "directory", "notebook" ] }, "ContentFormatQueryParam":{ "name":"format", "description":"The format in which content should be returned. Either text, base64, or JSON.", "in":"query", "type":"string", "x-default-description":"null", "enum":[ "text", "base64", "json" ] }, "DataLakeTenantIdHeader":{ "description":"The tenant ID header.", "name":"datalake-tenant-id", "required":false, "type":"string", "in":"header", "x-default-description":"Optional request header with string tenant ID.\n" }, "ContentHashQueryParam":{ "name":"hash", "description":"Returns hash hexdigest string of content and the hash algorithm. 0 for no hash, 1 for return hash. 0 is default. It may be ignored by the content manager.\n", "in":"query", "type":"integer", "default":0 }, "PermissionsQueryParam":{ "name":"permissions", "type":"string", "required":false, "x-default-description":"null", "in":"query", "description":"JSON-serialized dictionary of `{\"resource\": [\"action\",]}`\n(dict of lists of strings) to check.\nThe same dictionary structure will be returned,\ncontaining only the actions for which the user is authorized.\n" }, "IncludeContentQueryParam":{ "name":"content", "description":"Returns content based on param value. When set to 0, content is NOT returned. When set to 1, content is returned.\n", "in":"query", "type":"integer", "default":1 }, "ClusterIdentifierQueryParam":{ "name":"cluster_id", "description":"Cluster ID attached to a session.", "in":"query", "type":"string", "required":false }, "NotebookPathIdentifierQueryParam":{ "name":"path", "description":"Notebook file path attached to a session.", "in":"query", "type":"string", "required":false, "x-default-description":"null" }, "AgentFlowIdentifierQueryParam":{ "name":"agentFlowKey", "description":"Agent flow key of the attached agent flow.", "in":"query", "type":"string", "required":false, "x-default-description":"null" }, "TenantIdQueryParam":{ "name":"tenantId", "in":"query", "required":false, "type":"string", "description":"The ID of the tenant to filter the domains." }, "DomainIdentifierQueryParam":{ "name":"domainIdentifier", "in":"query", "required":false, "x-default-description":"null", "type":"string", "description":"Can be either domain ID or domain URL." }, "IsRecentlyLoggedQueryParam":{ "name":"isRecentlyLogged", "in":"query", "required":false, "type":"boolean", "x-default-description":"null", "description":"Filters the list of users based on their recent login activity:\n - When `isRecentlyLogged` is `true`, the API lists users who have logged in recently\n - When `isRecentlyLogged` is `false`, the API list all users of the Tenancy\nThis parameter is optional. If omitted, the default behavior applies based on other query parameters.\n" }, "UsernameContainsQueryParam":{ "name":"usernameContains", "in":"query", "required":false, "type":"string", "x-default-description":"null", "description":"Filter users by username containing this string." }, "GroupNameContainsQueryParam":{ "name":"groupNameContains", "in":"query", "required":false, "type":"string", "x-default-description":"null", "description":"Filter groups by group name containing this string." }, "FeatureNamesQueryParam":{ "name":"featureNames", "in":"query", "description":"List of feature names to retrieve statuses for (comma-separated).", "required":true, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi" }, "IdentityDomainLifecycleStateQueryParam":{ "name":"domainLifecycle", "type":"string", "in":"query", "required":false, "description":"The state of the identity domain.", "enum":[ "CREATING", "ACTIVE", "DELETING", "INACTIVE" ], "x-default-description":"By default, domain in any state will be fetched." }, "FeatureNamePathParam":{ "name":"featureName", "in":"path", "required":true, "description":"The name of the feature to retrieve the status for.\nSupported values:\n- `IDENTITY_DOMAINS`: Represents cross-service features related to identity domains.\n - Internally maps to:\n - `serviceName`: console_identity_whitelist\n - `internalFeatureName`: multi-identity-domains\n- `CLUSTER_AUTOSCALE`: To support cluster autoscale feature based on whitelisted user tenancies\n - In the limits this maps to:\n - `groupName`: sss-dev-limits for dev and dataflow-prod for prod/pre-prod\n - `property`: compute-cluster-auto-scale-enabled\n- `CLUSTER_FAST_STARTUP`: To support cluster fast startup based on warm pool\n - In the limits this maps to:\n - `groupName`: sss-dev-limits for dev and dataflow-prod for prod/pre-prod; sss-test-limits::IAD-Test regions\n - `property`: compute-cluster-faster-startup-enabled\n- `CLUSTER_SCALA_SUPPORT_ENABLED`: To support cluster fast startup based on warm pool\n - In the limits this maps to:\n - `groupName`: sss-dev-limits for dev and dataflow-prod for prod/pre-prod; sss-test-limits::IAD-Test regions\n - `property`: aidp-scala-support-enabled\n- `AIDP_LINEAGE_ENABLED`: To support AIDP lineage capability based on datalake limits\n - In the limits this maps to:\n - `groupName`: datalake environment-specific group (`datalake-` or `datalake-dev` fallback)\n - `property`: is-aidp-lineage-enabled\n- `IS_DENY_DOWNLOAD`: To expose deny-download status based on datalake limits\n - In the limits this maps to:\n - `groupName`: datalake environment-specific group (`datalake-` or `datalake-dev` fallback)\n - `property`: is-deny-download\n- `STREAMING_TASK_EXTENDED_RETRIES_ENABLED`: To expose the streaming task extended retries feature flag via wrapper featureStatus APIs\n - In the limits this maps to:\n - `groupName`: datalake environment-specific group (`datalake-` or `datalake-dev` fallback)\n - `property`: streaming-task-extended-retries-enabled\n", "type":"string", "enum":[ "IDENTITY_DOMAINS", "CLUSTER_AUTOSCALE", "CLUSTER_FAST_STARTUP", "CODE_ASSIST_ENABLED", "AIDP_LINEAGE_ENABLED", "IS_DENY_DOWNLOAD", "AI_DATA_PLATFORM_RELEASED", "AI_HIGH_CODE_ENABLED", "CONSOLE_WL_AI_FEATURES_ENABLED", "CLUSTER_SCALA_SUPPORT_ENABLED", "ML_OPS_ENABLED", "STREAMING_TASK_EXTENDED_RETRIES_ENABLED", "BUNDLES_ENABLED", "GIT_FEATURE_ENABLED" ] }, "MasterCatalogKeyPathParam":{ "name":"masterCatalogKey", "type":"string", "in":"path", "required":true, "description":"The key of the Master Catalog" }, "MasterCatalogSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "MasterCatalogPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "CatalogKeyPathParam":{ "name":"catalogKey", "type":"string", "in":"path", "required":true, "description":"The key of the catalog." }, "IsCatalogGuidQueryParam":{ "name":"isCatalogGuid", "in":"query", "required":false, "type":"boolean", "default":false, "description":"A boolean which decides if catalogKey path parameter is catalog GUID (UUID) or name." }, "CatalogTypeQueryParam":{ "name":"catalogType", "type":"string", "in":"query", "required":false, "description":"The type of the catalog.", "enum":[ "INTERNAL", "EXTERNAL" ], "x-default-description":"By default, both internal and external catalogs will be fetched." }, "CatalogKeyQueryParam":{ "name":"catalogKey", "type":"string", "in":"query", "required":true, "x-default-description":"null", "description":"The key of the catalog." }, "CatalogKeyOptionalQueryParam":{ "name":"catalogKey", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"The key of the catalog." }, "CatalogSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for timeCreated\nis descending. Default order for displayName is ascending.\n" }, "CatalogPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for timeCreated\nis descending. Default order for displayName is ascending.\n" }, "CatalogStateQueryParam":{ "name":"catalogState", "type":"string", "in":"query", "required":false, "description":"The state of the catalog.", "enum":[ "ACTIVE", "CREATING", "DELETING" ], "x-default-description":"By default, catalogs in any state are fetched." }, "BucketsSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "bucketName" ], "default":"bucketName", "description":"The field to sort by. You can provide only one sort order. Default order for bucketName\nis descending. Default order for displayName is ascending.\n" }, "ServiceIdentifierQueryParam":{ "name":"serviceIdentifier", "type":"string", "in":"query", "required":true, "description":"The identifier used to lookup service specific responses.", "enum":[ "META_STORE", "VOLUME_SERVICE", "ALL" ] }, "VolumeKeyPathParam":{ "name":"volumeKey", "type":"string", "in":"path", "required":true, "description":"The key of the volume." }, "FileKeyPathParam":{ "name":"fileKey", "type":"string", "in":"path", "required":true, "description":"The key of the file in volume." }, "VolumeKeyQueryParam":{ "name":"volumeKey", "type":"string", "in":"query", "x-default-description":"null", "description":"The key of the volume." }, "DescriptionQueryParam":{ "name":"description", "type":"string", "in":"query", "x-default-description":"null", "description":"The description of the folder." }, "VolumeSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "VolumeFileSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "VolumePermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "IsListRecursiveQueryParam":{ "name":"isRecursive", "in":"query", "required":false, "type":"boolean", "default":false, "description":"A boolean which decides if nested files should be in the list files in volume response." }, "SchemaKeyPathParam":{ "name":"schemaKey", "type":"string", "in":"path", "required":true, "description":"The fully qualified name of the schema in the format .." }, "TableKeyPathParam":{ "name":"tableKey", "type":"string", "in":"path", "required":true, "description":"The fully qualified name of the table in the format ..." }, "ViewKeyPathParam":{ "name":"viewKey", "type":"string", "in":"path", "required":true, "description":"The fully qualified name of the view in the format ..." }, "SchemaSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "TableSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "ViewSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "SchemaPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "TablePermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "ViewPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "ListRolePermissionScopeQueryParam":{ "in":"query", "name":"permissionScope", "x-obmcs-top-level-enum":"#/definitions/ListRolePermissionScopeType", "required":false, "type":"string", "x-default-description":"ALL", "enum":[ "DIRECT", "INHERITED", "ALL" ], "description":"The scope of role permissions to be returned. Defaults to ALL" }, "GetRoleScopeTypeQueryParam":{ "in":"query", "name":"roleScope", "x-obmcs-top-level-enum":"#/definitions/GetRoleScopeType", "required":false, "type":"string", "x-default-description":"USER", "enum":[ "USER", "ADMIN", "MEMBER_OF" ], "description":"The scope of roles to be returned. Defaults to USER." }, "RoleKeyPathParam":{ "name":"roleKey", "in":"path", "type":"string", "minLength":1, "maxLength":255, "required":true, "description":"The unique key of the Role." }, "RoleDisplayNameQueryParam":{ "name":"roleDisplayName", "in":"query", "type":"string", "minLength":1, "maxLength":255, "required":false, "x-default-description":false, "description":"The name of the Role." }, "RoleLifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"string", "x-obmcs-enumref":"#/definitions/Role/lifecycleState", "x-default-description":"null", "description":"A filter to return only resources that match the given lifecycle state. The\nstate value is case-insensitive.\n" }, "RoleSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "RecipientSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "ShareSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "RecipientPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "grantee" ], "default":"grantee", "description":"The field to sort by. Default order for `grantee` is ascending. \n" }, "RecipientKeyPathParam":{ "name":"recipientKey", "type":"string", "in":"path", "required":true, "description":"The key of the recipient resource" }, "ShareKeyPathParam":{ "name":"shareKey", "in":"path", "type":"string", "minLength":1, "maxLength":255, "required":true, "description":"The unique key of the Share." }, "SharePermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "grantee", "granteeType" ], "default":"grantee", "description":"The field to sort by. You can provide only one sort order. Default order for `grantee`\nis ascending. Default order for `granteeType` is ascending.\n" }, "ModelIdKeyPathParam":{ "name":"modelId", "in":"path", "type":"string", "minLength":1, "maxLength":255, "required":true, "description":"The unique key of the Model." }, "RegionIdQueryParam":{ "name":"regionId", "in":"query", "type":"string", "minLength":1, "maxLength":255, "required":false, "x-default-description":false, "description":"The name of the region where the model resides." }, "ModelLifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"string", "x-obmcs-enumref":"#/definitions/Model/lifecycleState", "x-default-description":"null", "description":"A filter to return only resources that match the given lifecycle state. \nThe state value is case-insensitive.\n" }, "ModelSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "ModelTypeQueryParam":{ "name":"modelType", "type":"string", "in":"query", "required":true, "description":"The type of the Model", "enum":[ "GEN_AI" ], "x-default-description":"fetch based on the modelType" }, "AiModelCapabilitiesQueryParam":{ "name":"aiModelCapabilities", "in":"query", "required":false, "maxItems":100, "type":"array", "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/AiModelCapabilitiesEnum", "enum":[ "FINE_TUNE", "CHAT", "TEXT_EMBEDDINGS" ] }, "description":"Optional parameter to filter based on model capabilities. Accepts multiple values.", "x-default-description":"Parameter is optional; if omitted, all capabilities will be included" }, "EndpointIdentifierQueryParam":{ "name":"id", "type":"string", "in":"query", "x-default-description":"null", "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the endpoint." }, "EndpointLifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "type":"string", "enum":[ "ACTIVE", "CREATING", "UPDATING", "DELETING", "DELETED", "FAILED" ], "x-default-description":"null", "description":"A filter to return only resources that their lifecycle state matches the given lifecycle state." }, "EndpointSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "displayName", "timeCreated" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "ToolKeyPathParam":{ "name":"toolKey", "type":"string", "in":"path", "required":true, "description":"The unique identifier of the Tool" }, "ToolSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "ToolPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "GitRepositoryKeyPathParam":{ "name":"gitRepositoryKey", "type":"string", "in":"path", "required":true, "description":"The Git repository key." }, "FolderPathQueryParam":{ "name":"gitFolderPath", "type":"string", "in":"query", "required":true, "description":"The Git folder path." }, "GitFolderPathQueryParam":{ "name":"folderPath", "type":"string", "in":"query", "required":true, "description":"The Git file/folder path for which metadata is needed." }, "GitFolderResourceTypeQueryParam":{ "name":"resourceType", "type":"string", "enum":[ "file", "folder" ], "in":"query", "required":true, "description":"The Git file or folder resource type." }, "GitSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "IncludeCredKeyQueryParam":{ "in":"query", "name":"shouldIncludeCredentialKey", "type":"boolean", "x-default-description":"false", "description":"A flag to include credential key in response. If 'true', credential key will be returned in response. Default 'false'." }, "DisplayNamePathParam":{ "name":"displayName", "type":"string", "in":"path", "required":true, "description":"The displayName of the credentialV2 object whose details are to be retrieved." }, "CredentialV2SecretKeyQueryParam":{ "name":"secretKey", "type":"string", "in":"query", "required":false, "description":"The identifier of the Secret object inside credentialV2 object whose details are to be retrieved.", "x-default-description":"By default, entire secret map is returned when this value is not supplied." }, "CredentialV2KeyPathParam":{ "name":"credentialV2Key", "type":"string", "in":"path", "required":true, "description":"The unique identifier of the credentialV2 object whose credential details are to be retrieved." }, "CredentialV2LifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialV2LifeCycleState", "x-default-description":"null", "description":"A filter to return only resources their lifecycleState matches the given lifecycleState." }, "CredentialV2DisplayNameContainsQueryParam":{ "name":"displayNameContains", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"A filter to return only resources whose displayName contains the provided value (case-insensitive)." }, "CredentialV2SortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "name" ], "default":"timeCreated", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" }, "CredentialPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.\n" }, "CredentialTypeQueryParam":{ "name":"credentialType", "type":"string", "in":"query", "required":false, "description":"The type of the Credential", "x-obmcs-top-level-enum":"#/definitions/CredentialType", "enum":[ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ], "x-default-description":"By default, all credential types will be fetched" }, "CredentialKeyPathParam":{ "name":"credentialKey", "type":"string", "in":"path", "required":true, "description":"The unique identifier of the credential object whose details are to be retrieved." }, "CredentialDisplayNameContainsQueryParam":{ "name":"displayNameContains", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"A filter to return only resources whose displayName contains the provided value (case-insensitive)." }, "CredentialLifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"string", "x-obmcs-top-level-enum":"#/definitions/CredentialLifecycleState", "x-default-description":"null", "description":"A filter to return only resources whose lifecycleState matches the provided value." }, "CredentialSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "name" ], "default":"timeCreated", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" }, "AgentFlowKeyPathParam":{ "name":"agentFlowKey", "type":"string", "in":"path", "required":true, "description":"The UUID of the Agent Flow" }, "AgentFlowNodeKeyPathParam":{ "name":"nodeKey", "type":"string", "in":"path", "required":true, "description":"The UUID of the Agent Flow Node" }, "AgentFlowEdgeKeyPathParam":{ "name":"edgeKey", "type":"string", "in":"path", "required":true, "description":"The UUID of the Agent Flow Edge" }, "AgentFlowSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "AgentFlowPermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "GuardrailsSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "displayName" ], "default":"displayName", "description":"The field to sort by. You can provide only one sort order. Default order for `displayName` is ascending." }, "FetchAllQueryParam":{ "name":"fetchAll", "type":"string", "in":"query", "required":false, "default":"false", "x-default-description":"null", "description":"Parameter to fetch all node and edge details in GetDiagram API" }, "AgentFlowSessionKeyPathParam":{ "name":"agentFlowSessionKey", "type":"string", "in":"path", "required":true, "description":"The UUID of the Agent Flow Session" }, "AgentFlowDeploymentKeyPathParam":{ "name":"agentFlowDeploymentKey", "type":"string", "in":"path", "required":true, "description":"The UUID of the Agent Flow Deployment" }, "LifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"array", "items":{ "type":"string", "x-obmcs-top-level-enum":"#/definitions/DeploymentLifecycleState", "enum":[ "CREATING", "ACTIVE", "INACTIVE", "FAILED", "DELETED" ] }, "collectionFormat":"multi", "x-default-description":"null", "description":"A filter to return only resources whose value matches the given lifecycleState." }, "AgentFlowSessionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName", "lifecycleState" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "AgentFlowDeploymentSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "AgentFlowSessionTraceNameQueryParam":{ "in":"query", "maxLength":255, "minLength":1, "name":"name", "type":"string", "x-default-description":"null", "description":"A filter to return only resources that match the given display name exactly." }, "TraceKeyPathParam":{ "in":"path", "name":"traceKey", "type":"string", "required":true, "description":"A filter to return only resources that match the given display trace key exactly." }, "AgentFlowSessionTraceSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "name" ], "default":"name", "description":"The field to sort by. You can provide only one sort order. Default order for `name` is ascending." }, "ComputeKeyQueryParam":{ "name":"computeKey", "type":"string", "in":"query", "x-default-description":"null", "description":"Compute key." }, "AgentFlowKeyQueryParam":{ "name":"agentFlowKey", "type":"string", "in":"query", "x-default-description":"Agent flow key", "description":"Agent Flow key." }, "AgentFlowKeyRequiredQueryParam":{ "name":"agentFlowKey", "type":"string", "in":"query", "x-default-description":"Agent flow key", "required":true, "description":"Agent Flow key." }, "AgentFlowKeyListQueryParam":{ "name":"agentFlowKey", "in":"query", "type":"array", "items":{ "type":"string" }, "x-default-description":"List of Agent flow key", "description":"List of Agent Flow key." }, "AgentFlowSessionDeploymentTypeQueryParam":{ "name":"deploymentType", "in":"query", "type":"string", "enum":[ "TEST", "DEPLOYMENT" ], "default":"TEST", "description":"A filter to return only resources whose value matches the given deploymentType." }, "AgentFlowSessionDeploymentTypeRequiredQueryParam":{ "name":"deploymentType", "in":"query", "type":"string", "enum":[ "TEST", "DEPLOYMENT" ], "default":"TEST", "required":true, "description":"A parameter to specify the deploymentType for retrieving corresponding session details." }, "ComputeKeyListQueryParam":{ "name":"computeKey", "in":"query", "type":"array", "items":{ "type":"string" }, "x-default-description":"null", "description":"Compute key." }, "AgentFlowSessionMetricsStartTimeQueryParam":{ "name":"timeStarted", "in":"query", "type":"string", "format":"date-time", "required":true, "description":"The start time for retrieving metrics" }, "AgentFlowSessionMetricsEndTimeQueryParam":{ "name":"timeEnded", "in":"query", "type":"string", "format":"date-time", "required":true, "description":"The end time for retrieving metrics" }, "AgentFlowSessionMetricsDeploymentTypeQueryParam":{ "name":"deploymentType", "in":"query", "type":"string", "enum":[ "TEST", "DEPLOYMENT" ], "default":"TEST", "description":"A filter to return only resources whose value matches the given deploymentType." }, "KnowledgeBaseKeyPathParam":{ "name":"knowledgeBaseKey", "type":"string", "in":"path", "required":true, "description":"The KB id for which KnowledgeBase details needs to be fetched." }, "KnowledgeBaseSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "name" ], "default":"timeCreated", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" }, "KnowledgeBaseJobSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "name" ], "default":"timeCreated", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n" }, "KnowledgeBaseJobKeyPathParam":{ "name":"knowledgeBaseJobKey", "in":"path", "required":true, "type":"string", "description":"The Job key for which details needs to be fetched." }, "KnowledgeBaseJobRunKeyPathParam":{ "name":"knowledgeBaseJobRunKey", "in":"path", "required":true, "type":"string", "description":"The Job run UUID to get information about a job run" }, "KnowledgeBaseLifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseLifecycleState", "x-default-description":"null", "description":"A filter to return only resources their lifecycleState matches the given lifecycleState." }, "KnowledgeBaseJobRunLifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "required":false, "type":"string", "x-obmcs-top-level-enum":"#/definitions/KnowledgeBaseJobRunLifecycleState", "x-default-description":"null", "description":"A filter to return only resources their lifecycleState matches the given lifecycleState." }, "KnowledgeBasePermissionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated`\nis descending. Default order for `displayName` is ascending.\n" }, "ListKnowledgeBaseJobRunTimeCreatedGreaterThanOrEqualToQueryParam":{ "name":"timeCreatedGreaterThanOrEqualTo", "format":"date-time", "type":"string", "in":"query", "description":"Fetch objects from repository that were created after or at the exact timestamp provided in parameter", "x-default-description":"Fetch objects that were created after or at the exact timestamp provided in parameter." }, "ListKnowledgeBaseJobRunTimeCreatedLessThanOrEqualToQueryParam":{ "name":"timeCreatedLessThanOrEqualTo", "format":"date-time", "type":"string", "in":"query", "description":"Fetch objects from repository that were created before or at the exact timestamp provided in parameter.", "x-default-description":"Fetch objects that were created before or at the exact timestamp provided in parameter." }, "Experiment_id":{ "name":"experiment_id", "type":"string", "in":"query", "required":true, "description":"The unique ID of the experiment to retrieve." }, "Experiment_name":{ "name":"experiment_name", "type":"string", "in":"query", "required":true, "description":"The name of the experiment to retrieve." }, "ExperimentRunIdQueryParam":{ "name":"run_id", "type":"string", "in":"query", "required":true, "description":"ID of the run to fetch." }, "ListArtifactsRunIdQueryParam":{ "name":"run_id", "type":"string", "in":"query", "required":true, "description":"ID of the run whose artifacts to list." }, "ListArtifactsPathQueryParam":{ "name":"path", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"Filter artifacts matching this path (a relative path from the root artifact directory)." }, "ListArtifactsPageTokenQueryParam":{ "name":"page_token", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"Token indicating the page of artifact results to fetch." }, "RegisteredModelNameQueryParam":{ "name":"name", "type":"string", "in":"query", "required":true, "description":"Name of the registered model." }, "ListRegisteredModelsFilterQueryParam":{ "name":"filter", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"String filter condition, like \"name LIKE 'my-model-name'\". Interpreted in the backend \nautomatically as \"name LIKE '%my-model-name%'\". Single boolean condition, with string \nvalues wrapped in single quotes.\n" }, "ListRegisteredModelsMaxResultsQueryParam":{ "name":"max_results", "type":"integer", "format":"int64", "in":"query", "required":false, "x-default-description":"null", "description":"Maximum number of models desired. Default is 100. Max threshold is 1000." }, "ListRegisteredModelsPageTokenQueryParam":{ "name":"page_token", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"Pagination token to go to the next page based on a previous search query." }, "ListRegisteredModelsOrderByQueryParam":{ "name":"order_by", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"List of columns for ordering search results, which can include model name and last updated \ntimestamp with an optional \"DESC\" or \"ASC\" annotation, where \"ASC\" is the default. \nTiebreaks are done by model name ASC.\n" }, "ModelVersionNameQueryParam":{ "name":"name", "type":"string", "in":"query", "required":true, "description":"Name of the model version." }, "ModelVersionNumberQueryParam":{ "name":"version", "type":"string", "in":"query", "required":true, "description":"Version number of the model version." }, "ListModelVersionsFilterQueryParam":{ "name":"filter", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"String filter condition, like \"name LIKE 'my-model-name'\". Single boolean condition, with string \nvalues wrapped in single quotes.\n" }, "ListModelVersionsMaxResultsQueryParam":{ "name":"max_results", "type":"integer", "format":"int64", "in":"query", "required":false, "x-default-description":"null", "description":"Maximum number of model versions to retrieve." }, "ListModelVersionsPageTokenQueryParam":{ "name":"page_token", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"Pagination token to go to the next page based on a previous search query." }, "ListModelVersionsOrderByQueryParam":{ "name":"order_by", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"List of columns to be ordered by including model name, version, stage with an optional \"DESC\" or \"ASC\" \nannotation, where \"ASC\" is the default. Tiebreaks are done by latest stage transition timestamp, \nfollowed by name ASC, followed by version DESC.\n" }, "GetExperimentRunMetricHistoryRunIdQueryParam":{ "name":"run_id", "type":"string", "in":"query", "required":true, "description":"ID of the run metric history to fetch." }, "GetExperimentRunMetricHistoryPageTokenQueryParam":{ "name":"page_token", "type":"string", "in":"query", "required":false, "x-default-description":"null", "description":"Pagination token to go to the next page of metric history." }, "GetExperimentRunMetricHistoryMaxResultsQueryParam":{ "name":"max_results", "type":"integer", "format":"int32", "in":"query", "required":false, "x-default-description":"null", "description":"Maximum number of logged instances of a metric for a run to return per call. Backend servers \nmay restrict the value of max_results depending on performance requirements. Requests that do \nnot specify this value will behave as non-paginated queries where all metric history values \nfor a given metric within a run are returned in a single response.\n" }, "GetExperimentRunMetricHistoryMetricKeyQueryParam":{ "name":"metric_key", "type":"string", "in":"query", "required":true, "description":"Name of the metric key." }, "BundleKeyPathParam":{ "name":"bundleKey", "in":"path", "type":"string", "required":true, "description":"The unique key of the Bundle within a Workspace.\n" }, "BundlePathQueryParam":{ "name":"path", "in":"query", "type":"string", "required":true, "description":"Target bundle root path in Workspace volume." }, "SettingKeyPathParam":{ "name":"settingKey", "type":"string", "in":"path", "required":true, "description":"The UUID of the user setting." }, "SettingTypeQueryParam":{ "name":"settingType", "in":"query", "type":"string", "enum":[ "IAM_USER_CREDENTIAL", "GIT_ACCOUNT" ], "description":"A filter to return only those settings whose value matches the given data type.", "default":false }, "AdminSettingTypeQueryParam":{ "name":"settingType", "in":"query", "type":"string", "enum":[ "OAUTH" ], "description":"A filter to return only those admin settings whose value matches the given data type.", "default":false }, "SettingSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "timeCreated", "displayName" ], "default":"timeCreated", "description":"The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending." }, "IsDefaultQueryParam":{ "name":"isDefault", "in":"query", "type":"boolean", "default":false, "description":"A filter to return only resources that are default." } }, "responses":{ "400":{ "description":"Bad Request (invalid query parameters, malformed headers, and so on).", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "401":{ "description":"Unauthorized (missing or expired credentials, and so on).", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "404":{ "description":"Not Found. The requested resource was not found.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "405":{ "description":"Method Not Allowed. Request is recognized but not supported.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "409":{ "description":"Conflict. Request conflicts with the current state of the resource.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "412":{ "description":"Precondition Failed (One or more conditions in request failed).", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "429":{ "description":"Too Many Requests. Too many requests sent to the server in a short period.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "500":{ "description":"Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "501":{ "description":"Not implemented. This request method is not supported or cannot be processed.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } }, "default":{ "description":"Unknown Error. Error is not recognized by the system.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.", "type":"string" } }, "schema":{ "$ref":"#/definitions/Error" } } }, "tags":[ { "name":"Audit", "description":"The operations from the Audit category." }, { "name":"Bundle", "description":"The operations from the Bundle category." }, { "name":"Catalog", "description":"The operations from the Catalog category." }, { "name":"Cluster", "description":"The operations from the Cluster category." }, { "name":"DeltaShare", "description":"The operations from the DeltaShare category." }, { "name":"GitService", "description":"The operations from the GitService category." }, { "name":"MLOps", "description":"The operations from the MLOps category." }, { "name":"Notebook", "description":"The operations from the Notebook category." }, { "name":"Role", "description":"The operations from the Role category." }, { "name":"Schema", "description":"The operations from the Schema category." }, { "name":"UserSetting", "description":"The operations from the UserSetting category." }, { "name":"Volume", "description":"The operations from the Volume category." }, { "name":"Workflow", "description":"The operations from the Workflow category." }, { "name":"Workspace", "description":"The operations from the Workspace category." }, { "name":"WorkspaceObject", "description":"The operations from the WorkspaceObject category." }, { "name":"Wrapper", "description":"The operations from the Wrapper category." }, { "name":"credentialStore", "description":"The operations from the credentialStore category." } ] }