Search Function Key Templates

Searches function key templates in a tenant.

Request URL

POST {base_url}/uc-cconfig/api/v1/function-key-templates/search-page

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Body parameters
Parameter Required Type Description
search No String The keyword used to search for function key templates.
pageNumber No Integer The page number to retrieve.
pageSize No Integer The number of records to retrieve per page.
Note:

pageNumber must be greater than or equal to 1. The request fails with an error if pageNumber is set to 0.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Search_Result> The search result of function key templates.
Search_Result
Parameter Type Description
items Array<Template_Item> The list of function key templates on the current page.
total String The total number of function key templates that match the search conditions.
Template_Item
Parameter Type Description
id String The ID of the function key template.
name String The name of the function key template.
lastModifiedTime String The time when the function key template was last modified, in Unix timestamp format (milliseconds).
remark String The remark of the function key template.

Example

Request example

POST /uc-cconfig/api/v1/function-key-templates/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MzM2ODE5MiwiaWF0IjoxNzkzMzQ2NTkyLCJqdGkiOiI5MGU4MWZjZi01ODc2LTRmNTgtYjYwYi1jY2NhMzhjZTliYTYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.XlXo7LeQsq2088wJwdAzGjcu8AEJV4E5TxIy0UVQT2i5aYH4287xiVmV-QLHOMBgb2MRf9OIgNdYo-dIIddmqaIYUkgqQ3TeYDfBToMAhjn3TxjcuE6myy3lnsBHrXvy9A4TmSbMe-dQTra186xjTVuwWuf-PiJJ7eHZByCzymN-rG_usOgOSUy1l7pO62YDdsVWrmdEdl7TmDRvxNYa73OKfGimMa5qe9t3-yyf_t-cpqOPGjzB3oCHHBzfagE64rMmgGZV4G7tVCwD67sHxYJSxqYHoL93L-hq3EBr-T4jQL0w4iJmzuI_B75llBFtxgqbW06X5kgCz6qwDYITcQ
x-tenant-code: jint
Content-Type: application/json
{
  "search": "fk-test",
  "pageNumber": 1,
  "pageSize": 10
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "81fcbd3a00c04b3968125e1ab96d371e",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "items": [
      {
        "id": "374465332982931456",
        "name": "fk-test-template-2",
        "lastModifiedTime": "1793346692612",
        "remark": "Second template."
      },
      {
        "id": "374465332446060544",
        "name": "fk-test-template-1",
        "lastModifiedTime": "1793346692484",
        "remark": "Created for doc testing."
      }
    ],
    "total": "2"
  }
}