Next (Deleting Scene) Previous (Clone Scene)

Modify Scene

Definition

PUT https://clara.io/api/scenes/{uuid}

URL Parameters

  • uuid: the scene ID.

JSON Schema

{
    "name":{
        "type":"String",
        "description": "The Scene Name."
    },
    "public":{
        "type": "boolean",
        "description": "If true, do not require authentication for scene to be viewable."
    },
    "allowPublicClone":{
        "type": "boolean",
        "description": "If true, non-authenticated users can clone this scene."
    },
    "description":{
        "type": "String",
        "description": "Description of scene."
    },
    "license":{
        "type": "String",
        "description": "The usage license.",
        "permitted values":{
            "none": "None (All rights reserved)",
            "custom": "Custom",
            "cc by": "Creative Commons Attribution",
            "cc by-sa": "Creative Commons Attribution-ShareAlike",
            "cc by-nc": "Creative Commons Attribution-NonCommercial",
            "cc by-nc-sa": "Creative Commons Attribution-NonCommercial-ShareAlike",
            "cc by-nd": "Creative Commons Attribution-NoDerivs",
            "cc by-nc-nd": "Creative Commons Attribution-NonCommercial-NoDerivs",
            "cc0": "No Rights Reserved",
            "public": "Public Domain"
        }
    }
}

Example Request

curl "https://clara.io/api/scenes/59f6f456-cdb4-4c77-a578-4de894bc53c5" \
    -u username:c3be3060-fe81-467b-aa62-0ee42eea9c8b \
    -X PUT \
    -d public=true \
    -d allowPublicClone=true \
    -d license="cc by"

Clara Node SDK

When using the Clara Node SDK:

$ clara scenes:update [options]

Next (Deleting Scene) Previous (Clone Scene)