webssphh_restful_service
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
webssphh_restful_service [2016/07/23 14:00] – 100.3.200.49 | webssphh_restful_service [2016/07/24 06:02] – [Project] 100.3.200.49 | ||
---|---|---|---|
Line 5: | Line 5: | ||
- | '' | + | '' |
- | Parameters: | + | | parameter | data type | values | definition | |
+ | | a | string| s\\ u\\ i\\ d | SELECT RECORD (works with GET or POST)\\ UPDATE RECORD (works with POST only) \\ INSERT RECORD (works with POST only) \\ DELETE RECORD (works with GET or POST | | ||
+ | | token | string | [\w\d]+ | A security token allowing authorized users only | | ||
+ | | projects | none | none | Returns a JSON array of projects | | ||
+ | | scenes | none | none | Returns a JSON array of scenes in the current project. This requires the '' | ||
+ | | objects | none | none | Returns a JSON array of objects in the current project. This requires the '' | ||
+ | | sobjects | none | none | Returns a JSON array of objects in the current scene. This requires the '' | ||
+ | | project| number | 1 - 1048576 | Returns a JSON object with the project properties | | ||
+ | | scene | number | 1 - 1048576 | Returns a JSON object with the scene properties. This requires the '' | ||
+ | | object | number | 1 - 1048576 | Returns a JSON object with the object properties. This requires the '' | ||
- | '' | + | ===== Schemas ===== |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | * '' | + | |
- | | parameter | data type | values | meaning | | + | ==== Projects ==== |
- | | a | string| s | SELECT RECORD | | + | |
- | | | | u | UPDATE RECORD | | + | |
- | | | | i | INSERT RECORD | | + | |
- | | | | d | DELETE RECORD | | + | |
- | | token | string | [\w\d]+ | a security token allowing authorized users only | | + | |
+ | <code javascript> | ||
+ | " | ||
+ | { " | ||
+ | { " | ||
+ | ... | ||
+ | ] | ||
+ | </ | ||
+ | |||
+ | ==== Scenes ==== | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | { " | ||
+ | { " | ||
+ | ... | ||
+ | ] | ||
+ | </ | ||
+ | |||
+ | ==== Objects ==== | ||
+ | <code javascript> | ||
+ | " | ||
+ | { " | ||
+ | { " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== Project ==== | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== Scene ==== | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | |||
+ | ==== Object ==== | ||
+ | |||
+ | The types of objects are | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | <code javascript> | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | ... | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ===== Common Types of Properties ===== | ||
+ | |||
+ | ==== Special Types ==== | ||
+ | |||
+ | ^Typename | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | ==== Normal Types ==== | ||
+ | |||
+ | === Object === | ||
+ | |||
+ | ^Typename ^JSON/Type | | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | |||
+ | === Point Light === | ||
+ | |||
+ | ^Typename ^JSON/Type | | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' | ||
+ | | '' |
webssphh_restful_service.txt · Last modified: 2023/09/22 16:50 by microwerx