Jump to

• Request
• Response

Patch a session

patch

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/notebook/api/sessions/{sessionId}

Patches a session with a given ID with the provided details. You can use this to rename a session.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• sessionId(required): string
  The ID of the Data Lake Notebook Session
• workspaceKey(required): string
  The key of the Workspace

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• 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.

Body ()

Details to patch for an existing session.

Root Schema : PatchSessionDetails

Type: object

Details to update a session.

Show Source

• cluster_id: string
  Cluster ID.
• id: string
  UUID of the session.
• kernel: object Kernel
  Notebook kernel information.
• must_refresh_context: boolean
  Default Value: false

  Set as True, if a new execution context is needed.
• name: string
  A user-friendly name for the session.
• path: string
  Path to the session. A directory where notebook server is started and where notebooks are saved. For example, /data/test.ipynb.
• type: string
  Type of session.

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

Nested Schema : Kernel

Type: object

Notebook kernel information.

Show Source

• connections: integer
  The number of active connections to this kernel.
• execution_state: string
  Allowed Values: [ "unknown", "starting", "idle", "busy", "terminating", "restarting", "autorestarting", "dead" ]

  Current execution state of Kernel (typically 'idle' or 'busy', but may be other values, such as 'starting'). Added in notebook server 5.0.
• id(required): string
  UUID of kernel.
• last_activity: string
  ISO 8601 timestamp for last-seen activity on this kernel. Use this in combination with execution_state == 'idle' to identify which kernels have been idle since a given time. Timestamps will be UTC, indicated 'Z' suffix.
• name: string
  Kernel spec name. (Example python3)

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Session is patched.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : Session

Type: object

Notebook Session describes the Session context for a running instance of a Notebook. Each opened Notebook has a separate Session, but different Notebook kernels can use same Session if user wants to share data across various opened Notebooks.

Show Source

• agentFlowKey: string
  Agent Flow Key of an agent flow.
• cluster_id: string
  Cluster ID.
• id(required): string
  UUID of the notebook session.
• kernel: object Kernel
  Notebook kernel information.
• lifecycleState: string
  Allowed Values: [ "CREATING", "ACTIVE", "FAILED" ]

  lifecycleState of a Notebook Session.
• name(required): string
  A user-friendly name for the notebook session.
• path: string
  Path to notebook session. For example, /data/test.ipynb
• type: string
  Allowed Values: [ "notebook", "file", "agentflow" ]

  Notebook session type.

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

Nested Schema : Kernel

Type: object

Notebook kernel information.

Show Source

• connections: integer
  The number of active connections to this kernel.
• execution_state: string
  Allowed Values: [ "unknown", "starting", "idle", "busy", "terminating", "restarting", "autorestarting", "dead" ]

  Current execution state of Kernel (typically 'idle' or 'busy', but may be other values, such as 'starting'). Added in notebook server 5.0.
• id(required): string
  UUID of kernel.
• last_activity: string
  ISO 8601 timestamp for last-seen activity on this kernel. Use this in combination with execution_state == 'idle' to identify which kernels have been idle since a given time. Timestamps will be UTC, indicated 'Z' suffix.
• name: string
  Kernel spec name. (Example python3)

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

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

409 Response

Conflict. Request conflicts with the current state of the resource.

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

412 Response

Precondition Failed (One or more conditions in request failed).

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