Rename scene
1. API Description
This API is used to rename a scene.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/scene/rename-scene
- V2.5.0 and below: POST [ip]/mwapi/rename-scene
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| sceneId | Yes | Int | Scene ID, which can be obtained via Get scene list |
| name | Yes | String | New scene name |
| showId | No | Int | Presentation ID, which can be obtained via Get presentation list |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| message | String | Status description |
4. Example
Renaming scene 100 in presentation 7 to "New Name".
Input Example
{
"sceneId":100,
"name":"New Name",
"showId":7
}
Output Example
{
"message": "success",
"status": 0
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Status | Definition | Description |
|---|---|---|
| 7 | MW_STATUS_INVALID_ARG | Missing required parameters |
| 39 | MW_STATUS_MISMATCH | The scene does not exist |
| 48 | MW_STATUS_INFO_CHANGED | Prohibited to operate content not in the current presentation |