REST API for Oracle AI Data Platform Workbench

(Preview) List experiments

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/mlops/api/2.0/mlflow/experiments/search

(Preview) Returns a list of experiments with the given details.

Request

Path Parameters

aiDataPlatformId(required): string

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

The key of the Workspace

Header Parameters

dh-user-principal: string

The DH User Principal Header .
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.

Details of experiments to fetch.

Root Schema : ListExperimentsDetails

Type: object

Details of experiments to fetch.

Show Source

filter: string

A filter expression over experiment attributes and tags that allows returning a subset of experiments. The syntax is a subset of SQL that supports ANDing together binary operations between an attribute or tag and a constant. Example: name LIKE 'test-%' AND tags.key = 'value' Columns with special characters (hyphen, space, period, etc.) can be selected using double quotes or backticks. Example: tags."extra-key" = 'value' or tags.`extra-key` = 'value' Supported operators are =, !=, LIKE, and ILIKE.
max_results: integer(int64)

Maximum number of experiments desired. Servers may select a default. All servers are guaranteed to support a max_results threshold of at least 1,000 but may support more. Callers are encouraged to pass max_results explicitly and leverage page_token to iterate.
order_by: array order_by

List of columns for ordering search results, which can include experiment name and ID with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Tiebreaks are done by experiment ID DESC.
page_token: string

Token indicating the page of experiments to fetch.
view_type: string

Allowed Values: [ "ACTIVE_ONLY", "DELETED_ONLY", "ALL" ]

Qualifier for type of experiments to be returned. If unspecified, returns only active experiments.

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

Nested Schema : order_by

Type: array

List of columns for ordering search results, which can include experiment name and ID with an optional "DESC" or "ASC" annotation, where "ASC" is the default. Tiebreaks are done by experiment ID DESC.

Show Source

Array of: string

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

Response

Supported Media Types

application/json

200 Response

Successful operation. List of experiments is retrieved.

Headers

opc-next-page: string

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.
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.

Root Schema : ExperimentCollection

Type: object

Result of listing experiments.

Show Source

experiments(required): array experiments

Experiments that match the search criteria.
next_page_token: string

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

Nested Schema : experiments

Type: array

Experiments that match the search criteria.

Show Source

Array of: object Experiment

Details of an MLflow experiment.

{
    "description":"Experiments that match the search criteria.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Experiment"
    }
}

Nested Schema : Experiment

Type: object

Details of an MLflow experiment.

Show Source

artifact_location: string

Location where all artifacts for the experiment are stored. If not provided, the remote server will select an appropriate default.
creation_time: integer(int64)

Unix timestamp in milliseconds when the experiment was created.
experiment_id(required): string

Unique identifier for the experiment.
last_update_time: integer(int64)

Unix timestamp in milliseconds when the experiment was last updated.
lifecycle_stage: string

Lifecycle stage of the experiment, e.g., 'active' or 'deleted'.
name(required): string

Name of the experiment.
tags: array tags

List of tags set on the 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"
            }
        }
    }
}

Nested Schema : tags

Type: array

List of tags set on the experiment.

Show Source

Array of: object ExperimentTag

A tag associated with an experiment.

{
    "type":"array",
    "description":"List of tags set on the experiment.",
    "items":{
        "$ref":"#/definitions/ExperimentTag"
    }
}

Nested Schema : ExperimentTag

Type: object

A tag associated with an experiment.

Show Source

key(required): string

Key of the experiment tag.
value: string

Value of the experiment tag.

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

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.

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.

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.

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.

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.

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.

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