Jump to

• Request
• Response

Get a list of workspaces

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces

Gets a list of AI Data Platform Workbench workspaces.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.

Query Parameters

• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• displayNameContains: string
  A filter to return only resources that have a display name containing the text provided.
• isPrivateNetworkEnabled: boolean
  A flag to filter the workspaces which are private network enabled or disabled

  Default Value: false
• lifecycleState: string
  A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]
• type: string
  When no value is provided, all workspaces are returned. Otherwise, workspace of selected value is returned.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A page of workspace summary objects is retrieved.

Headers

• opc-next-page: string
  For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : WorkspaceCollection

Type: object

Results of a workspace search. Contains summary information of workspaces.

Show Source

• items(required): array items
  List of workspaces.

{
    "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"
            }
        }
    }
}

Nested Schema : items

Type: array

List of workspaces.

Show Source

• Array of: object WorkspaceSummary
  Summary information about a Workspace.

{
    "description":"List of workspaces.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkspaceSummary"
    }
}

Nested Schema : WorkspaceSummary

Type: object

Summary information about a Workspace.

Show Source

• aicUserSchemaName: string
  The name of the AIC user schema if created.
• createdBy: string
  OCID of the user who created this record.
• createdByName: string
  Name of the user who created this record.
• defaultCatalogKey: string
  The key of the catalog to be used as the default catalog for this workspace. A default catalog in the workspace will allow users to use that catalog without the need to refer it in the notebook. For example, if default catalog is iCat1, and it has schema1 and table1, you can refer to the table in a notebook using: schema1.table1.
• description: string
  Description of the workspace.
• displayName(required): string
  A user-friendly name that has to be unique in a AI Data Platform Workbench instance.
• isPrivateNetworkEnabled: boolean
  A flag to display whether workspace is private network enabled or not.
• key(required): string
  The key of the AI Data Platform Workbench workspace.
• lifecycleDetails: string
  A message that describes the current state of the workspace in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
• lifecycleState(required): string
  The current state of the AI Data Platform Workbench workspace.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
• timeCreated(required): string(date-time)
  The date and time the AI Data Platform Workbench workspace was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• timeUpdated: string(date-time)
  The date and time the AI Data Platform Workbench workspace was updated, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• type(required): string
  Allowed Values: [ "DEFAULT", "USER" ]

  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.
• updatedBy: string
  OCID of the user who updated this record.
• updatedByName: string
  Name of the user who updated this record.

{
    "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 <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\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 <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\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."
        }
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "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"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only the String type is supported.

{
    "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"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "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"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "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"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "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"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "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"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "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"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "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"
        }
    }
}

Back to Top