Obtaining the List of Specified Metadata Categories_Function Flows_APIs_API Reference

Function

This API is used to obtain the list of specified metadata categories.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/ffs/metadata/categories

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A. Range The value contains 32 characters. Only letters and digits are allowed. Default Value N/A.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
locale	No	String	locale

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
categories	Object	Metadata element.

**Table 4** CategoriesItem
Parameter	Type	Description
type	String	Type.
display	String	Display name.
parent	String	Parent directory.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
request_id	String	Request ID.

Status code: 500

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
request_id	String	Request ID.

Example Requests

None

Example Responses

Status code: 200

{
  "categories" : {
    "type" : "trigger",
    "display" : "***",
    "parent" : "***"
  }
}

Status Codes

Status Code	Description
200	List of specified metadata categories.
400	Bad Request
500	Internal Server Error

Error Codes

See Error Codes.

Obtaining the List of Specified Metadata Categories