Help Center/ Meeting/ Server API Reference/ Bulletin Board Management/ Bulletin Board Material Management/ Querying Bulletin Board Materials in Pages
Updated on 2023-12-22 GMT+08:00
Online Debugging
CLI Examples
View PDF

Querying Bulletin Board Materials in Pages

Description

This API is used to query bulletin board materials in pages.

Debugging

You can debug this API in API Explorer.

Prototype

Table 1 Prototype

Request Method

GET

Request Address

/v1/usg/sss/materials

Transport Protocol

HTTPS

Request Parameters

Table 2 Parameters

Parameter

Mandatory

Type

Location

Description

offset

No

Integer

Query

Query offset. If the value exceeds the maximum number of records available, records on the last page are returned.

Default value: 0.

limit

No

Integer

Query

Number of records to query.

Default value: 10.

searchKey

No

String

Query

Search criteria. Fuzzy search by material name and updater is supported.

X-Access-Token

Yes

String

Header

Authorization token. Use the value of accessToken in the response to the request for Authenticating an App ID.

X-Request-Id

No

String

Header

Request ID, which is used for fault tracing and locating. You are advised to use a UUID. If this parameter is not carried, a request ID is automatically generated.

Accept-Language

No

String

Header

Language. Values: zh-CN for Chinese (default) and en-US for English.

Status Codes

Table 3 Status codes

HTTP Status Code

Description

200

Operation successful.

400

Invalid parameters.

401

Authentication is not performed or fails.

403

Insufficient permissions.

500

Server exception.

Response Parameters

Table 4 Response Parameters

Parameter

Type

Description

count

Integer

Total number of records.

limit

Integer

Number of records displayed per page.

Default value: 10.

offset

Integer

Number of the query start page. The value starts from 0.

data

Array of Material objects

Material details.
Table 5 Material data structure

Parameter

Type

Description

filePath

String

URL for downloading the material from Clouddrive.

id

String

Material ID.

lastUpdatedBy

String

Updater.

materialName

String

Material name.

materialResolution

String

Material resolution.

materialSizeStr

String

Material size (including the unit).

updateTime

Long

Update time.

Example Request

GET /v1/usg/sss/materials?offset=0&limit=5&searchKey=
Connection: keep-alive
X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE
Content-Type: application/json
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

Example Response

HTTP/1.1 200 
Date: Wed, 18 Dec 2019 06:20:40 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 1329
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Server: api-gateway
X-Request-Id: b4facce44898efa03629afd189da7f5f

{
    "count": 1,
    "data": [
       {
            "filePath": "https://mock/download-file",
            "id": "835fe0052b2b4cc0ae1704fddad9e683",
            "lastUpdatedBy": "",
            "materialName": "test",
            "materialResolution": "",
            "materialSizeStr": "462.71KB",
            "updateTime": "1551755880176"
        }
    ],
    "limit": 5,
    "offset": 0
}

Error Codes

If an error code starting with MMC or USG is returned when you use this API, rectify the fault by following the instructions provided in Huawei Cloud API Error Center.

Example cURL Command

curl -k -i -X GET -H 'X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE' 
https://api.meeting.huaweicloud.com/v1/usg/sss/materials?offset=0&limit=5