data.swagger.api-docs.rooms.json Maven / Gradle / Ivy
The newest version!
{
"apiVersion" : "v3",
"swaggerVersion" : "1.2",
"basePath" : "/v3",
"resourcePath" : "/rooms",
"apis" : [ {
"path" : "/rooms/{id}/objects/{id}/click",
"operations" : [ {
"method" : "POST",
"summary" : "Send a ObjectClickEvent for related object",
"notes" : "",
"type" : "void",
"nickname" : "click",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to click",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/{id}/behaviorchange/{bid}/{value}",
"operations" : [ {
"method" : "POST",
"summary" : "Fire a behavior change request, using provided data",
"notes" : "",
"type" : "void",
"nickname" : "behaviorChange",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to click",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "bid",
"description" : "name of behavior",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "value",
"description" : "desired value of behavior",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/templates",
"operations" : [ {
"method" : "GET",
"summary" : "List all object templates",
"notes" : "",
"type" : "void",
"nickname" : "listTemplates",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/templates/{name}/instantiate",
"operations" : [ {
"method" : "POST",
"summary" : "Add a new object, based on selected template",
"notes" : "",
"type" : "void",
"nickname" : "instantiateTemplate",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "name",
"description" : "Name of object template (e.g. Light, Thermostat)",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Template not found"
}, {
"code" : 201,
"message" : "Object added"
} ]
} ]
}, {
"path" : "/rooms",
"operations" : [ {
"method" : "GET",
"summary" : "List all rooms",
"notes" : "",
"type" : "void",
"nickname" : "list",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ ]
}, {
"method" : "POST",
"summary" : "Add a new room",
"notes" : "",
"type" : "void",
"nickname" : "create",
"produces" : [ "application/json" ],
"consumes" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "body",
"required" : false,
"type" : "Zone",
"paramType" : "body"
} ],
"responseMessages" : [ {
"code" : 201,
"message" : "New room added"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/",
"operations" : [ {
"method" : "GET",
"summary" : "List all objects",
"notes" : "",
"type" : "void",
"nickname" : "list",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
}, {
"method" : "POST",
"summary" : "Add a new object",
"notes" : "",
"type" : "void",
"nickname" : "create",
"produces" : [ "application/json" ],
"consumes" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "body",
"required" : false,
"type" : "EnvObject",
"paramType" : "body"
} ],
"responseMessages" : [ {
"code" : 201,
"message" : "New object created"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/{id}/behaviors",
"operations" : [ {
"method" : "GET",
"summary" : "Get a list of items",
"notes" : "",
"type" : "void",
"nickname" : "list",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to fetch behaviors from",
"required" : true,
"type" : "string",
"paramType" : "path"
} ]
}, {
"method" : "POST",
"summary" : "Create a new item",
"notes" : "",
"type" : "void",
"nickname" : "create",
"produces" : [ "application/json" ],
"consumes" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to fetch behaviors from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "body",
"required" : false,
"type" : "Object",
"paramType" : "body"
} ],
"responseMessages" : [ {
"code" : 201,
"message" : "New item created"
} ]
} ]
}, {
"path" : "/rooms/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a room",
"notes" : "",
"type" : "void",
"nickname" : "get",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Room not found"
} ]
}, {
"method" : "PUT",
"summary" : "Update a room",
"notes" : "",
"type" : "void",
"nickname" : "update",
"produces" : [ "application/json" ],
"consumes" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "body",
"required" : false,
"type" : "Zone",
"paramType" : "body"
} ],
"responseMessages" : [ {
"code" : 304,
"message" : "Room not modified"
} ]
}, {
"method" : "DELETE",
"summary" : "Delete a room object",
"notes" : "",
"type" : "void",
"nickname" : "delete",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Room not found"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Get an object",
"notes" : "",
"type" : "void",
"nickname" : "get",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to fetch (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Object not found"
} ]
}, {
"method" : "PUT",
"summary" : "Update an object",
"notes" : "",
"type" : "void",
"nickname" : "update",
"produces" : [ "application/json" ],
"consumes" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to update (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "body",
"required" : false,
"type" : "EnvObject",
"paramType" : "body"
} ],
"responseMessages" : [ {
"code" : 304,
"message" : "Object not modified"
} ]
}, {
"method" : "DELETE",
"summary" : "Delete an object",
"notes" : "",
"type" : "void",
"nickname" : "delete",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to delete (e.g. df28cda0-a866-11e2-9e96-0800200c9a66)",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Object not found"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/{id}/behaviors/{id}",
"operations" : [ {
"method" : "GET",
"summary" : "Get a single item",
"notes" : "",
"type" : "void",
"nickname" : "get",
"produces" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to fetch behaviors from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "ID of item to fetch",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Item not found"
} ]
}, {
"method" : "PUT",
"summary" : "Update an item",
"notes" : "",
"type" : "void",
"nickname" : "update",
"produces" : [ "application/json" ],
"consumes" : [ "application/json" ],
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to fetch behaviors from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "ID of item to update",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "body",
"required" : false,
"type" : "Object",
"paramType" : "body"
} ],
"responseMessages" : [ {
"code" : 304,
"message" : "Item not modified"
} ]
}, {
"method" : "DELETE",
"summary" : "Delete an item",
"notes" : "",
"type" : "void",
"nickname" : "delete",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to fetch behaviors from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "ID of item to delete",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Item not found"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/{id}/behaviors/{id}/copy",
"operations" : [ {
"method" : "POST",
"summary" : "Copy an item",
"notes" : "",
"type" : "void",
"nickname" : "copy",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "UUID of object to fetch behaviors from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "ID of item to copy",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Source item not found"
} ]
} ]
}, {
"path" : "/rooms/{id}/objects/{id}/copy",
"operations" : [ {
"method" : "POST",
"summary" : "Copy an item",
"notes" : "",
"type" : "void",
"nickname" : "copy",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "UUID of room to fetch objects from",
"required" : true,
"type" : "string",
"paramType" : "path"
}, {
"name" : "id",
"description" : "ID of item to copy",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Source item not found"
} ]
} ]
}, {
"path" : "/rooms/{id}/copy",
"operations" : [ {
"method" : "POST",
"summary" : "Copy an item",
"notes" : "",
"type" : "void",
"nickname" : "copy",
"authorizations" : { },
"parameters" : [ {
"name" : "id",
"description" : "ID of item to copy",
"required" : true,
"type" : "string",
"paramType" : "path"
} ],
"responseMessages" : [ {
"code" : 404,
"message" : "Source item not found"
} ]
} ]
} ],
"models" : {
"Zone" : {
"id" : "Zone",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"room" : {
"type" : "boolean"
},
"shape" : {
"$ref" : "FreedomPolygon"
},
"texture" : {
"type" : "string"
},
"uuid" : {
"type" : "string"
}
}
},
"Behavior" : {
"id" : "Behavior",
"discriminator" : "@class",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"active" : {
"type" : "boolean"
},
"priority" : {
"type" : "integer",
"format" : "int32"
},
"readOnly" : {
"type" : "boolean"
}
}
},
"FreedomPolygon" : {
"id" : "FreedomPolygon",
"properties" : {
"points" : {
"$ref" : "java.util.ArrayList"
}
}
},
"Representation" : {
"id" : "Representation",
"properties" : {
"tangible" : {
"type" : "boolean"
},
"intersecable" : {
"type" : "boolean"
},
"offset" : {
"$ref" : "FreedomPoint"
},
"rotation" : {
"type" : "number",
"format" : "double"
},
"icon" : {
"type" : "string"
},
"fillColor" : {
"type" : "string"
},
"textColor" : {
"type" : "string"
},
"borderColor" : {
"type" : "string"
},
"scaleX" : {
"type" : "number",
"format" : "double"
},
"scaleY" : {
"type" : "number",
"format" : "double"
},
"shape" : {
"$ref" : "FreedomShape"
}
}
},
"FreedomPoint" : {
"id" : "FreedomPoint",
"properties" : {
"x" : {
"type" : "integer",
"format" : "int32"
},
"y" : {
"type" : "integer",
"format" : "int32"
}
}
},
"EnvObject" : {
"id" : "EnvObject",
"properties" : {
"name" : {
"type" : "string"
},
"description" : {
"type" : "string"
},
"actAs" : {
"type" : "string"
},
"type" : {
"type" : "string"
},
"hierarchy" : {
"type" : "string"
},
"protocol" : {
"type" : "string"
},
"phisicalAddress" : {
"type" : "string"
},
"behaviors" : {
"type" : "array",
"items" : {
"$ref" : "Behavior"
}
},
"actions" : {
"$ref" : "Properties"
},
"triggers" : {
"$ref" : "Properties"
},
"currentRepresentation" : {
"$ref" : "Representation"
},
"simpleType" : {
"type" : "string"
},
"shape" : {
"$ref" : "FreedomShape"
},
"uUID" : {
"type" : "string"
},
"tagsString" : {
"type" : "string"
},
"environmentID" : {
"type" : "string"
},
"exposedProperties" : {
"$ref" : "Map[string,string]"
},
"currentRepresentationIndex" : {
"type" : "integer",
"format" : "int32"
},
"representations" : {
"type" : "array",
"items" : {
"$ref" : "Representation"
}
},
"activeBehaviors" : {
"$ref" : "java.util.ArrayList"
},
"tagsList" : {
"type" : "array",
"uniqueItems" : true,
"items" : {
"type" : "string"
}
}
}
}
}
} © 2015 - 2024 Weber Informatics LLC | Privacy Policy