Querying Details of a Publication by ID
Description
This API is used to query details of a publication by ID.
Debugging
You can debug this API in API Explorer.
Prototype
Request Method |
GET |
---|---|
Request Address |
/v1/usg/sss/publications/{id} |
Transport Protocol |
HTTPS |
Request Parameters
Parameter |
Mandatory |
Type |
Location |
Description |
---|---|---|---|---|
id |
Yes |
String |
Path |
Publication ID. |
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
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
Parameter |
Type |
Description |
---|---|---|
createTime |
Long |
Creation time. |
endTime |
Long |
End time. |
id |
String |
Publication ID. |
lastUpdatedBy |
String |
Updater. |
publishName |
String |
Publication name. |
publishScope |
String |
Publication scope. |
publishStatus |
String |
Publication status on the current time. |
startTime |
Long |
Start time. |
updateTime |
Long |
Update time. |
deptList |
Array of PublishDeptResponseDTO objects |
List of departments that the publication was published to. |
deviceList |
Array of PublishDeviceResponseDTO objects |
List of devices that the publication was published to. |
programList |
Array of ProgramResponseBase objects |
List of published program IDs. |
Parameter |
Type |
Description |
---|---|---|
deptCode |
String |
Department code. |
deptName |
String |
Department name. |
Parameter |
Type |
Description |
---|---|---|
deviceName |
String |
Device name. |
deviceUserId |
String |
Device user ID. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Program ID. |
lastUpdatedBy |
String |
Updater. |
materialSizeStr |
String |
Total size of program materials (including the unit). |
playTime |
Integer |
Total playback duration of a program, in seconds. |
programName |
String |
Program name. |
updateTime |
Long |
Update time. |
Example Request
GET /v1/usg/sss/publications/bfccb099e6e34dca95f72c1404c68cd9 Connection: keep-alive X-Access-Token: cnrfzn5OLRjwoaOf2F7PfMwVjJ6zScFogbDE 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 Connection: keep-alive Pragma: No-cache Cache-Control: no-cache Server: api-gateway X-Request-Id: 149e8b71037898deffc5e2a44b5e5c230 { "id": "bfccb099e6e34dca95f72c1404c68cd9", "lastUpdatedBy": "", "createTime": 1593538210692, "updateTime": 1593538210692, "publishName": "NZmsGuY4J6", "publishScope": "", "startTime": 0, "endTime": 253402271999000, "publishStatus": "PUBLISHING", "programList": [ { "id": "f7350ac9a4aa41beac142dd588f39fbe", "lastUpdatedBy": "", "updateTime": 1593538210605, "programName": "c5bc3AwzNr", "materialSizeStr": "462.71KB", "playTime": 10 } ], "deptList": [ { "deptCode": "SZ1mBIAdBP", "deptName": null } ], "deviceList": [ { "deviceUserId": "B6l75EEqjh", "deviceName": null } ] }
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/publications/bfccb099e6e34dca95f72c1404c68cd9
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot