Querying Case Studies

Function

This API is used by the tenant-side frontend to retrieve a list of notebook cases. This API is designed for scenarios where you need to view or learn from notebook examples by fetching a case study list. To use this API, you must be logged in and have the necessary viewing permissions. Upon completion of the query, the API returns a list of case studies, including information such as case names, descriptions, and relevant tags. If you lack permissions or an error occurs during the query process, the API will return the corresponding error message.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v1/{project_id}/notebooks/practices

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: User project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A. Default Value: N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Maximum number of records returned per page. Constraints: N/A. Range: [1, 100]. Default Value: 10.
offset	No	Integer	Definition: Offset where a query starts. Constraints: N/A. Range: [0, 1000000000]. Default Value: 0.
practice_id	No	String	Definition: ID of the case. Constraints: The case ID is a UUID and must meet the regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$. Range: N/A. Default value: N/A.
sort_key	No	String	Definition: Sorting field. Separate multiple fields with commas (,). Constraints: N/A Range: The value can contain at most 128 characters. Only letters, digits, hyphens (-), underscores (_), and commas (,) are allowed. Default Value: N/A
sort_dir	No	String	Definition: Instance sorting mode. Constraints: N/A Range: The value can be: ASC: Ascending order DESC: Descending order Default Value: DESC

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	Yes	String	Definition: Language environment for the current API call. Constraints: This request header is mandatory only for APIs that depend on internationalization information. Range: N/A. Default Value: N/A.
X-Auth-Token	Yes	String	Definition: User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints: N/A. Range: N/A. Default Value: N/A.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
data	Array of data objects	Definition: Case data.

**Table 5** data
Parameter	Type	Description
image_id	String	Definition: Image ID recommended for the case. Range: N/A.
practice_id	String	Definition: Case ID. Range: N/A.
shared_url	String	Definition: URL (Base64-encoded) of the IPYNB file used by the case in an OBS bucket. Range: N/A.
status	String	Definition: Case enabling status. Range: N/A.
title	String	Definition: Case title. Range: N/A.