Add bulkProperties endpoints

AMWA-TV · Mar 4, 2024 · e8dbdac · e8dbdac
1 parent da026cd
commit e8dbdac
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/APIs/ConfigurationAPI.raml b/APIs/ConfigurationAPI.raml
@@ -46,6 +46,17 @@ documentation:
           description: 'Returned when the requested Role Path does not exist. Corresponds to NcMethodStatus code 404.'
           body:
             type: !include schemas/ms05-error.json
+    /bulkProperties:
+      displayName: 'Bulk Properties'
+      get:
+        description: 'Get Bulk Properties of the object'
+        queryParameters:
+          recurse:
+            description: True will get Bulk Properties for this object and all child objects
+            type: boolean
+        responses:
+          200:
+            body:
     /properties:
       displayName: 'Properties'
       get:
@@ -154,3 +165,24 @@ documentation:
             description: 'Returned when the Class Descriptor of this object was unable to be retrieved. Corresponds to NcMethodStatus code 500.'
             body:
               type: !include schemas/ms05-error.json
+/bulkProperties:
+    displayName: 'Bulk Properties Functions'
+    get:
+    description: 'Shows the Bulk Properties functions'
+    responses:
+        200:
+        body:
+    /validate:
+        displayName: 'Validate Bulk Properties'
+        patch:
+        description: 'Validate a Bulk Properties object against the Device Model'
+        responses:
+            200:
+            body:
+    /set:
+        displayName: 'Set Bulk Properties'
+        put:
+        description: 'Set a Bulk Properties object on the Device Model'
+        responses:
+            200:
+            body: