{ "uuid": "c30dfd06-6e15-452c-a199-132fa4842a73", "lastMigration": 24, "name": "PI Web API 2018 SP1 Swagger Spec", "endpointPrefix": "piwebapi", "latency": 0, "port": 3000, "hostname": "0.0.0.0", "routes": [ { "uuid": "03957d3b-2e05-4f1d-8c43-3b5be7ea5af6", "documentation": "Get top level links for this PI System Web API instance.", "method": "get", "endpoint": "", "responses": [ { "uuid": "ad362fed-5d1e-4fe4-837e-cbbc7f2a94de", "body": "{\n \"Links\": {\n \"AssetServers\": \"\",\n \"DataServers\": \"\",\n \"Search\": \"\",\n \"Self\": \"\",\n \"System\": \"\"\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Links to top level collections and system information.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3d107fac-f7b3-4a0a-b564-794a599df15f", "documentation": "Retrieve an Analysis by path.", "method": "get", "endpoint": "analyses", "responses": [ { "uuid": "8ebb8c58-7e79-4ae7-97e4-11aca9bb587d", "body": "{\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"AutoCreated\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotification\": {{faker 'datatype.boolean'}},\n \"HasTarget\": true,\n \"HasTemplate\": {{faker 'datatype.boolean'}},\n \"Id\": \"11853358-94bf-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsTimeRuleDefinedByTemplate\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"Template\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"MaximumQueueSize\": {{faker 'datatype.number'}},\n \"Name\": \"MyAnalysis\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\",\n \"Priority\": \"High\",\n \"PublishResults\": {{faker 'datatype.boolean'}},\n \"Status\": \"Disabled\",\n \"TargetWebId\": \"I1ETDqD5loBNH0erqeqJodtALAjFPVfUpY-02A8uioGDSgIg\",\n \"TemplateName\": \"\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified Analysis.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4b2982dd-0f8e-45e5-bbed-e9a1a5dbc4e9", "documentation": "Retrieve analyses based on the specified conditions. By default, returns all analyses.", "method": "get", "endpoint": "analyses/search", "responses": [ { "uuid": "ebe0f865-78fa-49ef-923c-99d1aae032c7", "body": "{\n \"Items\": [\n {\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"AutoCreated\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotification\": {{faker 'datatype.boolean'}},\n \"HasTarget\": true,\n \"HasTemplate\": {{faker 'datatype.boolean'}},\n \"Id\": \"11853358-94bf-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsTimeRuleDefinedByTemplate\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"Template\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"MaximumQueueSize\": {{faker 'datatype.number'}},\n \"Name\": \"MyAnalysis\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\",\n \"Priority\": \"High\",\n \"PublishResults\": {{faker 'datatype.boolean'}},\n \"Status\": \"Disabled\",\n \"TargetWebId\": \"I1ETDqD5loBNH0erqeqJodtALAjFPVfUpY-02A8uioGDSgIg\",\n \"TemplateName\": \"\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of analyses matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2dc6b655-6f86-472d-9536-ddc563d8803c", "documentation": "Delete an Analysis.", "method": "delete", "endpoint": "analyses/:webId", "responses": [ { "uuid": "374302f3-f171-45bd-a10c-bf8e76d943a3", "body": "", "latency": 0, "statusCode": 204, "label": "The Analysis was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "39af2b2f-20e4-44ef-b599-481c12c4d771", "documentation": "Retrieve an Analysis.", "method": "get", "endpoint": "analyses/:webId", "responses": [ { "uuid": "d9bbdba6-d026-48b9-b683-187b77663b97", "body": "{\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"AutoCreated\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotification\": {{faker 'datatype.boolean'}},\n \"HasTarget\": true,\n \"HasTemplate\": {{faker 'datatype.boolean'}},\n \"Id\": \"11853358-94bf-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsTimeRuleDefinedByTemplate\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"Template\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"MaximumQueueSize\": {{faker 'datatype.number'}},\n \"Name\": \"MyAnalysis\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\",\n \"Priority\": \"High\",\n \"PublishResults\": {{faker 'datatype.boolean'}},\n \"Status\": \"Disabled\",\n \"TargetWebId\": \"I1ETDqD5loBNH0erqeqJodtALAjFPVfUpY-02A8uioGDSgIg\",\n \"TemplateName\": \"\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified Analysis.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f00fa989-b123-405d-bf9d-d8c2c3a84b1e", "documentation": "Update an Analysis.", "method": "patch", "endpoint": "analyses/:webId", "responses": [ { "uuid": "5e7b9e79-a2f3-48d3-b8c4-f4577e150102", "body": "", "latency": 0, "statusCode": 204, "label": "The Analysis was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8e6f5585-ad64-4656-8f96-bf6bfc11253f", "documentation": "Get an Analysis' categories.", "method": "get", "endpoint": "analyses/:webId/categories", "responses": [ { "uuid": "49961ef5-3d04-43bf-b5b6-5246fcc463b8", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"f9364aa2-0e4a-4854-9b85-35900a4d4c0f\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAnalysis[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XCDqD5loBNH0erqeqJodtALAoko2-UoOVEibhTWQCk1MDw\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a88b14bb-ea95-4146-88ba-629e1837c94a", "documentation": "Get the security information of the specified security item associated with the Analysis for a specified user.", "method": "get", "endpoint": "analyses/:webId/security", "responses": [ { "uuid": "0c3645ca-55ed-4c15-a0be-3b7eb5b62c91", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "14103c01-780e-4890-9e75-5f8f2d77d6e6", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "2c050cf2-2e11-4ddc-8daa-e030a021cd03", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9231ab17-481e-45e0-b27a-eb2b5ecee5fc", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3016abdf-9ffa-456a-8d14-2204aaaec82a", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "285f7c7d-320f-4df0-a7ec-42b9e2fef5f8", "documentation": "Retrieve the security entries associated with the analysis based on the specified criteria. By default, all security entries for this analysis are returned.", "method": "get", "endpoint": "analyses/:webId/securityentries", "responses": [ { "uuid": "74486aa7-ad99-49f4-bdd8-25f943e5b54b", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f544431e-bfe9-43d0-aa18-864a432b2848", "documentation": "Create a security entry owned by the analysis.", "method": "post", "endpoint": "analyses/:webId/securityentries", "responses": [ { "uuid": "878a27d8-6304-43c4-bcc0-485c68228f69", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "88c26a77-1c0c-4de1-9f14-386cbf82bdbe", "documentation": "Delete a security entry owned by the analysis.", "method": "delete", "endpoint": "analyses/:webId/securityentries/:name", "responses": [ { "uuid": "c3d31d9a-49fc-4050-94c9-bc5015c055e4", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c481de28-b2a1-4eb0-8510-0557f57409f5", "documentation": "Retrieve the security entry associated with the analysis with the specified name.", "method": "get", "endpoint": "analyses/:webId/securityentries/:name", "responses": [ { "uuid": "d346c40d-708b-469c-a634-054b62293d72", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ae6ef180-00cd-4121-9bcb-244a48fe67cd", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bb2c78eb-91f5-4bdf-af3d-5a622d59f78d", "documentation": "Update a security entry owned by the analysis.", "method": "put", "endpoint": "analyses/:webId/securityentries/:name", "responses": [ { "uuid": "9ff1909b-5c5c-4703-bea8-9f2440a7b3fa", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b6df29dc-45c5-4350-993b-0d12591760e6", "documentation": "Retrieve an analysis category by path.", "method": "get", "endpoint": "analysiscategories", "responses": [ { "uuid": "27a523ca-196e-467d-a087-fb46936ee699", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"f9364aa2-0e4a-4854-9b85-35900a4d4c0f\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAnalysis[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XCDqD5loBNH0erqeqJodtALAoko2-UoOVEibhTWQCk1MDw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified analysis category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3f777fb5-3cea-4d58-898b-e55ed571ab3c", "documentation": "Delete an analysis category.", "method": "delete", "endpoint": "analysiscategories/:webId", "responses": [ { "uuid": "79ccbb27-8026-45dc-8c4d-42e49b60812f", "body": "", "latency": 0, "statusCode": 204, "label": "The analysis category was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4825c8c4-7447-47c5-b255-703e711c411e", "documentation": "Retrieve an analysis category.", "method": "get", "endpoint": "analysiscategories/:webId", "responses": [ { "uuid": "16a615de-c71c-40d5-a6a4-3d9bea649e5f", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"f9364aa2-0e4a-4854-9b85-35900a4d4c0f\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAnalysis[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XCDqD5loBNH0erqeqJodtALAoko2-UoOVEibhTWQCk1MDw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified analysis category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6a867173-ec42-425f-bb94-0d8533ee022c", "documentation": "Update an analysis category by replacing items in its definition.", "method": "patch", "endpoint": "analysiscategories/:webId", "responses": [ { "uuid": "09a4bff1-51dc-4b4d-a468-d976c0de856b", "body": "", "latency": 0, "statusCode": 204, "label": "The analysis category was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e7372c10-21e8-4c21-a133-c766d36025d8", "documentation": "Get the security information of the specified security item associated with the analysis category for a specified user.", "method": "get", "endpoint": "analysiscategories/:webId/security", "responses": [ { "uuid": "aaecd754-0297-4d97-8f2b-b1e663b688e8", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4d1e7828-62c8-4bda-aebc-ac8d535e3a32", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "fa3604b7-7f51-4146-820c-23a633c66a77", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "85859a1b-ee9f-42c3-8975-26bf8088c66e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "7fef7157-d679-490b-a27d-3a799ccd74bb", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "71a3c3fc-42e3-4fc4-85b5-d00dbb19c7ec", "documentation": "Retrieve the security entries associated with the analysis category based on the specified criteria. By default, all security entries for this analysis category are returned.", "method": "get", "endpoint": "analysiscategories/:webId/securityentries", "responses": [ { "uuid": "7808fed8-def6-4d4e-8f1a-41b117beb7e6", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7a581c5b-e222-47d8-a2c3-a02d32c4ead6", "documentation": "Create a security entry owned by the analysis category.", "method": "post", "endpoint": "analysiscategories/:webId/securityentries", "responses": [ { "uuid": "da4d1ee2-c043-4bef-95f9-ddd1c677cc5e", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "42db0119-1c0c-4893-b058-92068c1c8926", "documentation": "Delete a security entry owned by the analysis category.", "method": "delete", "endpoint": "analysiscategories/:webId/securityentries/:name", "responses": [ { "uuid": "f72c5230-e9ca-4654-aaff-2ee1907c2630", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6e9f16e7-755a-4fa5-93a0-0ac5d2be1754", "documentation": "Retrieve the security entry associated with the analysis category with the specified name.", "method": "get", "endpoint": "analysiscategories/:webId/securityentries/:name", "responses": [ { "uuid": "854a3531-0517-4f82-94ed-852fd01f4d7f", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9f7896aa-08ed-4298-b3c1-c92a5764d9dc", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c528643d-c369-4244-8192-db4177d6a0d7", "documentation": "Update a security entry owned by the analysis category.", "method": "put", "endpoint": "analysiscategories/:webId/securityentries/:name", "responses": [ { "uuid": "0453e327-dacb-4299-9aec-7a409322f756", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f31bad09-c0a4-41c2-a778-e6eb89042d1b", "documentation": "Retrieve an Analysis Rule Plug-in by path.", "method": "get", "endpoint": "analysisruleplugins", "responses": [ { "uuid": "303e18a7-913f-4c9e-9c33-b25659fa74ff", "body": "{\n \"AssemblyFileName\": \"OSIsoft.AF.Analysis.AnalysisRule.Imbalance.dll\",\n \"AssemblyID\": \"1acd00c2-79d0-4818-a03c-0616c4513750\",\n \"AssemblyLoadProperties\": [\n \"None\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Calculates simple material imbalances on nodes of a model.\",\n \"Id\": \"9a2a6c05-6f61-467a-854a-16dbfb9d8c03\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"Imbalance\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsAnalysisRule[Imbalance]\",\n \"Version\": \"2.8.5.7552\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XPDqD5loBNH0erqeqJodtALABWwqmmFvekaFShbb-52MAw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified Analysis Rule Plug-in.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "02337118-983f-4a53-ae98-7e2cd42e3edf", "documentation": "Retrieve an Analysis Rule Plug-in.", "method": "get", "endpoint": "analysisruleplugins/:webId", "responses": [ { "uuid": "78ceae08-6cf6-41cf-b48d-01b90afdc8e9", "body": "{\n \"AssemblyFileName\": \"OSIsoft.AF.Analysis.AnalysisRule.Imbalance.dll\",\n \"AssemblyID\": \"1acd00c2-79d0-4818-a03c-0616c4513750\",\n \"AssemblyLoadProperties\": [\n \"None\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Calculates simple material imbalances on nodes of a model.\",\n \"Id\": \"9a2a6c05-6f61-467a-854a-16dbfb9d8c03\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"Imbalance\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsAnalysisRule[Imbalance]\",\n \"Version\": \"2.8.5.7552\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XPDqD5loBNH0erqeqJodtALABWwqmmFvekaFShbb-52MAw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified Analysis Rule Plug-in.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3c94057a-0cc7-4623-b08e-085e7267beb0", "documentation": "Retrieve an Analysis Rule by path.", "method": "get", "endpoint": "analysisrules", "responses": [ { "uuid": "313ff5c2-2af0-470e-83d0-9ca10472acde", "body": "{\n \"ConfigString\": \"a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;\",\n \"Description\": \"Runs a performance equation.\",\n \"DisplayString\": \"a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;\",\n \"EditorType\": \"OSIsoft.AF.Analysis.AnalysisRule.PEAnalysisRuleEditor\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"ca9d257f-94c2-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsInitializing\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Analysis\": \"\",\n \"AnalysisRules\": \"\",\n \"AnalysisTemplate\": \"\",\n \"Parent\": \"\",\n \"PlugIn\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"PerformanceEquation\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\\\\AnalysisRule\",\n \"PlugInName\": \"PerformanceEquation\",\n \"SupportedBehaviors\": [\n \"SupportsRunningCase\",\n \"SupportStatePassing\",\n \"OutputCorrectAfterSkipping\"\n ],\n \"VariableMapping\": \"b||Attribute1;c||Attribute2\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XRXDqD5loBNH0erqeqJodtALAfyWdysKU5xGEQwAVXYTCAAfyWdysKU5xGEQwAVXYTCAA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested Analysis Rule.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "64213723-d5b6-48d8-b56a-ecb3eeaf68c8", "documentation": "Delete an Analysis Rule.", "method": "delete", "endpoint": "analysisrules/:webId", "responses": [ { "uuid": "7e0a0c82-ae30-47a6-be9f-20ac8993dfb6", "body": "", "latency": 0, "statusCode": 204, "label": "The Analysis Rule was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2937c165-a74d-4387-803f-c9a7d9cfb9e0", "documentation": "Retrieve an Analysis Rule.", "method": "get", "endpoint": "analysisrules/:webId", "responses": [ { "uuid": "feacdad2-bb00-4cb6-ba0d-16c1aecae941", "body": "{\n \"ConfigString\": \"a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;\",\n \"Description\": \"Runs a performance equation.\",\n \"DisplayString\": \"a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;\",\n \"EditorType\": \"OSIsoft.AF.Analysis.AnalysisRule.PEAnalysisRuleEditor\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"ca9d257f-94c2-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsInitializing\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Analysis\": \"\",\n \"AnalysisRules\": \"\",\n \"AnalysisTemplate\": \"\",\n \"Parent\": \"\",\n \"PlugIn\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"PerformanceEquation\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\\\\AnalysisRule\",\n \"PlugInName\": \"PerformanceEquation\",\n \"SupportedBehaviors\": [\n \"SupportsRunningCase\",\n \"SupportStatePassing\",\n \"OutputCorrectAfterSkipping\"\n ],\n \"VariableMapping\": \"b||Attribute1;c||Attribute2\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XRXDqD5loBNH0erqeqJodtALAfyWdysKU5xGEQwAVXYTCAAfyWdysKU5xGEQwAVXYTCAA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested Analysis Rule.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ef29aaed-a30b-40a2-961f-1864df123dd3", "documentation": "Update an Analysis Rule by replacing items in its definition.", "method": "patch", "endpoint": "analysisrules/:webId", "responses": [ { "uuid": "d9ff9853-2813-40b7-be2d-dae463806058", "body": "", "latency": 0, "statusCode": 204, "label": "The Analysis Rule was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ce528013-62ac-44f2-8b04-f3f491499fac", "documentation": "Get the child Analysis Rules of the Analysis Rule.", "method": "get", "endpoint": "analysisrules/:webId/analysisrules", "responses": [ { "uuid": "97aaab81-86e6-4344-b77f-edb04757e91f", "body": "{\n \"Items\": [\n {\n \"ConfigString\": \"a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;\",\n \"Description\": \"Runs a performance equation.\",\n \"DisplayString\": \"a := TagVal('sinusoid'); b := Pow(a, 2); c := a + b;\",\n \"EditorType\": \"OSIsoft.AF.Analysis.AnalysisRule.PEAnalysisRuleEditor\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"ca9d257f-94c2-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsInitializing\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Analysis\": \"\",\n \"AnalysisRules\": \"\",\n \"AnalysisTemplate\": \"\",\n \"Parent\": \"\",\n \"PlugIn\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"PerformanceEquation\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\\\\AnalysisRule\",\n \"PlugInName\": \"PerformanceEquation\",\n \"SupportedBehaviors\": [\n \"SupportsRunningCase\",\n \"SupportStatePassing\",\n \"OutputCorrectAfterSkipping\"\n ],\n \"VariableMapping\": \"b||Attribute1;c||Attribute2\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XRXDqD5loBNH0erqeqJodtALAfyWdysKU5xGEQwAVXYTCAAfyWdysKU5xGEQwAVXYTCAA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of child Analysis Rules.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "df13d83d-9fc6-403c-8edb-701f6ffe60d1", "documentation": "Create a new Analysis Rule as a child of an existing Analysis Rule.", "method": "post", "endpoint": "analysisrules/:webId/analysisrules", "responses": [ { "uuid": "4fccfd53-3328-4828-9801-9c59707af587", "body": "", "latency": 0, "statusCode": 201, "label": "The Analysis Rule was created. The response's Location header is a link to the created Analysis Rule.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f2116cc0-9ab4-4689-b183-d1b9376e13f8", "documentation": "Retrieve an analysis template by path.", "method": "get", "endpoint": "analysistemplates", "responses": [ { "uuid": "17d99bae-e1b0-4c32-8657-6e61f9b56ab8", "body": "{\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"CreateEnabled\": true,\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotificationTemplate\": {{faker 'datatype.boolean'}},\n \"HasTarget\": {{faker 'datatype.boolean'}},\n \"Id\": \"612d9811-3f06-4e27-989c-42e5e5c00b88\",\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"Name\": \"MyAnalysisTemplate\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\AnalysisTemplates[MyAnalysisTemplate]\",\n \"TargetName\": \"MyElementTemplate\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified analysis template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a94612f3-dfbd-4f1c-bc92-0dc0b260b94a", "documentation": "Create an Analysis template based upon a specified Analysis.", "method": "post", "endpoint": "analysistemplates", "responses": [ { "uuid": "dc87bb4e-7c63-479f-a3fa-f7ed779b0092", "body": "", "latency": 0, "statusCode": 201, "label": "The Analysis Template was created. The response's Location header is a link to the created Analysis Template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3dbbbda9-8c66-4d2a-a1a8-8a2c84cea381", "documentation": "Retrieve analysis templates based on the specified conditions. By default, returns all analysis templates.", "method": "get", "endpoint": "analysistemplates/search", "responses": [ { "uuid": "f4b160dc-7218-4739-adf0-5d4a5d507d16", "body": "{\n \"Items\": [\n {\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"CreateEnabled\": true,\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotificationTemplate\": {{faker 'datatype.boolean'}},\n \"HasTarget\": {{faker 'datatype.boolean'}},\n \"Id\": \"612d9811-3f06-4e27-989c-42e5e5c00b88\",\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"Name\": \"MyAnalysisTemplate\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\AnalysisTemplates[MyAnalysisTemplate]\",\n \"TargetName\": \"MyElementTemplate\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of analysis templates matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0f37efb8-708e-4661-aea9-1a097fe503fe", "documentation": "Delete an analysis template.", "method": "delete", "endpoint": "analysistemplates/:webId", "responses": [ { "uuid": "e186ca35-47c0-4ebc-8518-6068aa412e16", "body": "", "latency": 0, "statusCode": 204, "label": "The analysis template was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2737761d-ba53-4cf8-a153-87f67e802e12", "documentation": "Retrieve an analysis template.", "method": "get", "endpoint": "analysistemplates/:webId", "responses": [ { "uuid": "2b10a121-b981-4174-b6ba-e368a9f20e94", "body": "{\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"CreateEnabled\": true,\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotificationTemplate\": {{faker 'datatype.boolean'}},\n \"HasTarget\": {{faker 'datatype.boolean'}},\n \"Id\": \"612d9811-3f06-4e27-989c-42e5e5c00b88\",\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"Name\": \"MyAnalysisTemplate\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\AnalysisTemplates[MyAnalysisTemplate]\",\n \"TargetName\": \"MyElementTemplate\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified analysis template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "abd77632-1d81-46c7-b3ef-372103cdc523", "documentation": "Update an analysis template by replacing items in its definition.", "method": "patch", "endpoint": "analysistemplates/:webId", "responses": [ { "uuid": "f70ba1d2-5f2c-46f0-8184-132470cee088", "body": "", "latency": 0, "statusCode": 204, "label": "The analysis template was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "22d4fa4a-0758-4ab3-b432-f4c658abdc33", "documentation": "Get an analysis template's categories.", "method": "get", "endpoint": "analysistemplates/:webId/categories", "responses": [ { "uuid": "bcfb15d1-9b7d-40ab-a685-806e74772d45", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"f9364aa2-0e4a-4854-9b85-35900a4d4c0f\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAnalysis[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XCDqD5loBNH0erqeqJodtALAoko2-UoOVEibhTWQCk1MDw\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7bec15e6-bea7-416b-a69a-6018ebab9ccb", "documentation": "Get the security information of the specified security item associated with the analysis template for a specified user.", "method": "get", "endpoint": "analysistemplates/:webId/security", "responses": [ { "uuid": "82f28245-3560-41f4-9cad-c934c461ee2f", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "dad4c242-e2fd-473f-99a4-9693381e0804", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ad36edd0-ddc8-4f2c-9e62-20adf911b90e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "db16bbc4-9f1d-4a76-b515-7b744e37e150", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e7e331d4-d1a0-4af0-bf05-a58e2b4423e4", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "07ac3ea4-622e-4b74-b97a-0bdd1c8cc169", "documentation": "Retrieve the security entries associated with the analysis template based on the specified criteria. By default, all security entries for this analysis template are returned.", "method": "get", "endpoint": "analysistemplates/:webId/securityentries", "responses": [ { "uuid": "e7f89ceb-6692-49d6-be69-21789fefa377", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9ba3be82-7e6b-4596-a0ef-0bc0bd486d93", "documentation": "Create a security entry owned by the analysis template.", "method": "post", "endpoint": "analysistemplates/:webId/securityentries", "responses": [ { "uuid": "c0c6918c-82b3-4b2d-a5a7-c05cbf598574", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8c5876f0-dd7b-41b2-90ca-69bb1d09c990", "documentation": "Delete a security entry owned by the analysis template.", "method": "delete", "endpoint": "analysistemplates/:webId/securityentries/:name", "responses": [ { "uuid": "df40579d-05c2-4252-bb28-8edc3f81f3b5", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "01237d77-9523-49fa-9c30-26eb84fddac7", "documentation": "Retrieve the security entry associated with the analysis template with the specified name.", "method": "get", "endpoint": "analysistemplates/:webId/securityentries/:name", "responses": [ { "uuid": "0551a094-7411-4115-b5f0-1ce5c2834db4", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "dea1a77f-6e96-4cd8-949c-e3be85e4e35f", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ab83cb61-527b-4f74-9297-ef9c11144e80", "documentation": "Update a security entry owned by the analysis template.", "method": "put", "endpoint": "analysistemplates/:webId/securityentries/:name", "responses": [ { "uuid": "344c13bb-abf6-4362-b77a-716ac5852e0f", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "47eeb106-73bf-4f09-9790-16a7839f36bb", "documentation": "Retrieve an Asset Database by path.", "method": "get", "endpoint": "assetdatabases", "responses": [ { "uuid": "645868b5-d300-4a47-8a66-76284783704d", "body": "{\n \"Description\": \"PI BI Project Asset Model\",\n \"ExtendedProperties\": {},\n \"Id\": \"a3a5ebaa-37ae-42dc-9d1e-b6bb7ec98bd2\",\n \"Links\": {\n \"AnalysisCategories\": \"\",\n \"AnalysisTemplates\": \"\",\n \"AssetServer\": \"\",\n \"AttributeCategories\": \"\",\n \"ElementCategories\": \"\",\n \"ElementTemplates\": \"\",\n \"Elements\": \"\",\n \"EnumerationSets\": \"\",\n \"EventFrames\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"TableCategories\": \"\",\n \"Tables\": \"\"\n },\n \"Name\": \"MyDatabase\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1RDDqD5loBNH0erqeqJodtALAquulo6433EKdHra7fsmL0g\"\n}", "latency": 0, "statusCode": 200, "label": "The specified database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "79026ff5-36f3-4500-9be7-0f02c2e9b4a0", "documentation": "Delete an asset database.", "method": "delete", "endpoint": "assetdatabases/:webId", "responses": [ { "uuid": "523672b6-d458-4be4-9829-9c0072ee2356", "body": "", "latency": 0, "statusCode": 204, "label": "The database was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fd07b0d8-a91c-4bb2-b300-a58864df882b", "documentation": "Retrieve an Asset Database.", "method": "get", "endpoint": "assetdatabases/:webId", "responses": [ { "uuid": "3d67dbf2-33ce-471e-a648-f6a1efe229f0", "body": "{\n \"Description\": \"PI BI Project Asset Model\",\n \"ExtendedProperties\": {},\n \"Id\": \"a3a5ebaa-37ae-42dc-9d1e-b6bb7ec98bd2\",\n \"Links\": {\n \"AnalysisCategories\": \"\",\n \"AnalysisTemplates\": \"\",\n \"AssetServer\": \"\",\n \"AttributeCategories\": \"\",\n \"ElementCategories\": \"\",\n \"ElementTemplates\": \"\",\n \"Elements\": \"\",\n \"EnumerationSets\": \"\",\n \"EventFrames\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"TableCategories\": \"\",\n \"Tables\": \"\"\n },\n \"Name\": \"MyDatabase\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1RDDqD5loBNH0erqeqJodtALAquulo6433EKdHra7fsmL0g\"\n}", "latency": 0, "statusCode": 200, "label": "The specified database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6d3ede82-7f5f-4536-94bc-53c05dbfb095", "documentation": "Update an asset database by replacing items in its definition.", "method": "patch", "endpoint": "assetdatabases/:webId", "responses": [ { "uuid": "726aef2a-4996-4b57-9740-97c527d1d770", "body": "", "latency": 0, "statusCode": 204, "label": "The database was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fb3777f0-2496-464e-859c-a1df00b39bbd", "documentation": "Retrieve analyses based on the specified conditions.", "method": "get", "endpoint": "assetdatabases/:webId/analyses", "responses": [ { "uuid": "7c7ef58c-2ef9-4bf7-a71f-2f073aced371", "body": "{\n \"Items\": [\n {\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"AutoCreated\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotification\": {{faker 'datatype.boolean'}},\n \"HasTarget\": true,\n \"HasTemplate\": {{faker 'datatype.boolean'}},\n \"Id\": \"11853358-94bf-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsTimeRuleDefinedByTemplate\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"Template\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"MaximumQueueSize\": {{faker 'datatype.number'}},\n \"Name\": \"MyAnalysis\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\",\n \"Priority\": \"High\",\n \"PublishResults\": {{faker 'datatype.boolean'}},\n \"Status\": \"Disabled\",\n \"TargetWebId\": \"I1ETDqD5loBNH0erqeqJodtALAjFPVfUpY-02A8uioGDSgIg\",\n \"TemplateName\": \"\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of analyses matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "69ade403-b8b9-46f3-bd92-c715a4e6b829", "documentation": "Retrieve analysis categories for a given Asset Database.", "method": "get", "endpoint": "assetdatabases/:webId/analysiscategories", "responses": [ { "uuid": "1116b200-3b52-49ca-8f92-209c61979547", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"f9364aa2-0e4a-4854-9b85-35900a4d4c0f\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAnalysis[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XCDqD5loBNH0erqeqJodtALAoko2-UoOVEibhTWQCk1MDw\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The analysis categories that exist in the database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a0bb23bc-29ae-4397-8b8b-42989b6a3bac", "documentation": "Create an analysis category at the Asset Database root.", "method": "post", "endpoint": "assetdatabases/:webId/analysiscategories", "responses": [ { "uuid": "eb2ae978-9033-4589-a910-9a83b5acb95d", "body": "", "latency": 0, "statusCode": 201, "label": "The analysis category was created. The response's Location header is a link to the analysis category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0c3fa68a-585f-440c-802d-94676cfa7172", "documentation": "Retrieve analysis templates based on the specified criteria. By default, all analysis templates in the specified Asset Database are returned.", "method": "get", "endpoint": "assetdatabases/:webId/analysistemplates", "responses": [ { "uuid": "d67e0736-e2fb-4a42-b905-60629d9092ba", "body": "{\n \"Items\": [\n {\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"CreateEnabled\": true,\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotificationTemplate\": {{faker 'datatype.boolean'}},\n \"HasTarget\": {{faker 'datatype.boolean'}},\n \"Id\": \"612d9811-3f06-4e27-989c-42e5e5c00b88\",\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"Name\": \"MyAnalysisTemplate\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\AnalysisTemplates[MyAnalysisTemplate]\",\n \"TargetName\": \"MyElementTemplate\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of analysis templates matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b841ea9f-4a10-4020-ae34-87caffad10e7", "documentation": "Create an analysis template at the Asset Database root.", "method": "post", "endpoint": "assetdatabases/:webId/analysistemplates", "responses": [ { "uuid": "1abebe68-f91d-4931-94f3-615bf1fc9e65", "body": "", "latency": 0, "statusCode": 201, "label": "The analysis template was created. The response's Location header is a link to the created template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "63f7f4c8-8420-4396-9ec2-183e3aa30cdf", "documentation": "Retrieve attribute categories for a given Asset Database.", "method": "get", "endpoint": "assetdatabases/:webId/attributecategories", "responses": [ { "uuid": "d1d2e552-8668-4c69-b019-e5144610355d", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"0520f4a1-4454-4fdc-b476-4d371ea6b59e\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAttribute[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ACDqD5loBNH0erqeqJodtALAofQgBVRE3E-0dk03Hqa1ng\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The attribute categories that exist in the database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "44a5fcf0-f664-4ada-ac90-ea1fa941ef25", "documentation": "Create an attribute category at the Asset Database root.", "method": "post", "endpoint": "assetdatabases/:webId/attributecategories", "responses": [ { "uuid": "d5c92f60-826b-44ce-8911-be04fbb86f6f", "body": "", "latency": 0, "statusCode": 201, "label": "The attribute category was created. The response's Location header is a link to the attribute category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "befd9f45-0dbf-4236-aa60-39d0ca3c4092", "documentation": "Retrieves a list of element attributes matching the specified filters from the specified asset database.", "method": "get", "endpoint": "assetdatabases/:webId/elementattributes", "responses": [ { "uuid": "811e20ba-7424-49ae-9534-3a8cd63a84b7", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "a list of matching attributes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "98eea03f-b21f-4608-bdb0-961e54740b10", "documentation": "Retrieve element categories for a given Asset Database.", "method": "get", "endpoint": "assetdatabases/:webId/elementcategories", "responses": [ { "uuid": "2f777b02-ba5a-4614-b611-8032f75c0376", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"3051f943-7e4d-4241-ab9c-450a84c80450\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesElement[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The element categories that exist in the database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e57886d9-1d4b-4194-b820-5e4872be8b83", "documentation": "Create an element category at the Asset Database root.", "method": "post", "endpoint": "assetdatabases/:webId/elementcategories", "responses": [ { "uuid": "e5acb4d3-db9d-480a-8623-6d966a37026a", "body": "", "latency": 0, "statusCode": 201, "label": "The element category was created. The response's Location header is a link to the element category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "626e2916-2e53-4886-bb31-3a390cd01c4f", "documentation": "Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified asset database.", "method": "get", "endpoint": "assetdatabases/:webId/elements", "responses": [ { "uuid": "84f8e3ff-87fc-4807-ac0a-115348f8542c", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of elements matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "da194f09-b860-4fbb-95a8-ed44438d3f39", "documentation": "Create a child element.", "method": "post", "endpoint": "assetdatabases/:webId/elements", "responses": [ { "uuid": "74f3943b-81e5-41d0-886a-4fb4e22f4f2b", "body": "", "latency": 0, "statusCode": 201, "label": "The element was created. The response's Location header is a link to the element.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9216a316-5ee2-4420-9845-d32009e5edd6", "documentation": "Retrieve element templates based on the specified criteria. Only templates of instance type \"Element\" and \"EventFrame\" are returned. By default, all element and event frame templates in the specified Asset Database are returned.", "method": "get", "endpoint": "assetdatabases/:webId/elementtemplates", "responses": [ { "uuid": "dd48c869-0f0c-4d73-b632-b225d4586a25", "body": "{\n \"Items\": [\n {\n \"AllowElementToExtend\": {{faker 'datatype.boolean'}},\n \"BaseTemplate\": \"Equipment\",\n \"CanBeAcknowledged\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Machine MachineName\",\n \"ExtendedProperties\": {},\n \"Id\": \"a7989492-b2ab-4d90-8abb-4c8284353dd6\",\n \"InstanceType\": \"Element\",\n \"Links\": {\n \"AnalysisTemplates\": \"\",\n \"AttributeTemplates\": \"\",\n \"BaseTemplate\": \"\",\n \"BaseTemplates\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"DerivedTemplates\": \"\",\n \"NotificationRuleTemplates\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MachineName\",\n \"NamingPattern\": \"%TEMPLATE%\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[Boiler]\",\n \"Severity\": \"None\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of element templates matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "af896259-4d8c-4ccf-bed3-2208ab955e0a", "documentation": "Create a template at the Asset Database root. Specify InstanceType of \"Element\" or \"EventFrame\" to create element or event frame template respectively. Only these two types of templates can be created.", "method": "post", "endpoint": "assetdatabases/:webId/elementtemplates", "responses": [ { "uuid": "72b8fe4d-e1c3-4567-8634-f353d1c9aac1", "body": "", "latency": 0, "statusCode": 201, "label": "The element template was created. The response's Location header is a link to the created template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9c1d1da4-e39c-4ff7-befa-c3c8c9e3deb9", "documentation": "Retrieve enumeration sets for given asset database.", "method": "get", "endpoint": "assetdatabases/:webId/enumerationsets", "responses": [ { "uuid": "0cedf17a-2cf5-4253-994e-912584b9abfe", "body": "{\n \"Items\": [\n {\n \"Description\": \"Model numbers by brand of vehicle\",\n \"Id\": \"8e77fc4f-ac91-4029-81d6-fb66bd01d431\",\n \"Links\": {\n \"DataServer\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Values\": \"\"\n },\n \"Name\": \"Model Number\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EnumerationSets[Model Number]\",\n \"SerializeDescription\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1MSRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The specified enumeration sets.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7e553032-ef9c-44cd-ad58-c67a6fe44227", "documentation": "Create an enumeration set at the Asset Database.", "method": "post", "endpoint": "assetdatabases/:webId/enumerationsets", "responses": [ { "uuid": "cf8bb66e-22ac-450e-8b15-732b6f7e20a9", "body": "", "latency": 0, "statusCode": 201, "label": "The enumeration set was created. The response's Location header is a link to the created enumeration set.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "23fae479-4b7f-40fb-a9d0-965d7cc45695", "documentation": "Retrieves a list of event frame attributes matching the specified filters from the specified asset database.", "method": "get", "endpoint": "assetdatabases/:webId/eventframeattributes", "responses": [ { "uuid": "f104d834-56f4-4e85-98a2-d78951d26816", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "a list of matching attributes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "66aa0dab-c6b0-4f4f-8a0e-510cb3da088d", "documentation": "Retrieve event frames based on the specified conditions. By default, returns all children of the specified root resource that have been active in the past 8 hours.", "method": "get", "endpoint": "assetdatabases/:webId/eventframes", "responses": [ { "uuid": "45829feb-a055-40b8-8aff-b8a3a8862ab5", "body": "{\n \"Items\": [\n {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of event frames matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "913cd761-9325-494c-bd55-0c7db52dab3c", "documentation": "Create an event frame.", "method": "post", "endpoint": "assetdatabases/:webId/eventframes", "responses": [ { "uuid": "a4a8a073-d4c4-4e9b-946e-450f96b7ab84", "body": "", "latency": 0, "statusCode": 201, "label": "The event frame was created. The response's Location header is a link to the event frame.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "06756482-8c54-4d2a-9c8f-3ab817249a1f", "documentation": "Export the asset database.", "method": "get", "endpoint": "assetdatabases/:webId/export", "responses": [ { "uuid": "606308bb-91a9-4b01-b16c-5dea0bb0b03f", "body": "", "latency": 0, "statusCode": 200, "label": "Database exported. The response body contains the serialized database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0eccc935-83b6-49c4-9f3d-5d3b90f1f643", "documentation": "Import an asset database.", "method": "post", "endpoint": "assetdatabases/:webId/import", "responses": [ { "uuid": "55da6f32-e2ff-4873-8952-996add58b0ac", "body": "", "latency": 0, "statusCode": 200, "label": "Database imported.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "768bf92d-3a08-41c4-b430-4b5578180a32", "documentation": "Remove a reference to an existing element from the specified database.", "method": "delete", "endpoint": "assetdatabases/:webId/referencedelements", "responses": [ { "uuid": "0fad85b8-4e5d-4969-8281-ff2aba22855e", "body": "", "latency": 0, "statusCode": 204, "label": "The referenced element was successfully removed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cb1cde23-2bca-4779-ac6c-b9cdb78df968", "documentation": "Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements at the root level of the asset database.", "method": "get", "endpoint": "assetdatabases/:webId/referencedelements", "responses": [ { "uuid": "e425d483-6167-48f9-997b-ab26c3146121", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of referenced elements matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cd98847c-30a4-4c7d-a89b-fec9c09464a6", "documentation": "Add a reference to an existing element to the specified database.", "method": "post", "endpoint": "assetdatabases/:webId/referencedelements", "responses": [ { "uuid": "242f4459-b5f7-4b8d-8d83-75044abbbb20", "body": "", "latency": 0, "statusCode": 204, "label": "The referenced element was successfully added.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6a008946-42a0-44e0-8eef-b8c32be3965f", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The referenced element already exists in the collection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a864719c-ddc2-4070-9178-41699f99051f", "documentation": "Get the security information of the specified security item associated with the asset database for a specified user.", "method": "get", "endpoint": "assetdatabases/:webId/security", "responses": [ { "uuid": "9c2eebe5-7333-41db-9692-a78b32a07d4c", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bd8508fd-0799-40fe-a65c-8245821190f7", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unsupported security item; an invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "073a36d0-1867-4e60-896c-1a7eb47f0904", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "352f97e3-cc69-45d9-807c-67851d0a6a77", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "dfb09947-ebf2-4afd-bb79-2a55496cf810", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f38187b5-169f-4c2b-aa8a-969f4328ecf0", "documentation": "Retrieve the security entries of the specified security item associated with the asset database based on the specified criteria. By default, all security entries for this asset database are returned.", "method": "get", "endpoint": "assetdatabases/:webId/securityentries", "responses": [ { "uuid": "8eb48888-7aea-4c47-97a6-20bb4a8749ed", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0636e2bd-7078-4f0c-b723-22a4d41d5f14", "documentation": "Create a security entry owned by the asset database.", "method": "post", "endpoint": "assetdatabases/:webId/securityentries", "responses": [ { "uuid": "64f38690-8e1c-428e-a055-a23f28b41071", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7622154c-f3e5-46a4-861c-a8e8ebd3e75b", "documentation": "Delete a security entry owned by the asset database.", "method": "delete", "endpoint": "assetdatabases/:webId/securityentries/:name", "responses": [ { "uuid": "9267c6da-95a9-4a2a-b27a-7da16daa4235", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "543abb54-fdd4-4ab6-b804-074ace6f14c1", "documentation": "Retrieve the security entry of the specified security item associated with the asset database with the specified name.", "method": "get", "endpoint": "assetdatabases/:webId/securityentries/:name", "responses": [ { "uuid": "7aaa81f2-fc86-4ed3-8404-a2fda02e34bd", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3db26880-add6-4225-9a1c-a15165f5c646", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7fda15a2-1a39-4100-831b-bc738116be05", "documentation": "Update a security entry owned by the asset database.", "method": "put", "endpoint": "assetdatabases/:webId/securityentries/:name", "responses": [ { "uuid": "626d8681-b8d2-4a5d-8cf1-bad2e91629cf", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "87ebe38d-2cbb-4f79-aad1-b441630ecce6", "documentation": "Retrieve table categories for a given Asset Database.", "method": "get", "endpoint": "assetdatabases/:webId/tablecategories", "responses": [ { "uuid": "3a0bb22e-7765-4942-bdfd-4326fd30082c", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"89c70cc2-5221-4e77-873f-894a3ea61e7d\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesTable[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The table categories on the specified database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9742ecc5-1672-4978-b4a1-2d74521cf543", "documentation": "Create a table category on the Asset Database.", "method": "post", "endpoint": "assetdatabases/:webId/tablecategories", "responses": [ { "uuid": "06ce67df-0195-48e9-84a1-c9e4a7c50907", "body": "", "latency": 0, "statusCode": 201, "label": "The table category was created. The response's Location header is a link to the table category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "97d8dcbb-c5f2-4689-b2cc-d4b93c301fc4", "documentation": "Retrieve tables for given Asset Database.", "method": "get", "endpoint": "assetdatabases/:webId/tables", "responses": [ { "uuid": "685e1f28-2454-4626-96e0-0ae6b75009d9", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Table Category\"\n ],\n \"ConvertToLocalTime\": \"false\",\n \"Description\": \"Table of car info.\",\n \"Id\": \"5ff8ba98-89ce-479a-b29e-ddd057096a5f\",\n \"Links\": {\n \"Categories\": \"\",\n \"Data\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CarInfo\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\Tables[CarInfo]\",\n \"TimeZone\": \"Eastern Standard Time\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1BlDqD5loBNH0erqeqJodtALAmLr4X86Jmkeynt3QVwlqXw\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The tables on the specified database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "79ea3910-b488-4136-828b-a26481aac6a9", "documentation": "Create a table on the Asset Database.", "method": "post", "endpoint": "assetdatabases/:webId/tables", "responses": [ { "uuid": "669e9fb3-7357-4aa8-873c-1ae6daf68194", "body": "", "latency": 0, "statusCode": 201, "label": "The table was created. The response's Location header is a link to the created table.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "753c59b8-d57f-41f8-9342-8418d0dc42a3", "documentation": "Retrieve a list of all Asset Servers known to this service.", "method": "get", "endpoint": "assetservers", "responses": [ { "uuid": "09a8bb34-463a-45d5-b68f-201385e100f4", "body": "{\n \"Items\": [\n {\n \"Description\": \"Sample Description\",\n \"ExtendedProperties\": {},\n \"Id\": \"96f9a00e-4d80-471f-aba9-ea89a1db402c\",\n \"IsConnected\": true,\n \"Links\": {\n \"AnalysisRulePlugIns\": \"\",\n \"Databases\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIns\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentities\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\",\n \"TimeRulePlugIns\": \"\",\n \"UnitClasses\": \"\"\n },\n \"Name\": \"MyAssetServer\",\n \"Path\": \"\\\\\\\\MyAssetServer\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"2.5.0.5039\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1RSDqD5loBNH0erqeqJodtALA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of servers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2c6cbd55-c843-49d7-b84b-f8acafb68fde", "documentation": "Retrieve an Asset Server by name.", "method": "get", "endpoint": "assetservers#name", "responses": [ { "uuid": "ec4272d7-4641-4b5e-81f3-9327494f276d", "body": "{\n \"Description\": \"Sample Description\",\n \"ExtendedProperties\": {},\n \"Id\": \"96f9a00e-4d80-471f-aba9-ea89a1db402c\",\n \"IsConnected\": true,\n \"Links\": {\n \"AnalysisRulePlugIns\": \"\",\n \"Databases\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIns\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentities\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\",\n \"TimeRulePlugIns\": \"\",\n \"UnitClasses\": \"\"\n },\n \"Name\": \"MyAssetServer\",\n \"Path\": \"\\\\\\\\MyAssetServer\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"2.5.0.5039\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1RSDqD5loBNH0erqeqJodtALA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested server.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1959409d-4682-4082-9a13-11af17d6d073", "documentation": "Retrieve an Asset Server by path.", "method": "get", "endpoint": "assetservers#path", "responses": [ { "uuid": "e24362e6-8391-43bd-8db1-651d366d9544", "body": "{\n \"Description\": \"Sample Description\",\n \"ExtendedProperties\": {},\n \"Id\": \"96f9a00e-4d80-471f-aba9-ea89a1db402c\",\n \"IsConnected\": true,\n \"Links\": {\n \"AnalysisRulePlugIns\": \"\",\n \"Databases\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIns\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentities\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\",\n \"TimeRulePlugIns\": \"\",\n \"UnitClasses\": \"\"\n },\n \"Name\": \"MyAssetServer\",\n \"Path\": \"\\\\\\\\MyAssetServer\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"2.5.0.5039\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1RSDqD5loBNH0erqeqJodtALA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested server.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8c817866-ae99-4a27-8ed1-11de187b246e", "documentation": "Retrieve an Asset Server.", "method": "get", "endpoint": "assetservers/:webId", "responses": [ { "uuid": "1814c08e-2ac5-4c92-a396-a2f64c9596a9", "body": "{\n \"Description\": \"Sample Description\",\n \"ExtendedProperties\": {},\n \"Id\": \"96f9a00e-4d80-471f-aba9-ea89a1db402c\",\n \"IsConnected\": true,\n \"Links\": {\n \"AnalysisRulePlugIns\": \"\",\n \"Databases\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIns\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentities\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\",\n \"TimeRulePlugIns\": \"\",\n \"UnitClasses\": \"\"\n },\n \"Name\": \"MyAssetServer\",\n \"Path\": \"\\\\\\\\MyAssetServer\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"2.5.0.5039\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1RSDqD5loBNH0erqeqJodtALA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested server.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "09f13c33-d4b1-47f0-b56e-7c5ad942ec22", "documentation": "Retrieve a list of all Analysis Rule Plug-in's.", "method": "get", "endpoint": "assetservers/:webId/analysisruleplugins", "responses": [ { "uuid": "b2f5a533-32f6-45a2-8b11-055a7699a9ec", "body": "{\n \"Items\": [\n {\n \"AssemblyFileName\": \"OSIsoft.AF.Analysis.AnalysisRule.Imbalance.dll\",\n \"AssemblyID\": \"1acd00c2-79d0-4818-a03c-0616c4513750\",\n \"AssemblyLoadProperties\": [\n \"None\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Calculates simple material imbalances on nodes of a model.\",\n \"Id\": \"9a2a6c05-6f61-467a-854a-16dbfb9d8c03\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"Imbalance\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsAnalysisRule[Imbalance]\",\n \"Version\": \"2.8.5.7552\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XPDqD5loBNH0erqeqJodtALABWwqmmFvekaFShbb-52MAw\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of Analysis Rule Plug-in's.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fd05f1b7-3a0b-4f2f-9bf8-e8259f7fe50d", "documentation": "Retrieve a list of all Asset Databases on the specified Asset Server.", "method": "get", "endpoint": "assetservers/:webId/assetdatabases", "responses": [ { "uuid": "4cae31af-71b9-441e-ab90-9a6020805aab", "body": "{\n \"Items\": [\n {\n \"Description\": \"PI BI Project Asset Model\",\n \"ExtendedProperties\": {},\n \"Id\": \"a3a5ebaa-37ae-42dc-9d1e-b6bb7ec98bd2\",\n \"Links\": {\n \"AnalysisCategories\": \"\",\n \"AnalysisTemplates\": \"\",\n \"AssetServer\": \"\",\n \"AttributeCategories\": \"\",\n \"ElementCategories\": \"\",\n \"ElementTemplates\": \"\",\n \"Elements\": \"\",\n \"EnumerationSets\": \"\",\n \"EventFrames\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"TableCategories\": \"\",\n \"Tables\": \"\"\n },\n \"Name\": \"MyDatabase\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1RDDqD5loBNH0erqeqJodtALAquulo6433EKdHra7fsmL0g\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of databases.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "65d31652-ce32-47cb-a485-96368c74c580", "documentation": "Create an asset database.", "method": "post", "endpoint": "assetservers/:webId/assetdatabases", "responses": [ { "uuid": "33633050-e56b-478d-9bdb-579163f9b351", "body": "", "latency": 0, "statusCode": 201, "label": "The database was created. The response's Location header is a link to the database.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d6eb7fa9-01ad-4612-b9df-93941c8b8d32", "documentation": "Retrieve a list of all notification contact templates on the specified Asset Server.", "method": "get", "endpoint": "assetservers/:webId/notificationcontacttemplates", "responses": [ { "uuid": "14418a2f-9cba-47e0-8807-08918c6c2c5b", "body": "{\n \"Items\": [\n {\n \"Available\": true,\n \"ConfigString\": \"\",\n \"ContactType\": \"Individual\",\n \"Description\": \"\",\n \"EscalationTimeout\": \"PT3S\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIn\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"MaximumRetries\": 5,\n \"MinimumAcknowledgements\": 2,\n \"Name\": \"Plant Manager\",\n \"NotifyWhenInstanceEnded\": true,\n \"Path\": \"\\\\\\\\MyAssetServer\\\\NotificationContactTemplates[Plant Manager]\",\n \"PlugInName\": \"\",\n \"RetryInterval\": \"PT5S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NCEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification contact templates.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c2076b56-306c-4c93-b3bb-776e6d9d73c9", "documentation": "Create a notification contact template.", "method": "post", "endpoint": "assetservers/:webId/notificationcontacttemplates", "responses": [ { "uuid": "98fc7410-aa8e-4a21-bdad-e89c7f2d7b10", "body": "", "latency": 0, "statusCode": 201, "label": "The notification contact template was created. The response's Location header is a link to the notification contact template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b3a2c3d8-55bc-4f7a-9f29-3983c98af7fb", "documentation": "Retrieve a list of all notification plugins on the specified Asset Server.", "method": "get", "endpoint": "assetservers/:webId/notificationplugins", "responses": [ { "uuid": "01c556c8-74cb-4cdd-ad44-4720178da0e8", "body": "{\n \"Items\": [\n {\n \"AssemblyFileName\": \"OSIsoft.AF.Notification.DeliveryChannel.WebService.dll\",\n \"AssemblyID\": \"0b450496-63f6-4207-b4c5-2c1c73ca897a\",\n \"AssemblyLoadProperties\": [\n \"NET4\",\n \"SDK_NET4\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Delivery channel for calling a web service\",\n \"Id\": \"145c35d6-f4d7-41d9-86ae-08e5098d3a96\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"WebService\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsDeliveryChannel[WebService]\",\n \"Version\": \"2.10.0.8516\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"F1DCDqD5loBNH0erqeqJodtALA1jVcFNf02UGGrgjlCY06lgUkVTVFVOSVRcUExVR0lOU0RFTElWRVJZQ0hBTk5FTFtXRUJTRVJWSUNFXQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification delivery channel plugins.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b725e4e2-c2df-4b5a-b3cc-836ac27355b3", "documentation": "Get the security information of the specified security item associated with the asset server for a specified user.", "method": "get", "endpoint": "assetservers/:webId/security", "responses": [ { "uuid": "73bfd272-976c-44f6-aeeb-3a1ac460eef6", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "20320c86-331e-4678-b4d0-85e8967efadb", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unsupported security item; an invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b9dc2efd-e783-4493-ad68-5f268b247db4", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "36ea5e17-d5ed-4047-85ad-e2ae3bbd7373", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "32c52b9d-c736-4cdb-8abf-244292c98f86", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0d0558e9-a6f3-4207-afae-cbc179921ecf", "documentation": "Retrieve the security entries of the specified security item associated with the asset server based on the specified criteria. By default, all security entries for this asset server are returned.", "method": "get", "endpoint": "assetservers/:webId/securityentries", "responses": [ { "uuid": "360ebd0e-bd46-424e-838b-1111e35db43e", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b31bdae9-ecfe-4471-8494-29c8644c5970", "documentation": "Create a security entry owned by the asset server.", "method": "post", "endpoint": "assetservers/:webId/securityentries", "responses": [ { "uuid": "69e25e53-c5fe-403a-a37f-1f561d8520e6", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "86451d04-bd4b-4bb0-84b4-750c8e039dd6", "documentation": "Delete a security entry owned by the asset server.", "method": "delete", "endpoint": "assetservers/:webId/securityentries/:name", "responses": [ { "uuid": "256565b5-4f95-4113-852c-cb578876f323", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "55a612f3-0e95-4643-b07a-4a3d71270c4b", "documentation": "Retrieve the security entry of the specified security item associated with the asset server with the specified name.", "method": "get", "endpoint": "assetservers/:webId/securityentries/:name", "responses": [ { "uuid": "a470bcc7-bc93-4092-95f4-d6666779df13", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2adbf6c6-013e-4125-841a-3c2804b0885c", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9748b46d-5a0c-40d6-a106-c6eadbcc470a", "documentation": "Update a security entry owned by the asset server.", "method": "put", "endpoint": "assetservers/:webId/securityentries/:name", "responses": [ { "uuid": "da7d64d0-9a1f-4f19-a9a8-e44409f49590", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "95f50628-f8b0-4f4f-99fc-bdde290ddc36", "documentation": "Retrieve security identities based on the specified criteria. By default, all security identities in the specified Asset Server are returned.", "method": "get", "endpoint": "assetservers/:webId/securityidentities", "responses": [ { "uuid": "ca26488a-2d89-45bf-a9bf-b65d40fd479d", "body": "{\n \"Items\": [\n {\n \"Description\": \"\",\n \"Id\": \"f3a5ee49-1838-4aa2-9d79-e16294523db7\",\n \"IsEnabled\": true,\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityIdentity\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityIdentities[MySecurityIdentity]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security identities matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a53ef718-dd6d-4f2b-afe3-b909b6542210", "documentation": "Create a security identity.", "method": "post", "endpoint": "assetservers/:webId/securityidentities", "responses": [ { "uuid": "09d1fc69-ab2b-47f8-8c8d-f6d8fcb9b3f9", "body": "", "latency": 0, "statusCode": 201, "label": "The security identity was created. The response's Location header is a link to the security identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fe103577-8cd6-498d-ae74-1e8c734f503b", "documentation": "Retrieve security identities for a specific user.", "method": "get", "endpoint": "assetservers/:webId/securityidentities#userIdentity", "responses": [ { "uuid": "234041a0-31d9-4cd6-8781-f610ab8b8d6c", "body": "{\n \"Items\": [\n {\n \"Description\": \"\",\n \"Id\": \"f3a5ee49-1838-4aa2-9d79-e16294523db7\",\n \"IsEnabled\": true,\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityIdentity\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityIdentities[MySecurityIdentity]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security identities for the specified user.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "75b7f5bd-0de8-42fb-9210-82d13b8c705e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Unsupported security item; an invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1e94597b-40ce-4ae0-b523-00839a17249d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "58e91990-510e-44f1-bf0e-bf30ebec4df4", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4369efb2-6bee-464c-9586-4c8bfcfda33f", "documentation": "Retrieve security mappings based on the specified criteria. By default, all security mappings in the specified Asset Server are returned.", "method": "get", "endpoint": "assetservers/:webId/securitymappings", "responses": [ { "uuid": "9c18e10d-4c6e-45b9-a984-e2e15f66d1fe", "body": "{\n \"Items\": [\n {\n \"Account\": \"domain\\\\user\",\n \"Description\": \"\",\n \"Id\": \"ac14ef82-19c0-4a07-96a7-d1fb0b84c05d\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityMapping\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityMappings[MySecurityMapping]\",\n \"SecurityIdentityWebId\": \"I1SIEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SMDqD5loBNH0erqeqJodtALAgu8UrMAZB0qWp9H7C4TAXQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security mappings matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6fe73324-55bd-4ba9-a961-5ec6db1117f6", "documentation": "Create a security mapping.", "method": "post", "endpoint": "assetservers/:webId/securitymappings", "responses": [ { "uuid": "b8a26dda-65ba-4019-aa69-dd600f46830f", "body": "", "latency": 0, "statusCode": 201, "label": "The security mapping was created. The response's Location header is a link to the security mapping.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "088050d3-9cb0-4a69-aa4a-e02fe3322777", "documentation": "Retrieve a list of all Time Rule Plug-in's.", "method": "get", "endpoint": "assetservers/:webId/timeruleplugins", "responses": [ { "uuid": "4d313eb7-4325-4365-ad93-c904d846e786", "body": "{\n \"Items\": [\n {\n \"AssemblyFileName\": \"OSIsoft.AF.Time.TimeRule.Periodic.dll\",\n \"AssemblyID\": \"7a635b27-3c3c-4a5f-bba9-01f06e9e525b\",\n \"AssemblyLoadProperties\": [\n \"None\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Creates regular periodic time periods.\",\n \"Id\": \"d655f414-9655-4ad6-a615-182fa38200c1\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"Periodic\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsTimeRule[Periodic]\",\n \"Version\": \"2.8.5.7552\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1TPDqD5loBNH0erqeqJodtALAFPRV1lWW1kqmFRgvo4IAwQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of Time Rule Plug-in's.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "477af266-7c17-4112-b74a-39d3f56c3382", "documentation": "Retrieve a list of all unit classes on the specified Asset Server.", "method": "get", "endpoint": "assetservers/:webId/unitclasses", "responses": [ { "uuid": "87d9c053-35a8-4796-8815-5a25dff641ba", "body": "{\n \"Items\": [\n {\n \"CanonicalUnitAbbreviation\": \"W\",\n \"CanonicalUnitName\": \"watt\",\n \"Description\": \"Power Unit Class\",\n \"Id\": \"f925b94d-6efc-4b94-a50d-0015c391f249\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"CanonicalUnit\": \"\",\n \"Self\": \"\",\n \"Units\": \"\"\n },\n \"Name\": \"Power\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\UOMDatabase\\\\UOMClasses[Power]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1UCDqD5loBNH0erqeqJodtALATbkl-fxulEulDQAVw5HySQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of unit classes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3f978b2e-81aa-4746-a68a-4cc04e70a3ee", "documentation": "Create a unit class in the specified Asset Server.", "method": "post", "endpoint": "assetservers/:webId/unitclasses", "responses": [ { "uuid": "9ecce4d1-e546-4887-bf72-12c26841dc88", "body": "", "latency": 0, "statusCode": 201, "label": "The unit class was created. The response's Location header is a link to the unit class.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "86303afb-da32-4a17-8298-87b84cf4e9c2", "documentation": "Retrieve an attribute category by path.", "method": "get", "endpoint": "attributecategories", "responses": [ { "uuid": "b9f01d7c-3c79-42aa-bca2-3938eff25d5d", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"0520f4a1-4454-4fdc-b476-4d371ea6b59e\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAttribute[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ACDqD5loBNH0erqeqJodtALAofQgBVRE3E-0dk03Hqa1ng\"\n}", "latency": 0, "statusCode": 200, "label": "The specified attribute category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d4ed28cd-e333-499d-ae34-8f202a3a0816", "documentation": "Delete an attribute category.", "method": "delete", "endpoint": "attributecategories/:webId", "responses": [ { "uuid": "0b75f7b0-3b36-448b-9d9c-ea069a90f865", "body": "", "latency": 0, "statusCode": 204, "label": "The attribute category was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3728818b-5948-4c91-b052-38ec661e957f", "documentation": "Retrieve an attribute category.", "method": "get", "endpoint": "attributecategories/:webId", "responses": [ { "uuid": "6fe0a2d0-3223-42e1-9e32-840c5b4f7189", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"0520f4a1-4454-4fdc-b476-4d371ea6b59e\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAttribute[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ACDqD5loBNH0erqeqJodtALAofQgBVRE3E-0dk03Hqa1ng\"\n}", "latency": 0, "statusCode": 200, "label": "The specified attribute category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ffbec48f-ec86-40f6-a061-1ae299429b58", "documentation": "Update an attribute category by replacing items in its definition.", "method": "patch", "endpoint": "attributecategories/:webId", "responses": [ { "uuid": "f2d9c474-8d7d-45fb-bd4c-7937eb3b5797", "body": "", "latency": 0, "statusCode": 204, "label": "The attribute category was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "222fc1f3-f80c-4a7c-8619-7f1651bef134", "documentation": "Get the security information of the specified security item associated with the attribute category for a specified user.", "method": "get", "endpoint": "attributecategories/:webId/security", "responses": [ { "uuid": "fc34f8b5-50f8-4d9c-9201-5c4cdc1cc163", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b84f0e63-473d-4a7f-85d6-627c6710e285", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "23155df9-6c76-4cfa-b0cf-92877008fcee", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ee1695ee-a05f-4e6e-9501-e634c3de5003", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "705cbf7e-37cc-4468-bb3c-b5ca69b55814", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "aeaac58c-27d9-4d97-9f43-f89ec710f834", "documentation": "Retrieve the security entries associated with the attribute category based on the specified criteria. By default, all security entries for this attribute category are returned.", "method": "get", "endpoint": "attributecategories/:webId/securityentries", "responses": [ { "uuid": "ab7a5271-5743-463e-a000-6d9551b97c15", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9b0bcb03-3b60-4d53-8cdc-9c3ebba79b96", "documentation": "Create a security entry owned by the attribute category.", "method": "post", "endpoint": "attributecategories/:webId/securityentries", "responses": [ { "uuid": "c7dfb17b-23d7-47f0-83d7-7c0be6b8eb12", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4740dc61-8174-4f09-a69d-bbccbbf439de", "documentation": "Delete a security entry owned by the attribute category.", "method": "delete", "endpoint": "attributecategories/:webId/securityentries/:name", "responses": [ { "uuid": "dafdd58e-0125-48ef-8fcc-79d3a33e57a5", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "61fdb8fb-c092-4a7e-bba3-a8ae49f0beb4", "documentation": "Retrieve the security entry associated with the attribute category with the specified name.", "method": "get", "endpoint": "attributecategories/:webId/securityentries/:name", "responses": [ { "uuid": "641e0fec-8906-4316-8420-4f6b4be3e9af", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "14b4cb3e-ba2e-474e-803c-1ca087523339", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ddbd5f76-167d-4293-a666-f3b4b8526b53", "documentation": "Update a security entry owned by the attribute category.", "method": "put", "endpoint": "attributecategories/:webId/securityentries/:name", "responses": [ { "uuid": "80b03cd8-34b5-4fa8-acc6-df8f3f8cdf51", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fa60e28d-8c84-455d-af67-2621fe324851", "documentation": "Retrieve an attribute by path.", "method": "get", "endpoint": "attributes", "responses": [ { "uuid": "090f02f4-9db0-47b1-a861-0af01ed0fb3e", "body": "{\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n}", "latency": 0, "statusCode": 200, "label": "The requested attribute.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a5131852-8fd7-42fd-834b-be1ad13cedbf", "documentation": "Retrieve multiple attributes by web id or path.", "method": "get", "endpoint": "attributes/multiple", "responses": [ { "uuid": "335a2a65-2c4d-4851-8f3d-7441f8d34cb7", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested attributes", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "64aa0639-03e2-4b37-a4aa-d9013d1ad6d9", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "Some or all items contain exceptions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "38db45aa-606b-44c6-a8b7-b626ff4240f1", "documentation": "Retrieve attributes based on the specified conditions. Returns attributes using the specified search query string.", "method": "get", "endpoint": "attributes/search", "responses": [ { "uuid": "ff38dc32-bdd6-4450-be54-4dc7f1f819d2", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of attributes matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e3b31386-da2f-469e-a26a-d1e3c39a1957", "documentation": "Delete an attribute.", "method": "delete", "endpoint": "attributes/:webId", "responses": [ { "uuid": "79cb70be-68eb-44a8-ad8d-9737b961731a", "body": "", "latency": 0, "statusCode": 204, "label": "The attribute was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "43c70bf5-4cea-4b91-9050-6234a1fe48b3", "documentation": "Retrieve an attribute.", "method": "get", "endpoint": "attributes/:webId", "responses": [ { "uuid": "ad022a6a-7c16-47c1-ab70-e1b39a76ead6", "body": "{\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n}", "latency": 0, "statusCode": 200, "label": "The requested attribute.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f37f2c9c-b175-42cb-b968-83af7766b9a7", "documentation": "Update an attribute by replacing items in its definition.", "method": "patch", "endpoint": "attributes/:webId", "responses": [ { "uuid": "9681aacd-a603-4fcc-8998-0146ad6dff28", "body": "", "latency": 0, "statusCode": 204, "label": "The attribute was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "04e62825-b5ca-402b-aba9-3ae60a21a80a", "documentation": "Get the child attributes of the specified attribute.", "method": "get", "endpoint": "attributes/:webId/attributes", "responses": [ { "uuid": "a981355b-c36a-451e-a623-58a48524d4cf", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of child attributes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "46d6a3a5-566d-4c70-b191-043eddc0bcc9", "documentation": "Create a new attribute as a child of the specified attribute.", "method": "post", "endpoint": "attributes/:webId/attributes", "responses": [ { "uuid": "0fac978e-26aa-49ce-a6b6-b28802b1b904", "body": "", "latency": 0, "statusCode": 201, "label": "The attribute was created. The response's Location header is a link to the created attribute.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "75d12831-1b48-4a0c-9c91-8a3985332304", "documentation": "Get an attribute's categories.", "method": "get", "endpoint": "attributes/:webId/categories", "responses": [ { "uuid": "9f87195a-999b-4ba3-8d61-5e16fcc760cf", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"0520f4a1-4454-4fdc-b476-4d371ea6b59e\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAttribute[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ACDqD5loBNH0erqeqJodtALAofQgBVRE3E-0dk03Hqa1ng\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cf6e646d-495f-4a0a-b7eb-478a7ed0e446", "documentation": "Create or update an attribute's DataReference configuration (Create/Update PI point for PI Point DataReference).", "method": "post", "endpoint": "attributes/:webId/config", "responses": [ { "uuid": "3e97119a-f8ba-4fb9-a950-fee0616d22fe", "body": "", "latency": 0, "statusCode": 201, "label": "The attribute's DataReference configuration was created or updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1d4c5516-7f93-4391-bb38-51ec625d6c08", "documentation": "Get the attribute's value. This call is intended for use with attributes that have no data reference only. For attributes with a data reference, consult the documentation for Streams.", "method": "get", "endpoint": "attributes/:webId/value", "responses": [ { "uuid": "8318a4b9-2ac1-4117-9703-7703e886dd49", "body": "{\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The attribute's value.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5b395886-4b30-439c-a44a-6fbc0fdae73f", "documentation": "Set the value of a configuration item attribute. For attributes with a data reference or non-configuration item attributes, consult the documentation for streams.", "method": "put", "endpoint": "attributes/:webId/value", "responses": [ { "uuid": "55d03965-98fb-4e08-89ff-5ad3d216b54f", "body": "", "latency": 0, "statusCode": 204, "label": "The value was set successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cceaa0db-d4d8-4c81-ada2-00d434bd0631", "documentation": "Retrieve an attribute template by path.", "method": "get", "endpoint": "attributetemplates", "responses": [ { "uuid": "b3b12dd9-a221-4a0b-b326-09e29e19f4fc", "body": "{\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"DefaultValue\": {},\n \"Description\": \"2008 Water Use\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"23d027b5-5dd5-41c5-80f1-f8b5c9ff4356\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AttributeTemplates\": \"\",\n \"Categories\": \"\",\n \"ElementTemplate\": \"\",\n \"Parent\": \"\",\n \"Self\": \"\",\n \"Trait\": \"\"\n },\n \"Name\": \"Water(2008)\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[MachineName]|Water(2008)\",\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ATEG_auSSsvuECG8ad_p8b25QQkxqWDwIWU6zC4vmgpd4kgtSfQI9VdxUGA8fi1yf9DVg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified attribute template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "41360504-cb61-4df2-82e6-c0280846ea44", "documentation": "Delete an attribute template.", "method": "delete", "endpoint": "attributetemplates/:webId", "responses": [ { "uuid": "53cd38d0-f758-4e12-ab82-eab960447618", "body": "", "latency": 0, "statusCode": 204, "label": "The attribute template was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "825f7780-4e83-443c-9fc8-2c20d862cfc7", "documentation": "Retrieve an attribute template.", "method": "get", "endpoint": "attributetemplates/:webId", "responses": [ { "uuid": "e29872e4-88f9-4c5d-8b37-51edc874bb3d", "body": "{\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"DefaultValue\": {},\n \"Description\": \"2008 Water Use\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"23d027b5-5dd5-41c5-80f1-f8b5c9ff4356\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AttributeTemplates\": \"\",\n \"Categories\": \"\",\n \"ElementTemplate\": \"\",\n \"Parent\": \"\",\n \"Self\": \"\",\n \"Trait\": \"\"\n },\n \"Name\": \"Water(2008)\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[MachineName]|Water(2008)\",\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ATEG_auSSsvuECG8ad_p8b25QQkxqWDwIWU6zC4vmgpd4kgtSfQI9VdxUGA8fi1yf9DVg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified attribute template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "79da1732-c68e-4cdf-9451-fcfa3e4cf95a", "documentation": "Update an existing attribute template by replacing items in its definition.", "method": "patch", "endpoint": "attributetemplates/:webId", "responses": [ { "uuid": "5917b0cb-9dab-4105-8e9e-5748a735cb7e", "body": "", "latency": 0, "statusCode": 204, "label": "The attribute template was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d5711657-2a6d-4a62-a110-8a743401ed20", "documentation": "Retrieve an attribute template's child attribute templates.", "method": "get", "endpoint": "attributetemplates/:webId/attributetemplates", "responses": [ { "uuid": "bafaea86-a259-411b-ac7a-ea4b170a0e3d", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"DefaultValue\": {},\n \"Description\": \"2008 Water Use\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"23d027b5-5dd5-41c5-80f1-f8b5c9ff4356\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AttributeTemplates\": \"\",\n \"Categories\": \"\",\n \"ElementTemplate\": \"\",\n \"Parent\": \"\",\n \"Self\": \"\",\n \"Trait\": \"\"\n },\n \"Name\": \"Water(2008)\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[MachineName]|Water(2008)\",\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ATEG_auSSsvuECG8ad_p8b25QQkxqWDwIWU6zC4vmgpd4kgtSfQI9VdxUGA8fi1yf9DVg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of child attribute templates.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cdba08eb-cbbc-4def-9760-a5c7d151dc96", "documentation": "Create an attribute template as a child of another attribute template.", "method": "post", "endpoint": "attributetemplates/:webId/attributetemplates", "responses": [ { "uuid": "6e6baf77-9ce9-4ce8-a8f9-919b45719d95", "body": "", "latency": 0, "statusCode": 201, "label": "The attribute template was created. The response's Location header is a link to the created resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0020b5a6-f037-4f67-81e2-17cc312d4f5d", "documentation": "Get an attribute template's categories.", "method": "get", "endpoint": "attributetemplates/:webId/categories", "responses": [ { "uuid": "62a6c5ff-fb76-4d4b-a642-b8aa13d443b5", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"0520f4a1-4454-4fdc-b476-4d371ea6b59e\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesAttribute[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ACDqD5loBNH0erqeqJodtALAofQgBVRE3E-0dk03Hqa1ng\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5cef6676-0741-41b4-ac14-e7b4e3ed63f6", "documentation": "Retrieve all attribute traits of the specified category/categories.", "method": "get", "endpoint": "attributetraits", "responses": [ { "uuid": "e20f51bb-5ad3-4c95-9738-0ec3ed50b417", "body": "{\n \"Items\": [\n {\n \"Abbreviation\": \"LoLo\",\n \"AllowChildAttributes\": \"false\",\n \"AllowDuplicates\": \"false\",\n \"IsAllowedOnRootAttribute\": \"false\",\n \"IsTypeInherited\": \"true\",\n \"IsUOMInherited\": \"true\",\n \"Links\": {\n \"Self\": \"\"\n },\n \"Name\": \"LimitLoLo\",\n \"RequireNumeric\": \"true\",\n \"RequireString\": \"false\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of attribute traits.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c075a6aa-196e-41d2-ae62-a860922cf09c", "documentation": "Retrieve an attribute trait.", "method": "get", "endpoint": "attributetraits/:name", "responses": [ { "uuid": "989c8571-fcf9-4893-8e27-9c97bce34b6a", "body": "{\n \"Abbreviation\": \"LoLo\",\n \"AllowChildAttributes\": \"false\",\n \"AllowDuplicates\": \"false\",\n \"IsAllowedOnRootAttribute\": \"false\",\n \"IsTypeInherited\": \"true\",\n \"IsUOMInherited\": \"true\",\n \"Links\": {\n \"Self\": \"\"\n },\n \"Name\": \"LimitLoLo\",\n \"RequireNumeric\": \"true\",\n \"RequireString\": \"false\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested attribute trait.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "99f5e1fc-cab6-498d-a3a7-4b33854c387f", "documentation": "Execute a batch of requests against the service. As shown in the Sample Request, the input is a dictionary with IDs as keys and request objects as values. Each request object specifies the HTTP method and the resource and, optionally, the content and a list of parent IDs. The list of parent IDs specifies which other requests must complete before the given request will be executed. The example first creates an element, then gets the element by the response's Location header, then creates an attribute for the element. Note that the resource can be an absolute URL or a JsonPath that references the response to the parent request. The batch's response is a dictionary uses keys corresponding those provided in the request, with response objects containing a status code, response headers, and the response body. A request can alternatively specify a request template in place of a resource. In this case, a single JsonPath may select multiple tokens, and a separate subrequest will be made from the template for each token. The responses of these subrequests will returned as the content of a single outer response.", "method": "post", "endpoint": "batch", "responses": [ { "uuid": "962f75fa-ed47-4589-a0b5-baa42b78af16", "body": "{}", "latency": 0, "statusCode": 207, "label": "A dictionary of response information corresponding to the batched requests.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4d9151ee-fe48-4077-a29d-f81c2dede077", "documentation": "Returns results of evaluating the expression over the time range from the start time to the end time at a defined interval.", "method": "get", "endpoint": "calculation/intervals", "responses": [ { "uuid": "3a39aed6-9df7-4a37-b09b-bd6392fb0b77", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The calculated values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "226a915f-f198-43a1-80be-0f16ce00f101", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The targeted object does not support the calculation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7fc2447b-7026-412e-b07e-99920070642d", "documentation": "Returns the result of evaluating the expression at each point in time over the time range from the start time to the end time where a recorded value exists for a member of the expression.", "method": "get", "endpoint": "calculation/recorded", "responses": [ { "uuid": "9a3ad8c0-8076-4088-ae33-71244a4c0489", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The calculated values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e1117e73-6b4d-4b0b-a4f3-b32981752897", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The targeted object does not support the calculation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "cb006be5-62db-48bf-b0dc-d2c08613aa1a", "documentation": "Returns the result of evaluating the expression over the time range from the start time to the end time. The time range is first divided into a number of summary intervals. Then the calculation is performed for the specified summaries over each interval.", "method": "get", "endpoint": "calculation/summary", "responses": [ { "uuid": "2f517993-e323-404a-9f1f-a8b805c2d085", "body": "{\n \"Items\": [\n {\n \"Type\": \"Total\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The calculated values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "182785c8-8b35-4d10-8550-35ba9792d130", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The targeted object does not support the calculation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2c171aa8-903f-4c7c-b551-c4ff70137cd2", "documentation": "Returns the result of evaluating the expression at the specified timestamps.", "method": "get", "endpoint": "calculation/times", "responses": [ { "uuid": "d48d6356-6788-4804-bc76-a96ce0934731", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The calculated values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "abed44c9-db46-4fdf-bd07-810cf44f7f83", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The targeted object does not support the calculation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bd722958-d7f7-48c4-bad1-f58216f93601", "documentation": "Retrieves a list of currently running channel instances.", "method": "get", "endpoint": "channels/instances", "responses": [ { "uuid": "be820113-2dca-469a-ac51-6687e2fee801", "body": "{\n \"Items\": [\n {\n \"Id\": \"\",\n \"LastMessageSentTime\": \"\",\n \"SentMessageCount\": {{faker 'datatype.number'}},\n \"StartTime\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of currently running channel instances.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "20b22739-fd5d-4824-8fba-0ba22bf387a4", "documentation": "Retrieve a list of Data Servers known to this service.", "method": "get", "endpoint": "dataservers", "responses": [ { "uuid": "2defa9bd-a514-4dea-ae73-532603523bc3", "body": "{\n \"Items\": [\n {\n \"Id\": \"85bb49d6-f101-4807-baf9-57c2fbd33000\",\n \"IsConnected\": true,\n \"Links\": {\n \"EnumerationSets\": \"\",\n \"Points\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MyPIServer\",\n \"Path\": \"\\\\\\\\PIServer[MyPIServer]\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"3.4.390.18\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DS1km7hQHxB0i6-VfC-9MwAA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of all known servers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "35bb8e6d-ab81-4368-8e18-6995693ff3ec", "documentation": "Retrieve a Data Server by name.", "method": "get", "endpoint": "dataservers#name", "responses": [ { "uuid": "47aee63f-41ea-4d21-83db-7c4966c9ed8f", "body": "{\n \"Id\": \"85bb49d6-f101-4807-baf9-57c2fbd33000\",\n \"IsConnected\": true,\n \"Links\": {\n \"EnumerationSets\": \"\",\n \"Points\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MyPIServer\",\n \"Path\": \"\\\\\\\\PIServer[MyPIServer]\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"3.4.390.18\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DS1km7hQHxB0i6-VfC-9MwAA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested server.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "04d6ffc8-76dc-418b-aa63-a35240de95e2", "documentation": "Retrieve a Data Server by path.", "method": "get", "endpoint": "dataservers#path", "responses": [ { "uuid": "45604d0d-0f89-4a28-a6cd-ae334ff4fa69", "body": "{\n \"Id\": \"85bb49d6-f101-4807-baf9-57c2fbd33000\",\n \"IsConnected\": true,\n \"Links\": {\n \"EnumerationSets\": \"\",\n \"Points\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MyPIServer\",\n \"Path\": \"\\\\\\\\PIServer[MyPIServer]\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"3.4.390.18\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DS1km7hQHxB0i6-VfC-9MwAA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested server.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e3e729c3-e187-4803-a031-950af975d92a", "documentation": "Retrieve a Data Server.", "method": "get", "endpoint": "dataservers/:webId", "responses": [ { "uuid": "fec9fc75-1cbe-47fd-ab16-e368f570f246", "body": "{\n \"Id\": \"85bb49d6-f101-4807-baf9-57c2fbd33000\",\n \"IsConnected\": true,\n \"Links\": {\n \"EnumerationSets\": \"\",\n \"Points\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MyPIServer\",\n \"Path\": \"\\\\\\\\PIServer[MyPIServer]\",\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"ServerVersion\": \"3.4.390.18\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DS1km7hQHxB0i6-VfC-9MwAA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested server.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "85f0a627-5b98-43bf-8b0f-f12c0715cfdf", "documentation": "Retrieve enumeration sets for given Data Server.", "method": "get", "endpoint": "dataservers/:webId/enumerationsets", "responses": [ { "uuid": "0a4b7025-d55d-45c3-836d-24a3854ac5f9", "body": "{\n \"Items\": [\n {\n \"Description\": \"Model numbers by brand of vehicle\",\n \"Id\": \"8e77fc4f-ac91-4029-81d6-fb66bd01d431\",\n \"Links\": {\n \"DataServer\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Values\": \"\"\n },\n \"Name\": \"Model Number\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EnumerationSets[Model Number]\",\n \"SerializeDescription\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1MSRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The specified enumeration sets.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c9e89033-2a7d-4792-bee3-d11ba47d29a9", "documentation": "Create an enumeration set on the Data Server.", "method": "post", "endpoint": "dataservers/:webId/enumerationsets", "responses": [ { "uuid": "4eac8637-4f3f-442d-9c68-d960c629e73e", "body": "", "latency": 0, "statusCode": 201, "label": "The enumeration was created. The response's Location header is a link to the created enumeration set.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e3d164af-8d7a-4c10-b245-5551854493b9", "documentation": "Retrieves the specified license for the given Data Server. The fields of the response object are string representations of the numerical values reported by the Data Server, with \"Infinity\" representing a license field with no limit.", "method": "get", "endpoint": "dataservers/:webId/license", "responses": [ { "uuid": "de9d6285-4fc1-4f0a-804c-510392443c8a", "body": "{\n \"AmountLeft\": \"85675\",\n \"AmountUsed\": \"1325\",\n \"Links\": {\n \"Parent\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"Component.Module\",\n \"TotalAmount\": \"10000\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The specified license.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "496f3cde-fa2e-4ec5-ac7a-6f5b10097972", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "No license with the specified module name existed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "6d195f9a-55a1-4063-b05d-57369d465391", "documentation": "Retrieve a list of points on a specified Data Server.", "method": "get", "endpoint": "dataservers/:webId/points", "responses": [ { "uuid": "f8b4d7e6-0ebb-479f-9a65-ebd40fe8c58f", "body": "{\n \"Items\": [\n {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Links\": {\n \"Attributes\": \"\",\n \"DataServer\": \"\",\n \"EndValue\": \"\",\n \"InterpolatedData\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of matching points.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "82b46e88-830c-41f9-9f80-6f922fce335c", "documentation": "Create a point in the specified Data Server.", "method": "post", "endpoint": "dataservers/:webId/points", "responses": [ { "uuid": "eb37d220-f00a-4dea-b0a7-8e44ee33f6f1", "body": "", "latency": 0, "statusCode": 201, "label": "The point was created. The response's Location header is a link to the point.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e24a5321-0791-4817-800a-883ffa14eae0", "documentation": "Retrieve an element category by path.", "method": "get", "endpoint": "elementcategories", "responses": [ { "uuid": "4b6ae3e8-c69f-41ed-9531-54fb67941ffd", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"3051f943-7e4d-4241-ab9c-450a84c80450\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesElement[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified element category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4d06a2eb-d81a-4cea-9a8a-b63a0dc7b0f9", "documentation": "Delete an element category.", "method": "delete", "endpoint": "elementcategories/:webId", "responses": [ { "uuid": "2efa3875-bdf3-4dad-b0f6-10a273b6cf28", "body": "", "latency": 0, "statusCode": 204, "label": "The element category was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9e48ba0a-70c3-4e3a-833c-15a720195136", "documentation": "Retrieve an element category.", "method": "get", "endpoint": "elementcategories/:webId", "responses": [ { "uuid": "ffd5e3c7-91f2-49ad-a7a3-3299035d5369", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"3051f943-7e4d-4241-ab9c-450a84c80450\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesElement[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified element category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b7137281-38e2-4b7a-955b-17134018b858", "documentation": "Update an element category by replacing items in its definition.", "method": "patch", "endpoint": "elementcategories/:webId", "responses": [ { "uuid": "f072a711-e950-4861-9a1f-f84ec588d467", "body": "", "latency": 0, "statusCode": 204, "label": "The element category was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d29763a4-1d8c-445e-b9bf-00d1ab77312d", "documentation": "Get the security information of the specified security item associated with the element category for a specified user.", "method": "get", "endpoint": "elementcategories/:webId/security", "responses": [ { "uuid": "fb7ce4e7-2418-45e8-b29c-8dc30c021e7b", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "09c7c32f-4867-4b12-863b-7540eeb89bb8", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3e323576-bb9a-4c82-b0b3-a884969c82dd", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "866e940c-484f-450c-bb53-512bdee13c21", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "12b55a0d-402a-4553-b5d2-73f7e556413e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "edf7938c-c7bc-4113-b42b-342717ac103d", "documentation": "Retrieve the security entries associated with the element category based on the specified criteria. By default, all security entries for this element category are returned.", "method": "get", "endpoint": "elementcategories/:webId/securityentries", "responses": [ { "uuid": "400356b0-4ed7-4692-8a72-5f966116f8c3", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "01501dd5-189b-4e67-9b0f-59f14e2560c9", "documentation": "Create a security entry owned by the element category.", "method": "post", "endpoint": "elementcategories/:webId/securityentries", "responses": [ { "uuid": "c57e866e-f0d4-4851-a6b9-0e8d17440782", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c8185c6a-963e-4596-9694-89d624eca000", "documentation": "Delete a security entry owned by the element category.", "method": "delete", "endpoint": "elementcategories/:webId/securityentries/:name", "responses": [ { "uuid": "7ec854dc-432c-4e2a-828f-b6e050096748", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3ad1b6d4-1ed1-40f6-b158-0e958e0a6875", "documentation": "Retrieve the security entry associated with the element category with the specified name.", "method": "get", "endpoint": "elementcategories/:webId/securityentries/:name", "responses": [ { "uuid": "77f9cceb-9172-4008-a5b9-96755bfd9c6b", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "3f3b7a14-4ba6-4f5b-b638-d65492bb4439", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f50f9f24-469f-4079-ac91-f6b1a43be39c", "documentation": "Update a security entry owned by the element category.", "method": "put", "endpoint": "elementcategories/:webId/securityentries/:name", "responses": [ { "uuid": "f73b6b26-7aa7-42c8-8735-56e84335302c", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7f9976a7-e402-482e-97de-775b1c2a13e4", "documentation": "Retrieve an element by path.", "method": "get", "endpoint": "elements", "responses": [ { "uuid": "3ef513c3-d280-4a3a-a9a3-81606ae4c7bf", "body": "{\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified element.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8cd59240-fe61-4e50-8f7e-9d12ce5ae00d", "documentation": "Retrieve multiple elements by web id or path.", "method": "get", "endpoint": "elements/multiple", "responses": [ { "uuid": "7a943d54-cd25-4a24-a6e2-6f324d48074a", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested elements", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d9750ab6-be8d-40b0-b09a-7c43232c2ce1", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "Some or all items contain exceptions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ba9257f6-2cc7-4945-a48c-225cdb1d5b81", "documentation": "Retrieve elements based on the specified conditions. By default, returns all the elements.", "method": "get", "endpoint": "elements/search", "responses": [ { "uuid": "02d466b4-f680-4586-9e92-090978d8f0db", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of elements matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cf190634-928c-4234-b24d-fd70db0777d6", "documentation": "Create a link for a \"Search Elements By Attribute Value\" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root Element. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the Elements. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators.", "method": "post", "endpoint": "elements/searchbyattribute", "responses": [ { "uuid": "9338d695-dc87-40b0-93ee-1a71dcca0fc9", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 201, "label": "The link is stored in the response's \"Location\" header. The response content is the first page of the search result by the default parameters.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1b7d8b69-ad74-44fe-9e6e-71539564e369", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Empty or invalid request content.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4a48d735-27fd-4098-83ad-17d3b6d65fcb", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 413, "label": "Request content is too large.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4df8fe3f-b6c4-46c6-8eca-e941c507d75b", "documentation": "Execute a \"Search Elements By Attribute Value\" operation.", "method": "get", "endpoint": "elements/searchbyattribute/:searchId", "responses": [ { "uuid": "b4b89813-56d0-453e-888e-0a4f2253acd2", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "a list of matching Elements.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2c86fe7c-1d67-4284-8d96-9d7552678f9f", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Invalid search Id or search parameters.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0b4a2069-1755-4b81-b205-6e164091cbec", "documentation": "Delete an element.", "method": "delete", "endpoint": "elements/:webId", "responses": [ { "uuid": "b71d9bb4-d23c-4055-b7aa-82a2e5f65f57", "body": "", "latency": 0, "statusCode": 204, "label": "The element was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a9db87fd-481f-4f17-b40b-c343d3df95f3", "documentation": "Retrieve an element.", "method": "get", "endpoint": "elements/:webId", "responses": [ { "uuid": "31ffa9c1-2a0a-45d0-a1ad-3a79259963d5", "body": "{\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified element.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c44c64fb-4a45-4120-92bc-6923f2de9ba4", "documentation": "Update an element by replacing items in its definition.", "method": "patch", "endpoint": "elements/:webId", "responses": [ { "uuid": "826229d6-43e0-4b37-aa22-6788edbcf811", "body": "", "latency": 0, "statusCode": 204, "label": "The element was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7e1d4a1e-23aa-48f9-a0cb-fa43194e0afb", "documentation": "Retrieve analyses based on the specified conditions.", "method": "get", "endpoint": "elements/:webId/analyses", "responses": [ { "uuid": "9e9307c3-bc19-46bf-8e6d-515ad0d56c66", "body": "{\n \"Items\": [\n {\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"AutoCreated\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotification\": {{faker 'datatype.boolean'}},\n \"HasTarget\": true,\n \"HasTemplate\": {{faker 'datatype.boolean'}},\n \"Id\": \"11853358-94bf-11e7-8443-00155d84c200\",\n \"IsConfigured\": {{faker 'datatype.boolean'}},\n \"IsTimeRuleDefinedByTemplate\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"Template\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"MaximumQueueSize\": {{faker 'datatype.number'}},\n \"Name\": \"MyAnalysis\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\",\n \"Priority\": \"High\",\n \"PublishResults\": {{faker 'datatype.boolean'}},\n \"Status\": \"Disabled\",\n \"TargetWebId\": \"I1ETDqD5loBNH0erqeqJodtALAjFPVfUpY-02A8uioGDSgIg\",\n \"TemplateName\": \"\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XsDqD5loBNH0erqeqJodtALAWDOFEb-U5xGEQwAVXYTCAA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of analyses matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8005194e-d30a-400a-b5e6-be722b0d2407", "documentation": "Create an Analysis.", "method": "post", "endpoint": "elements/:webId/analyses", "responses": [ { "uuid": "cfb2d960-f470-4636-a566-ab8709f40324", "body": "", "latency": 0, "statusCode": 201, "label": "The Analysis was created. The response's Location header is a link to the Analysis.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f82ac387-e551-444f-bd3f-5e96c4982442", "documentation": "Get the attributes of the specified element.", "method": "get", "endpoint": "elements/:webId/attributes", "responses": [ { "uuid": "fc9cf2a5-57fd-4afc-b463-cfffc167eed9", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of child attributes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d69c8d3d-223d-44e9-880a-5ced20ebfcad", "documentation": "Create a new attribute of the specified element.", "method": "post", "endpoint": "elements/:webId/attributes", "responses": [ { "uuid": "9386c5d0-5875-442e-acfa-e5281aa0e3c6", "body": "", "latency": 0, "statusCode": 201, "label": "The attribute was created. The response's Location header is a link to the created attribute.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5c45784f-689c-4bc6-b4c8-188dcc0945d2", "documentation": "Get an element's categories.", "method": "get", "endpoint": "elements/:webId/categories", "responses": [ { "uuid": "d741910b-ea54-4303-b507-fa8a774501cc", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"3051f943-7e4d-4241-ab9c-450a84c80450\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesElement[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "403fb8f9-c160-45f5-bb49-825eb7981a97", "documentation": "Executes the create configuration function of the data references found within the attributes of the element, and optionally, its children.", "method": "post", "endpoint": "elements/:webId/config", "responses": [ { "uuid": "a33ab0d9-21de-4fe4-9f7e-612cf5da3480", "body": "", "latency": 0, "statusCode": 200, "label": "Process log of operations. Operations completed with no errors.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c52924ac-cde6-4f06-80fd-e05fc72e44f1", "body": "", "latency": 0, "statusCode": 207, "label": "Process log of operations. Operations completed with errors.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b601ffc8-57d5-4a5e-8411-8b846caf322d", "documentation": "Retrieves a list of element attributes matching the specified filters from the specified element.", "method": "get", "endpoint": "elements/:webId/elementattributes", "responses": [ { "uuid": "50ebc2eb-5e0b-4556-b98f-881ebca795e3", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "a list of matching attributes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5fd98150-aea5-41b3-ba26-7635d4da8e24", "documentation": "Retrieve elements based on the specified conditions. By default, this method selects immediate children of the specified element.", "method": "get", "endpoint": "elements/:webId/elements", "responses": [ { "uuid": "a87c60a1-a0c9-47e3-b581-d8cb4a8f03ae", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of elements matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0513af3d-5837-44dc-a4f1-c81513426f2e", "documentation": "Create a child element.", "method": "post", "endpoint": "elements/:webId/elements", "responses": [ { "uuid": "4fc6def4-a4fd-4ff6-b8c9-fbd0b63534e7", "body": "", "latency": 0, "statusCode": 201, "label": "The element was created. The response's Location header is a link to the element.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3cf49a12-8145-4a0e-9bb4-0d43a1c00634", "documentation": "Retrieve event frames that reference this element based on the specified conditions. By default, returns all event frames that reference this element that have been active in the past 8 hours.", "method": "get", "endpoint": "elements/:webId/eventframes", "responses": [ { "uuid": "97c88918-2b78-4037-a662-46e8fff55162", "body": "{\n \"Items\": [\n {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of event frames matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "62227a78-6942-4306-a4ec-6e6c8d494457", "documentation": "Retrieve notification rules for an element", "method": "get", "endpoint": "elements/:webId/notificationrules", "responses": [ { "uuid": "f2ba75d2-f018-46fe-94be-ebfa2ea8819a", "body": "{\n \"Items\": [\n {\n \"AutoCreated\": true,\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\\\\NotificationRules[RuleName]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Disabled\",\n \"TemplateName\": \"MachineName Notification Rule\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification rules.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "06c2ebb8-6789-4b1a-a65b-7f14bc0776d7", "documentation": "Create a notification rule.", "method": "post", "endpoint": "elements/:webId/notificationrules", "responses": [ { "uuid": "d5735300-df57-4199-8f5f-dd95848a0aae", "body": "", "latency": 0, "statusCode": 201, "label": "The notification rule was created. The response's Location header is a link to the notification rule.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a30de803-a52e-4b20-8e76-2ae5eb5ab9a5", "documentation": "Get a list of the full or relative paths to this element.", "method": "get", "endpoint": "elements/:webId/paths", "responses": [ { "uuid": "7bb20834-6ab6-4a1f-a341-96f67b67d59a", "body": "{\n \"Items\": [\n \"\"\n ]\n}", "latency": 0, "statusCode": 200, "label": "A list of the full or relative paths to this element.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "be97d27c-5b42-4f5e-823c-0556fece96c8", "documentation": "Remove a reference to an existing element from the child elements collection.", "method": "delete", "endpoint": "elements/:webId/referencedelements", "responses": [ { "uuid": "b564ac3e-68a3-4bc8-9a0b-f2c40e055a5e", "body": "", "latency": 0, "statusCode": 204, "label": "The referenced element was successfully removed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "01ac44a5-2b0a-45b4-87cd-2a752389c7ae", "documentation": "Retrieve referenced elements based on the specified conditions. By default, this method selects all referenced elements of the current resource.", "method": "get", "endpoint": "elements/:webId/referencedelements", "responses": [ { "uuid": "af17b0fe-5ccf-44d1-b4e0-83f73f77b348", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of referenced elements matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0f1d8266-16e9-4ab6-a718-e930a38a8673", "documentation": "Add a reference to an existing element to the child elements collection.", "method": "post", "endpoint": "elements/:webId/referencedelements", "responses": [ { "uuid": "8aa03f49-2560-42d4-8dc0-fea2497fc9bd", "body": "", "latency": 0, "statusCode": 204, "label": "The referenced element was successfully added.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a8bbbda5-c4dd-4c5d-ba00-135413bb92d4", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The referenced element already exists in the collection.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b55b02c7-bf24-4aa0-bed9-a5768abc1d5f", "documentation": "Get the security information of the specified security item associated with the element for a specified user.", "method": "get", "endpoint": "elements/:webId/security", "responses": [ { "uuid": "32732e63-4736-4b08-8f38-688c6b60e0de", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5f9b89eb-4a79-4c2b-9555-11b33d56c2e7", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "38856c56-5be9-49dd-b581-98de4c86180d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f8010ee4-8c6b-4456-947c-2079bedf084e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ad2220a7-4dc6-4356-b87d-5e7da816d356", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "cb0cb8a1-038e-4396-b73a-70bffb185e38", "documentation": "Retrieve the security entries associated with the element based on the specified criteria. By default, all security entries for this element are returned.", "method": "get", "endpoint": "elements/:webId/securityentries", "responses": [ { "uuid": "c29e1812-809a-4fbf-b789-f212328ad232", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "85ee7787-a3ed-4a91-8026-78bcbcccf0e9", "documentation": "Create a security entry owned by the element.", "method": "post", "endpoint": "elements/:webId/securityentries", "responses": [ { "uuid": "ed723f4d-eb3f-45cd-9c24-d364b995d1f3", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "261224d8-4cfb-4c63-9e4e-f26402380e44", "documentation": "Delete a security entry owned by the element.", "method": "delete", "endpoint": "elements/:webId/securityentries/:name", "responses": [ { "uuid": "43e08f55-637e-43fc-b673-e1eed67eebab", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b034df3a-e220-407b-b2df-9c8d548fcd7b", "documentation": "Retrieve the security entry associated with the element with the specified name.", "method": "get", "endpoint": "elements/:webId/securityentries/:name", "responses": [ { "uuid": "05017691-fc14-4435-97a2-17e0410b7455", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5f0acb40-3f08-4e54-84b5-54d56bd5566f", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ba9749b3-578e-4760-a292-d5ebc2472a4e", "documentation": "Update a security entry owned by the element.", "method": "put", "endpoint": "elements/:webId/securityentries/:name", "responses": [ { "uuid": "9aa25f78-1b0b-47ab-8a70-1b3911ba3483", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b3f94b60-c79f-455c-8aa0-ecfd78d7f332", "documentation": "Retrieve an element template by path.", "method": "get", "endpoint": "elementtemplates", "responses": [ { "uuid": "00ed444d-4982-43c4-b4f4-b0b3aeb695a5", "body": "{\n \"AllowElementToExtend\": {{faker 'datatype.boolean'}},\n \"BaseTemplate\": \"Equipment\",\n \"CanBeAcknowledged\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Machine MachineName\",\n \"ExtendedProperties\": {},\n \"Id\": \"a7989492-b2ab-4d90-8abb-4c8284353dd6\",\n \"InstanceType\": \"Element\",\n \"Links\": {\n \"AnalysisTemplates\": \"\",\n \"AttributeTemplates\": \"\",\n \"BaseTemplate\": \"\",\n \"BaseTemplates\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"DerivedTemplates\": \"\",\n \"NotificationRuleTemplates\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MachineName\",\n \"NamingPattern\": \"%TEMPLATE%\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[Boiler]\",\n \"Severity\": \"None\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g\"\n}", "latency": 0, "statusCode": 200, "label": "The specified element template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "26278efb-48fc-4742-a425-f1c1f800c6b1", "documentation": "Delete an element template.", "method": "delete", "endpoint": "elementtemplates/:webId", "responses": [ { "uuid": "471f3bbd-e361-4d84-a170-1bda3cf3cc2e", "body": "", "latency": 0, "statusCode": 204, "label": "The element template was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9505ea09-1b3f-419d-b987-e462ec49fa22", "documentation": "Retrieve an element template.", "method": "get", "endpoint": "elementtemplates/:webId", "responses": [ { "uuid": "aa7dcb53-6801-41c4-97ac-c447ad440450", "body": "{\n \"AllowElementToExtend\": {{faker 'datatype.boolean'}},\n \"BaseTemplate\": \"Equipment\",\n \"CanBeAcknowledged\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Machine MachineName\",\n \"ExtendedProperties\": {},\n \"Id\": \"a7989492-b2ab-4d90-8abb-4c8284353dd6\",\n \"InstanceType\": \"Element\",\n \"Links\": {\n \"AnalysisTemplates\": \"\",\n \"AttributeTemplates\": \"\",\n \"BaseTemplate\": \"\",\n \"BaseTemplates\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"DerivedTemplates\": \"\",\n \"NotificationRuleTemplates\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MachineName\",\n \"NamingPattern\": \"%TEMPLATE%\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[Boiler]\",\n \"Severity\": \"None\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g\"\n}", "latency": 0, "statusCode": 200, "label": "The specified element template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2b3e5375-4d17-4656-b71c-911d0e05593f", "documentation": "Update an element template by replacing items in its definition.", "method": "patch", "endpoint": "elementtemplates/:webId", "responses": [ { "uuid": "250120b7-85b4-4016-bd70-7d01391e6a4a", "body": "", "latency": 0, "statusCode": 204, "label": "The element template was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e5db3894-ca59-4be8-81c5-e7194797495b", "documentation": "Get analysis templates for an element template.", "method": "get", "endpoint": "elementtemplates/:webId/analysistemplates", "responses": [ { "uuid": "e38f9989-b783-42f5-a159-02339b9a967d", "body": "{\n \"Items\": [\n {\n \"AnalysisRulePlugInName\": \"PerformanceEquation\",\n \"CategoryNames\": [\n \"MyAnalysisCategory\"\n ],\n \"CreateEnabled\": true,\n \"Description\": \"\",\n \"GroupId\": {{faker 'datatype.number'}},\n \"HasNotificationTemplate\": {{faker 'datatype.boolean'}},\n \"HasTarget\": {{faker 'datatype.boolean'}},\n \"Id\": \"612d9811-3f06-4e27-989c-42e5e5c00b88\",\n \"Links\": {\n \"AnalysisRule\": \"\",\n \"AnalysisRulePlugIn\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Target\": \"\",\n \"TimeRule\": \"\",\n \"TimeRulePlugIn\": \"\"\n },\n \"Name\": \"MyAnalysisTemplate\",\n \"OutputTime\": \"\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\AnalysisTemplates[MyAnalysisTemplate]\",\n \"TargetName\": \"MyElementTemplate\",\n \"TimeRulePlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1XTG_auSSsvuECG8ad_p8b25QEZgtYQY_J06YnELl5cALiA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of analysis templates for the specified element template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "56370a98-f0cd-4f60-a4f9-3d530dc4de4d", "documentation": "Get child attribute templates for an element template.", "method": "get", "endpoint": "elementtemplates/:webId/attributetemplates", "responses": [ { "uuid": "aa584076-1d4c-4a42-a55d-fbc9a64294e8", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"DefaultValue\": {},\n \"Description\": \"2008 Water Use\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"23d027b5-5dd5-41c5-80f1-f8b5c9ff4356\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AttributeTemplates\": \"\",\n \"Categories\": \"\",\n \"ElementTemplate\": \"\",\n \"Parent\": \"\",\n \"Self\": \"\",\n \"Trait\": \"\"\n },\n \"Name\": \"Water(2008)\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[MachineName]|Water(2008)\",\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ATEG_auSSsvuECG8ad_p8b25QQkxqWDwIWU6zC4vmgpd4kgtSfQI9VdxUGA8fi1yf9DVg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of attribute templates for the specified element template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6dfe1256-e812-4fda-97ff-9678a01d9379", "documentation": "Create an attribute template.", "method": "post", "endpoint": "elementtemplates/:webId/attributetemplates", "responses": [ { "uuid": "7b521067-ec5f-4d05-a16f-b02720bee3da", "body": "", "latency": 0, "statusCode": 201, "label": "The attribute template was created. The response's Location header is a link to the created resource.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "da868fcd-5f7c-4a4c-a684-e600386ab312", "documentation": "Get base element templates for an element template.", "method": "get", "endpoint": "elementtemplates/:webId/baseelementtemplates", "responses": [ { "uuid": "68a25fc4-857b-4e77-b4ca-b40e243b6b36", "body": "{\n \"Items\": [\n {\n \"AllowElementToExtend\": {{faker 'datatype.boolean'}},\n \"BaseTemplate\": \"Equipment\",\n \"CanBeAcknowledged\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Machine MachineName\",\n \"ExtendedProperties\": {},\n \"Id\": \"a7989492-b2ab-4d90-8abb-4c8284353dd6\",\n \"InstanceType\": \"Element\",\n \"Links\": {\n \"AnalysisTemplates\": \"\",\n \"AttributeTemplates\": \"\",\n \"BaseTemplate\": \"\",\n \"BaseTemplates\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"DerivedTemplates\": \"\",\n \"NotificationRuleTemplates\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MachineName\",\n \"NamingPattern\": \"%TEMPLATE%\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[Boiler]\",\n \"Severity\": \"None\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of base element templates for the specified element template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1af61b28-e6bb-4187-b1d5-f8b0c995ee3f", "documentation": "Get an element template's categories.", "method": "get", "endpoint": "elementtemplates/:webId/categories", "responses": [ { "uuid": "3b0588fb-c1d2-45a0-a65e-95f7a151e339", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"3051f943-7e4d-4241-ab9c-450a84c80450\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesElement[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "aa57b162-4f2e-4adc-becd-ff41353a2885", "documentation": "Get derived element templates for an element template.", "method": "get", "endpoint": "elementtemplates/:webId/derivedelementtemplates", "responses": [ { "uuid": "cc2cd72e-dc4a-4b48-90e4-5117b3f13068", "body": "{\n \"Items\": [\n {\n \"AllowElementToExtend\": {{faker 'datatype.boolean'}},\n \"BaseTemplate\": \"Equipment\",\n \"CanBeAcknowledged\": {{faker 'datatype.boolean'}},\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Machine MachineName\",\n \"ExtendedProperties\": {},\n \"Id\": \"a7989492-b2ab-4d90-8abb-4c8284353dd6\",\n \"InstanceType\": \"Element\",\n \"Links\": {\n \"AnalysisTemplates\": \"\",\n \"AttributeTemplates\": \"\",\n \"BaseTemplate\": \"\",\n \"BaseTemplates\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"DerivedTemplates\": \"\",\n \"NotificationRuleTemplates\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MachineName\",\n \"NamingPattern\": \"%TEMPLATE%\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ElementTemplates[Boiler]\",\n \"Severity\": \"None\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ETDqD5loBNH0erqeqJodtALAkpSYp6uykE2Ku0yChDU91g\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of derived element templates for the specified element template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "213d1626-8a75-41d7-99fd-ceb7c21be870", "documentation": "Get notification rule templates for an element template", "method": "get", "endpoint": "elementtemplates/:webId/notificationruletemplates", "responses": [ { "uuid": "474346c4-30f6-491d-9e36-8ad8c08254d0", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"MachineNameAlerts\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Description entered by the user\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\ElementTemplates[Template3]\\\\NotificationRuleTemplates[Notification Rule Template]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Functioning\",\n \"TemplateName\": \"MachineName Notification Rule Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification rule templates.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e89b2289-8024-4d31-a43a-58589224ba3c", "documentation": "Create a notification rule template.", "method": "post", "endpoint": "elementtemplates/:webId/notificationruletemplates", "responses": [ { "uuid": "357c5c10-54f7-44e2-a506-3cb2edf4d9e4", "body": "", "latency": 0, "statusCode": 201, "label": "The notification rule template was created. The response's Location header is a link to the notification rule template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "25eb729b-b934-4724-9f39-986b34fd2d4d", "documentation": "Get the security information of the specified security item associated with the element template for a specified user.", "method": "get", "endpoint": "elementtemplates/:webId/security", "responses": [ { "uuid": "593ca3de-8662-4e9d-801f-f49e24219a4b", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "bcea51ee-d277-41b3-8f2c-2dccf67b42a3", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f17facaa-6107-4e3e-81b9-df82d35dcfd8", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "9cf46691-4cf2-4413-9558-cd1bb0462dc9", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "783dcd37-22b1-41e3-aa6d-8d30c64e554d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1668af51-45f4-45e5-be38-f04e38df188a", "documentation": "Retrieve the security entries associated with the element template based on the specified criteria. By default, all security entries for this element template are returned.", "method": "get", "endpoint": "elementtemplates/:webId/securityentries", "responses": [ { "uuid": "dbc109e6-e605-40cf-b4c7-ca3cf8cff5c7", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9ab6229a-faff-499c-86d6-b45a777b6fba", "documentation": "Create a security entry owned by the element template.", "method": "post", "endpoint": "elementtemplates/:webId/securityentries", "responses": [ { "uuid": "a7bff6e6-59fd-4ec4-b05e-ad8cef4437cc", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1d7f3a92-5dc2-4b2f-8599-be0913851dd9", "documentation": "Delete a security entry owned by the element template.", "method": "delete", "endpoint": "elementtemplates/:webId/securityentries/:name", "responses": [ { "uuid": "4072fb14-9e33-46a3-bff3-7dd497d1d529", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8b9d536a-0f4c-407d-b61b-5368a3a2ce3f", "documentation": "Retrieve the security entry associated with the element template with the specified name.", "method": "get", "endpoint": "elementtemplates/:webId/securityentries/:name", "responses": [ { "uuid": "6bd2c964-e0bd-495a-9161-97ef29ca8c73", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "db978121-4ae3-45e5-81e3-f19717add95b", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0de30091-8de7-47f7-a7e7-c7c737a3e784", "documentation": "Update a security entry owned by the element template.", "method": "put", "endpoint": "elementtemplates/:webId/securityentries/:name", "responses": [ { "uuid": "0d796a98-5a98-44e4-89f8-746cc244d38f", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6423b1d8-ed2d-45b1-92d2-683597205a8d", "documentation": "Retrieve an enumeration set by path.", "method": "get", "endpoint": "enumerationsets", "responses": [ { "uuid": "9f665110-553f-4875-87b8-bce2f9c75555", "body": "{\n \"Description\": \"Model numbers by brand of vehicle\",\n \"Id\": \"8e77fc4f-ac91-4029-81d6-fb66bd01d431\",\n \"Links\": {\n \"DataServer\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Values\": \"\"\n },\n \"Name\": \"Model Number\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EnumerationSets[Model Number]\",\n \"SerializeDescription\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1MSRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified enumeration set.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ce497819-48d7-4060-94c1-3cffd3910373", "documentation": "Delete an enumeration set.", "method": "delete", "endpoint": "enumerationsets/:webId", "responses": [ { "uuid": "7792d1e7-2e75-4960-8a62-176f61b01f48", "body": "", "latency": 0, "statusCode": 204, "label": "The enumeration set was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "851cff76-9fad-40ed-93db-b30e18fc7851", "documentation": "Retrieve an enumeration set.", "method": "get", "endpoint": "enumerationsets/:webId", "responses": [ { "uuid": "eb2b6f2a-08cb-4155-ad23-0bbfdc307160", "body": "{\n \"Description\": \"Model numbers by brand of vehicle\",\n \"Id\": \"8e77fc4f-ac91-4029-81d6-fb66bd01d431\",\n \"Links\": {\n \"DataServer\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"Values\": \"\"\n },\n \"Name\": \"Model Number\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EnumerationSets[Model Number]\",\n \"SerializeDescription\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1MSRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified enumeration sets.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d40cc223-af7f-4305-a0ae-4a96ece95e50", "documentation": "Update an enumeration set by replacing items in its definition.", "method": "patch", "endpoint": "enumerationsets/:webId", "responses": [ { "uuid": "0ba52d59-8984-4a48-bf83-1e3ce10da107", "body": "", "latency": 0, "statusCode": 204, "label": "The enumeration set was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4c10e6a3-f16e-40f1-888a-60410bb5c602", "documentation": "Retrieve an enumeration set's values.", "method": "get", "endpoint": "enumerationsets/:webId/enumerationvalues", "responses": [ { "uuid": "685c36e5-ac90-4218-9a03-25efd7b50347", "body": "{\n \"Items\": [\n {\n \"Description\": \"Model Number of CarBrand\",\n \"Id\": \"982a8694-6fe9-4cb3-a011-09d278649eef\",\n \"Links\": {\n \"EnumerationSet\": \"\",\n \"Parent\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CarBrand|Model3\",\n \"Parent\": \"CarBrand\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EnumerationSets[Model Number]\\\\CarBrand|Model3\",\n \"SerializeDescription\": {{faker 'datatype.boolean'}},\n \"SerializeId\": {{faker 'datatype.boolean'}},\n \"SerializeLinks\": {{faker 'datatype.boolean'}},\n \"SerializePath\": {{faker 'datatype.boolean'}},\n \"SerializeWebId\": {{faker 'datatype.boolean'}},\n \"Value\": 2005,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1MVRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQlIYqmOlvs0ygEQnSeGSe7w\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The specified enumeration set's values", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ce7eb2e4-eb6e-4999-83ee-10cc29baeb72", "documentation": "Create an enumeration value for a enumeration set.", "method": "post", "endpoint": "enumerationsets/:webId/enumerationvalues", "responses": [ { "uuid": "ea0bbdf5-9b19-48b5-bb17-892bb86b94ff", "body": "", "latency": 0, "statusCode": 201, "label": "The enumeration value was created. The response's Location header is a link to the enumeration value.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ad94245f-b2e0-4148-99d5-daa2389f83fb", "documentation": "Get the security information of the specified security item associated with the enumeration set for a specified user.", "method": "get", "endpoint": "enumerationsets/:webId/security", "responses": [ { "uuid": "711886b4-19d0-4ed2-bd7d-c623216cbbca", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "91f6e3d3-9238-4472-ad7a-4e7be1013fe1", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "17bf5ccc-431b-4535-a550-5387f78649ed", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ada4b75e-749e-4049-90fd-17296ab83911", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1c413425-d94b-4d78-8407-21ebd938fa0d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "310b9894-93c8-4713-944a-15c337e211aa", "documentation": "Retrieve the security entries associated with the enumeration set based on the specified criteria. By default, all security entries for this enumeration set are returned.", "method": "get", "endpoint": "enumerationsets/:webId/securityentries", "responses": [ { "uuid": "3f06819e-a15e-470a-bcd7-b79d0ea6d2ca", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6479f34f-89d9-472b-93b2-2a6aaee1f5a2", "documentation": "Create a security entry owned by the enumeration set.", "method": "post", "endpoint": "enumerationsets/:webId/securityentries", "responses": [ { "uuid": "eb58f728-3aea-450d-a137-8545258c5124", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ec70a3d3-c33d-44d7-a3df-69fd6cfc6be3", "documentation": "Delete a security entry owned by the enumeration set.", "method": "delete", "endpoint": "enumerationsets/:webId/securityentries/:name", "responses": [ { "uuid": "92cb0f50-5ba9-4f12-a2bf-9162c8076cdd", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a8c306af-5605-427b-8875-4c9b07e66acf", "documentation": "Retrieve the security entry associated with the enumeration set with the specified name.", "method": "get", "endpoint": "enumerationsets/:webId/securityentries/:name", "responses": [ { "uuid": "941a671a-d07d-45f5-acab-c36c11fae05d", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0186c391-279b-4836-a614-45cd6d3ea3ae", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "2777e4c6-3ef4-4351-8e64-b489d2d91ab9", "documentation": "Update a security entry owned by the enumeration set.", "method": "put", "endpoint": "enumerationsets/:webId/securityentries/:name", "responses": [ { "uuid": "4933f58e-a0ca-4d09-b61e-3afac0644904", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bfaeb1d4-5fa3-4cec-a948-9904ba7e6dfa", "documentation": "Retrieve an enumeration value by path.", "method": "get", "endpoint": "enumerationvalues", "responses": [ { "uuid": "e888e170-1613-4b00-9711-20cd4e2e4aea", "body": "{\n \"Description\": \"Model Number of CarBrand\",\n \"Id\": \"982a8694-6fe9-4cb3-a011-09d278649eef\",\n \"Links\": {\n \"EnumerationSet\": \"\",\n \"Parent\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CarBrand|Model3\",\n \"Parent\": \"CarBrand\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EnumerationSets[Model Number]\\\\CarBrand|Model3\",\n \"SerializeDescription\": {{faker 'datatype.boolean'}},\n \"SerializeId\": {{faker 'datatype.boolean'}},\n \"SerializeLinks\": {{faker 'datatype.boolean'}},\n \"SerializePath\": {{faker 'datatype.boolean'}},\n \"SerializeWebId\": {{faker 'datatype.boolean'}},\n \"Value\": 2005,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1MVRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQlIYqmOlvs0ygEQnSeGSe7w\"\n}", "latency": 0, "statusCode": 200, "label": "The specified enumeration set.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ae50a404-211c-434d-9097-2fed367e27b8", "documentation": "Delete an enumeration value from an enumeration set.", "method": "delete", "endpoint": "enumerationvalues/:webId", "responses": [ { "uuid": "e872e318-6d0c-4f90-8827-698dc497de0b", "body": "", "latency": 0, "statusCode": 204, "label": "The enumeration value was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4531474f-c45d-4b3f-8f55-ff75adbbb625", "documentation": "Retrieve an enumeration value mapping", "method": "get", "endpoint": "enumerationvalues/:webId", "responses": [ { "uuid": "50ea74b5-8841-4b85-bb98-d9b0130cbfd8", "body": "{\n \"Description\": \"Model Number of CarBrand\",\n \"Id\": \"982a8694-6fe9-4cb3-a011-09d278649eef\",\n \"Links\": {\n \"EnumerationSet\": \"\",\n \"Parent\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CarBrand|Model3\",\n \"Parent\": \"CarBrand\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EnumerationSets[Model Number]\\\\CarBrand|Model3\",\n \"SerializeDescription\": {{faker 'datatype.boolean'}},\n \"SerializeId\": {{faker 'datatype.boolean'}},\n \"SerializeLinks\": {{faker 'datatype.boolean'}},\n \"SerializePath\": {{faker 'datatype.boolean'}},\n \"SerializeWebId\": {{faker 'datatype.boolean'}},\n \"Value\": 2005,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1MVRDqD5loBNH0erqeqJodtALAT_x3jpGsKUCB1vtmvQHUMQlIYqmOlvs0ygEQnSeGSe7w\"\n}", "latency": 0, "statusCode": 200, "label": "The specified enumeration value mapping", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "91c5e18e-fa99-43f0-8820-ccde3f8b5700", "documentation": "Update an enumeration value by replacing items in its definition.", "method": "patch", "endpoint": "enumerationvalues/:webId", "responses": [ { "uuid": "aee6e436-920a-4afe-b686-0d95c703fee9", "body": "", "latency": 0, "statusCode": 204, "label": "The enumeration set was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "091c4aa6-47b3-441f-bb8c-f3c9cc5776c9", "documentation": "Retrieve an event frame by path.", "method": "get", "endpoint": "eventframes", "responses": [ { "uuid": "8e991f3c-987a-475b-95e7-d91fe8ed0547", "body": "{\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified event frame.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "07e9be46-168b-499f-af52-4fc7c0a7cf86", "documentation": "Retrieve multiple event frames by web ids or paths.", "method": "get", "endpoint": "eventframes/multiple", "responses": [ { "uuid": "4eedd5e2-fb0f-4098-aa2b-5fef482db428", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested event frames", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "028a0d2d-b613-4826-a005-f04ec831f459", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "Some or all items contain exceptions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "17df71d5-671f-4b07-bc69-6ac26bf5c240", "documentation": "Retrieve event frames based on the specified conditions. Returns event frames using the specified search query string.", "method": "get", "endpoint": "eventframes/search", "responses": [ { "uuid": "3a810048-c048-4503-b43b-cfe4d097bf35", "body": "{\n \"Items\": [\n {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of event frames matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3230968a-2a9a-4419-ba5e-9f3ba564ef66", "documentation": "Create a link for a \"Search EventFrames By Attribute Value\" operation, whose queries are specified in the request content. The SearchRoot is specified by the Web Id of the root EventFrame. If the SearchRoot is not specified, then the search starts at the Asset Database. ElementTemplate must be provided as the Web ID of the ElementTemplate, which are used to create the EventFrames. All the attributes in the queries must be defined as AttributeTemplates on the ElementTemplate. An array of attribute value queries are ANDed together to find the desired Element objects. At least one value query must be specified. There are limitations on SearchOperators.", "method": "post", "endpoint": "eventframes/searchbyattribute", "responses": [ { "uuid": "9608cd80-fc4e-4218-a9e1-a6594eca9064", "body": "{\n \"Items\": [\n {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 201, "label": "The link is stored in the response's \"Location\" header. The response content is the first page of the search result by the default parameters.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7d1ab9c8-17c3-458e-a273-0a549127c5af", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Empty or invalid request content.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "edd3c9bc-8f67-4822-9731-ee1a61195bee", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 413, "label": "Request content is too large.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4423bef8-b210-4ca8-9153-414e1f658fc1", "documentation": "Execute a \"Search EventFrames By Attribute Value\" operation.", "method": "get", "endpoint": "eventframes/searchbyattribute/:searchId", "responses": [ { "uuid": "e034464c-3591-4283-815b-a4c76c4c58ad", "body": "{\n \"Items\": [\n {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "a list of matching EventFrames.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "96f0d1ee-0e85-4b67-affd-9012e7198818", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Invalid search Id or search parameters.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d14059ee-424d-48de-824f-bc3d8ce904d5", "documentation": "Delete an event frame.", "method": "delete", "endpoint": "eventframes/:webId", "responses": [ { "uuid": "97953b4c-957c-4f95-b7c1-aaa7aa2ef723", "body": "", "latency": 0, "statusCode": 204, "label": "The event frame was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4646099d-c5b8-445d-b5fc-c7746f9cb262", "documentation": "Retrieve an event frame.", "method": "get", "endpoint": "eventframes/:webId", "responses": [ { "uuid": "e1db3003-0615-4af4-9e16-aa6450bd6ea9", "body": "{\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified event frame.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9ab9b9be-95d8-4a85-8c9e-de3e21ef4e6f", "documentation": "Update an event frame by replacing items in its definition.", "method": "patch", "endpoint": "eventframes/:webId", "responses": [ { "uuid": "538d2f6b-c47e-4525-a3a5-9473184dd556", "body": "", "latency": 0, "statusCode": 204, "label": "The event frame was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f4e83002-8a00-433e-b0f2-06165d113a7d", "documentation": "Calls the EventFrame's Acknowledge method.", "method": "patch", "endpoint": "eventframes/:webId/acknowledge", "responses": [ { "uuid": "af257f83-3256-4af5-bb8c-e69a7769e95d", "body": "", "latency": 0, "statusCode": 204, "label": "The event frame has been acknowledged.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "37ceb115-1646-493d-bf94-237918ddb473", "documentation": "Get an event frame's annotations.", "method": "get", "endpoint": "eventframes/:webId/annotations", "responses": [ { "uuid": "12de48d9-a72c-48b4-915f-48f918ac0796", "body": "{\n \"Items\": [\n {\n \"CreationDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Creator\": \"MyDomain\\\\UserA\",\n \"Description\": \"Signifies a spike in temperature.\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Id\": \"512B6616-CE39-4F70-9048-8C6A025FB592\",\n \"Links\": {\n \"MediaData\": \"\",\n \"MediaMetadata\": \"\",\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"Modifier\": \"MyDomain\\\\UserA\",\n \"ModifyDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Name\": \"Temperature Annotation\",\n \"Value\": \"The temperature spiked because of a malfunction with a unit in our west plant.\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of annotations.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "97e2cc94-d96e-4b7f-93f4-25029338c43b", "documentation": "Create an annotation on an event frame.", "method": "post", "endpoint": "eventframes/:webId/annotations", "responses": [ { "uuid": "6dbca022-69e4-4812-85bf-22afac1d7db9", "body": "", "latency": 0, "statusCode": 201, "label": "The annotation was created. The response's Location header is a link to the annotation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c1fb7fe2-0541-4bbf-8dd7-331c75cd8247", "documentation": "Delete an annotation on an event frame. If the annotation has attached media, the attached media will also be deleted.", "method": "delete", "endpoint": "eventframes/:webId/annotations/:id", "responses": [ { "uuid": "69380e53-7ae5-419c-bd88-87dd81f1c914", "body": "", "latency": 0, "statusCode": 204, "label": "The annotation was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e05121f8-1693-4445-b7c0-ed13d53df33a", "documentation": "Get a specific annotation on an event frame.", "method": "get", "endpoint": "eventframes/:webId/annotations/:id", "responses": [ { "uuid": "b733390a-bcd3-4642-8558-07831def9b3e", "body": "{\n \"CreationDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Creator\": \"MyDomain\\\\UserA\",\n \"Description\": \"Signifies a spike in temperature.\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Id\": \"512B6616-CE39-4F70-9048-8C6A025FB592\",\n \"Links\": {\n \"MediaData\": \"\",\n \"MediaMetadata\": \"\",\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"Modifier\": \"MyDomain\\\\UserA\",\n \"ModifyDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Name\": \"Temperature Annotation\",\n \"Value\": \"The temperature spiked because of a malfunction with a unit in our west plant.\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested annotation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c5bd7a80-62c1-40ca-8aae-ab8ca6feaf5c", "documentation": "Update an annotation on an event frame by replacing items in its definition.", "method": "patch", "endpoint": "eventframes/:webId/annotations/:id", "responses": [ { "uuid": "9d95b2ac-2015-4e44-a4e5-1df01b0ab085", "body": "", "latency": 0, "statusCode": 204, "label": "The annotation was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "99ef96ee-345c-49c4-bd85-20388c6b85e8", "documentation": "Delete attached media from an annotation on an event frame.", "method": "delete", "endpoint": "eventframes/:webId/annotations/:id/attachment/media", "responses": [ { "uuid": "638a7f42-2238-4606-83b0-14f117a4fbf9", "body": "", "latency": 0, "statusCode": 204, "label": "The attached media was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5efa3c04-7576-4819-a1b1-a2b2c3942d93", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The specified annotation did not have any attached media to delete.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "c74be590-0197-4cde-bab4-3dfb2f78b5db", "documentation": "Gets the metadata of the media attached to the specified annotation.", "method": "get", "endpoint": "eventframes/:webId/annotations/:id/attachment/media/metadata", "responses": [ { "uuid": "c93b9504-7d2b-48fa-be06-882eb74dbb16", "body": "{\n \"Author\": \"DOMAIN\\\\username\",\n \"ChangeDate\": \"2014-07-22T14:00:00Z\",\n \"Description\": \"The description attached to this media.\",\n \"Links\": {\n \"MediaData\": \"\",\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"ExampleFile.txt\",\n \"Size\": 86753098675309,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested metadata.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "fc1d74c3-7fe9-4652-a18d-1a3c37bb4704", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The supplied Web ID could not be parsed, or the request was somehow otherwise invalid.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f394dcb8-f8b9-483b-a277-7c1ce2eb7898", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The specified Event Frame did not exist, the specified annotation was not found, or the annotation did not have attached media.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "28a7c219-a9a8-440a-9117-a885f9088be7", "documentation": "Get the attributes of the specified event frame.", "method": "get", "endpoint": "eventframes/:webId/attributes", "responses": [ { "uuid": "b1687646-b445-46d0-8001-cc41b4cc7d36", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of child attributes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0aebf8d7-f058-4f95-b972-5e170fef29ae", "documentation": "Create a new attribute of the specified event frame.", "method": "post", "endpoint": "eventframes/:webId/attributes", "responses": [ { "uuid": "0cbdaa55-2bc6-4770-9d95-6432ee6bfef8", "body": "", "latency": 0, "statusCode": 201, "label": "The attribute was created. The response's Location header is a link to the created attribute.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "39c5686e-0273-4de4-a09a-72185ce65241", "documentation": "Calls the EventFrame's CaptureValues method.", "method": "post", "endpoint": "eventframes/:webId/attributes/capture", "responses": [ { "uuid": "69eefac0-9b45-4640-b5a0-3bcd821aacff", "body": "", "latency": 0, "statusCode": 204, "label": "The event frame attribute's values were captured.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4741d9d4-11f8-4022-a627-060b71affda4", "documentation": "Get an event frame's categories.", "method": "get", "endpoint": "eventframes/:webId/categories", "responses": [ { "uuid": "57a07cce-a85d-4e5f-993d-5aef8384b31f", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"3051f943-7e4d-4241-ab9c-450a84c80450\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesElement[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1ECDqD5loBNH0erqeqJodtALAQ_lRME1-QUKrnEUKhMgEUA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1bc52b8a-20c3-49fb-9b7f-d5b88abe939a", "documentation": "Executes the create configuration function of the data references found within the attributes of the event frame, and optionally, its children.", "method": "post", "endpoint": "eventframes/:webId/config", "responses": [ { "uuid": "6169cd1e-356a-40f8-999e-189748aa124b", "body": "", "latency": 0, "statusCode": 200, "label": "Process log of operations. Operations completed with no errors.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "06ee82ce-29ee-4864-b524-68c2a0e2c241", "body": "", "latency": 0, "statusCode": 207, "label": "Process log of operations. Operations completed with errors.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1c5e7351-e3c6-48a0-9622-ead21778d20a", "documentation": "Retrieves a list of event frame attributes matching the specified filters from the specified event frame.", "method": "get", "endpoint": "eventframes/:webId/eventframeattributes", "responses": [ { "uuid": "7356faa8-0bfa-4ade-85f6-1868d9abae73", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Energy Savings Targets\"\n ],\n \"ConfigString\": \"SELECT [Water Use] FROM [Energy Use 2008] WHERE [Asset ID] = '%Element%'\",\n \"DataReference\": {\n \"PIPoint\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n },\n \"Type\": \"PI Point\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"DataReferencePlugIn\": \"Table Lookup\",\n \"DefaultUnitsName\": \"liter\",\n \"DefaultUnitsNameAbbreviation\": \"L\",\n \"Description\": \"2008 Water Use\",\n \"DisplayDigits\": -5,\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"75de231b-b591-49b1-b138-e725a77165c2\",\n \"IsConfigurationItem\": {{faker 'datatype.boolean'}},\n \"IsExcluded\": {{faker 'datatype.boolean'}},\n \"IsHidden\": {{faker 'datatype.boolean'}},\n \"IsManualDataEntry\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Element\": \"\",\n \"EndValue\": \"\",\n \"EnumerationSet\": \"\",\n \"EnumerationValues\": \"\",\n \"EventFrame\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"Point\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Trait\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName|Water(2008)\",\n \"Paths\": [\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|MyAttribute\",\n \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\ReferencingElement\\\\MyElement|MyAttribute\"\n ],\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"TraitName\": \"LimitLoLo\",\n \"Type\": \"Int32\",\n \"TypeQualifier\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "a list of matching attributes.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cafd8531-8451-47b1-8c30-e270c075d24f", "documentation": "Retrieve event frames based on the specified conditions. By default, returns all children of the specified root event frame that have been active in the past 8 hours.", "method": "get", "endpoint": "eventframes/:webId/eventframes", "responses": [ { "uuid": "f44a7f17-91e6-44d5-a4ba-788f71f38ebe", "body": "{\n \"Items\": [\n {\n \"AcknowledgedBy\": \"MyDomain\\\\UserA\",\n \"AcknowledgedDate\": \"2014-07-30T11:04:23Z\",\n \"AreValuesCaptured\": {{faker 'datatype.boolean'}},\n \"CanBeAcknowledged\": true,\n \"CategoryNames\": [\n \"Processing Plant\"\n ],\n \"Description\": \"Event Frame of Past Week\",\n \"EndTime\": \"2014-07-25T14:45:29Z\",\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"96f9a00e-4d80-471f-0000-00000004b002\",\n \"IsAcknowledged\": true,\n \"IsAnnotated\": {{faker 'datatype.boolean'}},\n \"IsLocked\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Annotations\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"PrimaryReferencedElement\": \"\",\n \"RecordedData\": \"\",\n \"ReferencedElements\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"EF20140725-001\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\EventFrames[EF20140725-001]\",\n \"RefElementWebIds\": [\n \"I1EmDqD5loBNH0erqeqJodtALAaqQoQHk26BGgMQAVXYR0Ag\"\n ],\n \"Security\": {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"Severity\": \"None\",\n \"StartTime\": \"2014-07-18T14:45:29Z\",\n \"TemplateName\": \"Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAASwAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of event frames matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "22a0e007-6814-4ec5-aed1-5e9cec27acab", "documentation": "Create an event frame as a child of the specified event frame.", "method": "post", "endpoint": "eventframes/:webId/eventframes", "responses": [ { "uuid": "bb5f3742-f7f2-433a-8086-f3099a1365f7", "body": "", "latency": 0, "statusCode": 201, "label": "The event frame was created. The response's Location header is a link to the event frame.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ed4171de-4911-4883-b93b-367fc4abcea1", "documentation": "Retrieve the event frame's referenced elements.", "method": "get", "endpoint": "eventframes/:webId/referencedelements", "responses": [ { "uuid": "f124d004-6607-4c75-a182-9d81a6e7c740", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"ExtendedProperties\": {},\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"Analyses\": \"\",\n \"Attributes\": \"\",\n \"Categories\": \"\",\n \"Database\": \"\",\n \"DefaultAttribute\": \"\",\n \"Elements\": \"\",\n \"EndValue\": \"\",\n \"EventFrames\": \"\",\n \"InterpolatedData\": \"\",\n \"NotificationRules\": \"\",\n \"Parent\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Template\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"MachineName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\",\n \"Paths\": [\n \"\"\n ],\n \"TemplateName\": \"MachineName\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of referenced elements.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c79a7a4d-2ef6-4ec7-bfe5-6de290eea23b", "documentation": "Get the security information of the specified security item associated with the event frame for a specified user.", "method": "get", "endpoint": "eventframes/:webId/security", "responses": [ { "uuid": "b57a5a74-9117-42c4-9947-ea8ea9b5f207", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "2f9d181a-309b-4ea5-966c-ab20b4be5f4d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ba7046fa-3503-43d1-851d-faf43dee61aa", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "cba2eaed-934f-457f-947a-d79f67c59c52", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "fbb86736-2e74-4bcc-a0c8-32a1d677821e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5d8de867-060f-4307-8e4b-dd6386e8cb55", "documentation": "Retrieve the security entries associated with the event frame based on the specified criteria. By default, all security entries for this event frame are returned.", "method": "get", "endpoint": "eventframes/:webId/securityentries", "responses": [ { "uuid": "5d7a1bf1-88f4-480e-a5ac-628ff37e6b74", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "9925d842-aabf-404b-aad2-81edfc70cddd", "documentation": "Create a security entry owned by the event frame.", "method": "post", "endpoint": "eventframes/:webId/securityentries", "responses": [ { "uuid": "81635e0d-1300-4aa4-bcfd-1debbaa6da25", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f934909e-e39a-4b31-a617-fde985aafa07", "documentation": "Delete a security entry owned by the event frame.", "method": "delete", "endpoint": "eventframes/:webId/securityentries/:name", "responses": [ { "uuid": "70c28068-1498-4985-817f-6c748f2127c2", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "28efe07a-4ec5-4d10-9763-14af466157df", "documentation": "Retrieve the security entry associated with the event frame with the specified name.", "method": "get", "endpoint": "eventframes/:webId/securityentries/:name", "responses": [ { "uuid": "39786339-0bab-46df-bc4b-51b2958e13b1", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4fb230ec-e727-4e68-9b20-26f44de997a2", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7830e392-0daa-4b3c-9a99-547b6aaf00a0", "documentation": "Update a security entry owned by the event frame.", "method": "put", "endpoint": "eventframes/:webId/securityentries/:name", "responses": [ { "uuid": "3d8379a8-20a0-4876-b856-199ea74dedf9", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f5a4cc9f-38ba-43a3-af65-e2148b1835e2", "documentation": "Retrieve a notification contact template by path.", "method": "get", "endpoint": "notificationcontacttemplates", "responses": [ { "uuid": "9e75e54f-bd05-4fa0-ba6a-4b661cf6286a", "body": "{\n \"Available\": true,\n \"ConfigString\": \"\",\n \"ContactType\": \"Individual\",\n \"Description\": \"\",\n \"EscalationTimeout\": \"PT3S\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIn\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"MaximumRetries\": 5,\n \"MinimumAcknowledgements\": 2,\n \"Name\": \"Plant Manager\",\n \"NotifyWhenInstanceEnded\": true,\n \"Path\": \"\\\\\\\\MyAssetServer\\\\NotificationContactTemplates[Plant Manager]\",\n \"PlugInName\": \"\",\n \"RetryInterval\": \"PT5S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NCEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification contact template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4b38ec85-7fe3-43fa-a226-ae71c68b8f5c", "documentation": "Retrieve notification contact templates based on the specified conditions. Returns notification contact templates using the specified search query string.", "method": "get", "endpoint": "notificationcontacttemplates/search", "responses": [ { "uuid": "f0653edb-7c62-4562-9f80-16c44fca61ad", "body": "{\n \"Items\": [\n {\n \"Available\": true,\n \"ConfigString\": \"\",\n \"ContactType\": \"Individual\",\n \"Description\": \"\",\n \"EscalationTimeout\": \"PT3S\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIn\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"MaximumRetries\": 5,\n \"MinimumAcknowledgements\": 2,\n \"Name\": \"Plant Manager\",\n \"NotifyWhenInstanceEnded\": true,\n \"Path\": \"\\\\\\\\MyAssetServer\\\\NotificationContactTemplates[Plant Manager]\",\n \"PlugInName\": \"\",\n \"RetryInterval\": \"PT5S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NCEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification contact templates matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "95f4dd01-a457-4d46-be88-fe39db5e346d", "documentation": "Delete a notification contact template.", "method": "delete", "endpoint": "notificationcontacttemplates/:webId", "responses": [ { "uuid": "7aed8b3c-b0fd-43bf-ac2d-4e6ba9972b3c", "body": "", "latency": 0, "statusCode": 204, "label": "The notification contact template was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "fd795cf5-9c46-47ef-b776-fa4a85bb4929", "documentation": "Retrieve a notification contact template.", "method": "get", "endpoint": "notificationcontacttemplates/:webId", "responses": [ { "uuid": "5b6674a2-57cc-4577-8a06-86e83dd3663c", "body": "{\n \"Available\": true,\n \"ConfigString\": \"\",\n \"ContactType\": \"Individual\",\n \"Description\": \"\",\n \"EscalationTimeout\": \"PT3S\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIn\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"MaximumRetries\": 5,\n \"MinimumAcknowledgements\": 2,\n \"Name\": \"Plant Manager\",\n \"NotifyWhenInstanceEnded\": true,\n \"Path\": \"\\\\\\\\MyAssetServer\\\\NotificationContactTemplates[Plant Manager]\",\n \"PlugInName\": \"\",\n \"RetryInterval\": \"PT5S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NCEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification contact template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b9b2d950-8ef1-4955-97a8-5364fee95fce", "documentation": "Update a notification contact template by replacing items in its definition.", "method": "patch", "endpoint": "notificationcontacttemplates/:webId", "responses": [ { "uuid": "a18971d4-04bd-4d36-9ade-43e901a6bc76", "body": "", "latency": 0, "statusCode": 204, "label": "The notification contact template was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "81e9d38e-c581-47c3-ac74-f95a3117ef83", "documentation": "Retrieve notification contact template's child templates.", "method": "get", "endpoint": "notificationcontacttemplates/:webId/notificationcontacttemplates", "responses": [ { "uuid": "657bf7d5-d1ac-449a-acc0-6db8401f2f6a", "body": "{\n \"Available\": true,\n \"ConfigString\": \"\",\n \"ContactType\": \"Individual\",\n \"Description\": \"\",\n \"EscalationTimeout\": \"PT3S\",\n \"HasChildren\": {{faker 'datatype.boolean'}},\n \"Id\": \"cbb28260-853d-11e4-80c5-00155d844304\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"NotificationContactTemplates\": \"\",\n \"NotificationPlugIn\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"MaximumRetries\": 5,\n \"MinimumAcknowledgements\": 2,\n \"Name\": \"Plant Manager\",\n \"NotifyWhenInstanceEnded\": true,\n \"Path\": \"\\\\\\\\MyAssetServer\\\\NotificationContactTemplates[Plant Manager]\",\n \"PlugInName\": \"\",\n \"RetryInterval\": \"PT5S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NCEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n}", "latency": 0, "statusCode": 200, "label": "A list of notification contact templates.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ee39bd47-a901-453e-b041-5d63c1b759b3", "documentation": "Get the security information of the specified security item associated with the notification contact template for a specified user.", "method": "get", "endpoint": "notificationcontacttemplates/:webId/security", "responses": [ { "uuid": "9485e042-a6de-44fd-aa68-4265ba53c176", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1f843eb3-cdf5-40d6-86a8-2adc22ba1b68", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "6124f1c8-df17-4227-b4ec-75997546b7d1", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "90b9aa35-93ad-42de-93b2-a9e32646fb75", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "636323a2-8cc1-42da-bcbd-f2aa001828dc", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3dab2198-d788-46c3-91f2-ed80d8f652ea", "documentation": "Retrieve the security entries associated with the notification contact template based on the specified criteria. By default, all security entries for this notification contact template are returned.", "method": "get", "endpoint": "notificationcontacttemplates/:webId/securityentries", "responses": [ { "uuid": "1aabb843-8514-4de4-aff6-a915c6d03452", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f0c52b72-efe5-4d7a-8f49-bca4638c1b74", "documentation": "Create a security entry owned by the notification contact template.", "method": "post", "endpoint": "notificationcontacttemplates/:webId/securityentries", "responses": [ { "uuid": "dea32bab-c16d-49bd-b3e8-4a8f63210555", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5bf2281f-dcfc-4fb3-94f6-201c5f58d1f6", "documentation": "Delete a security entry owned by the notification contact template.", "method": "delete", "endpoint": "notificationcontacttemplates/:webId/securityentries/:name", "responses": [ { "uuid": "00dabde4-6504-446b-be81-e067f7b75588", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2cdd8efd-0d73-4232-a969-4c6e1744ca14", "documentation": "Retrieve the security entry associated with the notification contact template with the specified name.", "method": "get", "endpoint": "notificationcontacttemplates/:webId/securityentries/:name", "responses": [ { "uuid": "5233c954-3cc8-4240-95c4-02424880e110", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b2e1b099-4b9b-4703-87ca-7c78ab29f9da", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "5de47fe5-6ff5-4289-8801-3c74d7ed6c69", "documentation": "Update a security entry owned by the notification contact template.", "method": "put", "endpoint": "notificationcontacttemplates/:webId/securityentries/:name", "responses": [ { "uuid": "be5fd670-ff4b-4e99-9537-a57b9186c304", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "02e03858-0b31-429d-b16f-8e52c55b0a3e", "documentation": "Retrieve a notification plugin by path.", "method": "get", "endpoint": "notificationplugIns", "responses": [ { "uuid": "5641f93d-76f9-432b-9be3-fb8addc5abf3", "body": "{\n \"AssemblyFileName\": \"OSIsoft.AF.Notification.DeliveryChannel.WebService.dll\",\n \"AssemblyID\": \"0b450496-63f6-4207-b4c5-2c1c73ca897a\",\n \"AssemblyLoadProperties\": [\n \"NET4\",\n \"SDK_NET4\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Delivery channel for calling a web service\",\n \"Id\": \"145c35d6-f4d7-41d9-86ae-08e5098d3a96\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"WebService\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsDeliveryChannel[WebService]\",\n \"Version\": \"2.10.0.8516\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"F1DCDqD5loBNH0erqeqJodtALA1jVcFNf02UGGrgjlCY06lgUkVTVFVOSVRcUExVR0lOU0RFTElWRVJZQ0hBTk5FTFtXRUJTRVJWSUNFXQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification plugin.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0e95fac3-e9a6-4933-80f3-a5ea6c03c8e1", "documentation": "Retrieve a notification plugin.", "method": "get", "endpoint": "notificationplugins/:webId", "responses": [ { "uuid": "c6690eff-7cb7-453b-96bc-ca6f4e9e0fd6", "body": "{\n \"AssemblyFileName\": \"OSIsoft.AF.Notification.DeliveryChannel.WebService.dll\",\n \"AssemblyID\": \"0b450496-63f6-4207-b4c5-2c1c73ca897a\",\n \"AssemblyLoadProperties\": [\n \"NET4\",\n \"SDK_NET4\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Delivery channel for calling a web service\",\n \"Id\": \"145c35d6-f4d7-41d9-86ae-08e5098d3a96\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"WebService\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsDeliveryChannel[WebService]\",\n \"Version\": \"2.10.0.8516\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"F1DCDqD5loBNH0erqeqJodtALA1jVcFNf02UGGrgjlCY06lgUkVTVFVOSVRcUExVR0lOU0RFTElWRVJZQ0hBTk5FTFtXRUJTRVJWSUNFXQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification plugin.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "35af0785-2c82-42b5-9840-b75a763ab21f", "documentation": "Retrieve a notification rule by path.", "method": "get", "endpoint": "notificationrules", "responses": [ { "uuid": "04664e39-2258-4e5d-b0a8-b7acb96cf408", "body": "{\n \"AutoCreated\": true,\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\\\\NotificationRules[RuleName]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Disabled\",\n \"TemplateName\": \"MachineName Notification Rule\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification rule.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a9b13561-4f54-49eb-ba52-6f3fdf5176ad", "documentation": "Retrieve notification rules based on the specified conditions. Returns notification rules using the specified search query string.", "method": "get", "endpoint": "notificationrules/search", "responses": [ { "uuid": "e23fee29-eb71-4ab4-b578-fe7e5aab4595", "body": "{\n \"Items\": [\n {\n \"AutoCreated\": true,\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\\\\NotificationRules[RuleName]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Disabled\",\n \"TemplateName\": \"MachineName Notification Rule\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification rules matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "af8dd058-1196-42a6-8bb6-d1e9fe931e53", "documentation": "Delete a notification rule.", "method": "delete", "endpoint": "notificationrules/:webId", "responses": [ { "uuid": "34d76377-7edb-44e7-a518-e167a1f85af1", "body": "", "latency": 0, "statusCode": 204, "label": "The notification rule was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8e53d405-2a0f-4d6a-99fa-67d5106ee30a", "documentation": "Retrieve a notification rule.", "method": "get", "endpoint": "notificationrules/:webId", "responses": [ { "uuid": "9f8446aa-60ac-48a5-b27b-409843976674", "body": "{\n \"AutoCreated\": true,\n \"CategoryNames\": [\n \"Equipment Assets\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Manufacturing Equipment MachineName\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\EngineeringProcess\\\\Equipment\\\\MachineName\\\\NotificationRules[RuleName]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Disabled\",\n \"TemplateName\": \"MachineName Notification Rule\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NRDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0Ag\"\n}", "latency": 0, "statusCode": 200, "label": "A notification rule", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "63429497-6f9e-473d-9008-3e18b95e0d32", "documentation": "Update a notification rule by replacing items in its definition.", "method": "patch", "endpoint": "notificationrules/:webId", "responses": [ { "uuid": "5a9230a4-6ad0-4bfd-a8a7-a266b2467bd5", "body": "", "latency": 0, "statusCode": 204, "label": "The notification rule was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a5e21f05-0a84-4d01-8267-aa990d37e6a4", "documentation": "Retrieve notification rule subscribers.", "method": "get", "endpoint": "notificationrules/:webId/notificationrulesubscribers", "responses": [ { "uuid": "6d73d9ba-5664-4173-b5ac-36d87f0eeb00", "body": "{\n \"Items\": [\n {\n \"ConfigString\": \"ToEmail=mike@testemail.com\",\n \"ContactTemplateName\": \"Plant Manager\",\n \"ContactType\": \"Individual\",\n \"DeliveryFormatName\": \"DeliveryFormat\",\n \"Description\": \"Manufacturing Machine MachineName subscription\",\n \"EscalationTimeout\": \"PT3S\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MaximumRetries\": \"3\",\n \"Name\": \"NotificationSubscriptionRuleName\",\n \"NotifyOption\": \"EventStart\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\NotificationRules[NotificationSubscriptionRuleName]\",\n \"PlugInName\": \"Email\",\n \"RetryInterval\": \"PT3S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification rule subscribers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ca718d92-3455-44cd-ad9f-acdd7c4fc2d8", "documentation": "Create a notification rule subscriber.", "method": "post", "endpoint": "notificationrules/:webId/notificationrulesubscribers", "responses": [ { "uuid": "aab86ca0-f0bd-49c0-a35c-74b90ff6f103", "body": "", "latency": 0, "statusCode": 201, "label": "The notification rule subscriber was created. The response's Location header is a link to the notification rule subscriber.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7769e47f-c0a7-4c2e-85f6-82db8afe154c", "documentation": "Get the security information of the specified security item associated with the notification rule for a specified user.", "method": "get", "endpoint": "notificationrules/:webId/security", "responses": [ { "uuid": "45c67501-7489-4667-b049-a4d93c7127b1", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ada3b9d8-a603-437c-b58a-0dc25a226c74", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "031b80e5-b8e7-4752-bfc5-65f263882404", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "302c6440-cd96-493a-ba04-b203f9a1d28b", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "db499e5b-6f35-4fb4-b76c-e03809d63cc4", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "aa50526f-429c-49fa-a6b5-e171cb4accea", "documentation": "Retrieve the security entries associated with the notification rule based on the specified criteria. By default, all security entries for this notification rule are returned.", "method": "get", "endpoint": "notificationrules/:webId/securityentries", "responses": [ { "uuid": "fcc6f80d-8521-47e6-9245-3389f349a024", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "195e2050-ae75-4167-a3da-7e7c327db9f2", "documentation": "Create a security entry owned by the notification rule.", "method": "post", "endpoint": "notificationrules/:webId/securityentries", "responses": [ { "uuid": "b27caf4f-eab5-41c1-bf89-34018bc928fd", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "db1556e2-243a-4513-8f00-b8bccbaae64f", "documentation": "Delete a security entry owned by the notification rule.", "method": "delete", "endpoint": "notificationrules/:webId/securityentries/:name", "responses": [ { "uuid": "fc895e98-4044-4cf4-9d15-38e12e0a1d12", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "41342ed6-95ab-4c6d-83fb-a8eef5c8bcc1", "documentation": "Retrieve the security entry associated with the notification rule with the specified name.", "method": "get", "endpoint": "notificationrules/:webId/securityentries/:name", "responses": [ { "uuid": "96a0c816-fd9d-49ce-a737-4d96000ff444", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "94a87ca3-42e4-4d19-9cf8-a651e827044e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "091be6df-479d-45e1-a9a9-32fb4c9cde54", "documentation": "Update a security entry owned by the notification rule.", "method": "put", "endpoint": "notificationrules/:webId/securityentries/:name", "responses": [ { "uuid": "8475003e-0020-417a-a292-78357bc681f5", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1101846a-f139-4cc1-a930-6932c563aacd", "documentation": "Retrieve a notification rule subscriber by path.", "method": "get", "endpoint": "notificationrulesubscribers", "responses": [ { "uuid": "78b59054-6258-4a88-bca5-f62e4ed6211c", "body": "{\n \"ConfigString\": \"ToEmail=mike@testemail.com\",\n \"ContactTemplateName\": \"Plant Manager\",\n \"ContactType\": \"Individual\",\n \"DeliveryFormatName\": \"DeliveryFormat\",\n \"Description\": \"Manufacturing Machine MachineName subscription\",\n \"EscalationTimeout\": \"PT3S\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MaximumRetries\": \"3\",\n \"Name\": \"NotificationSubscriptionRuleName\",\n \"NotifyOption\": \"EventStart\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\NotificationRules[NotificationSubscriptionRuleName]\",\n \"PlugInName\": \"Email\",\n \"RetryInterval\": \"PT3S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification rule subscriber.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3722c006-c7d5-4ef2-be49-64e8595865bd", "documentation": "Delete a notification rule subscriber.", "method": "delete", "endpoint": "notificationrulesubscribers/:webId", "responses": [ { "uuid": "76f2138a-5933-4f1a-9215-568a351cbba2", "body": "", "latency": 0, "statusCode": 204, "label": "The notification rule subscriber was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "aba47946-17c2-4ccd-a52d-231e636b13a3", "documentation": "Retrieve a notification rule subscriber.", "method": "get", "endpoint": "notificationrulesubscribers/:webId", "responses": [ { "uuid": "a3a2fa1b-7c80-4af2-bbc1-48f54beb6448", "body": "{\n \"ConfigString\": \"ToEmail=mike@testemail.com\",\n \"ContactTemplateName\": \"Plant Manager\",\n \"ContactType\": \"Individual\",\n \"DeliveryFormatName\": \"DeliveryFormat\",\n \"Description\": \"Manufacturing Machine MachineName subscription\",\n \"EscalationTimeout\": \"PT3S\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MaximumRetries\": \"3\",\n \"Name\": \"NotificationSubscriptionRuleName\",\n \"NotifyOption\": \"EventStart\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\NotificationRules[NotificationSubscriptionRuleName]\",\n \"PlugInName\": \"Email\",\n \"RetryInterval\": \"PT3S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA\"\n}", "latency": 0, "statusCode": 200, "label": "A notification rule subscriber", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7eecb315-76f2-4195-a4fd-ab6e995a9d5d", "documentation": "Update a notification rule subscriber.", "method": "patch", "endpoint": "notificationrulesubscribers/:webId", "responses": [ { "uuid": "0d378f07-20c0-439e-bea4-ab824192dd6b", "body": "", "latency": 0, "statusCode": 204, "label": "The notification rule subscriber was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c6703683-a8a5-41f3-a8af-c50d1c933b00", "documentation": "Retrieve notification rule subscriber subscribers.", "method": "get", "endpoint": "notificationrulesubscribers/:webId/notificationrulesubscribers", "responses": [ { "uuid": "960183d1-e477-4293-8953-8560cebf1aa6", "body": "{\n \"Items\": [\n {\n \"ConfigString\": \"ToEmail=mike@testemail.com\",\n \"ContactTemplateName\": \"Plant Manager\",\n \"ContactType\": \"Individual\",\n \"DeliveryFormatName\": \"DeliveryFormat\",\n \"Description\": \"Manufacturing Machine MachineName subscription\",\n \"EscalationTimeout\": \"PT3S\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MaximumRetries\": \"3\",\n \"Name\": \"NotificationSubscriptionRuleName\",\n \"NotifyOption\": \"EventStart\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\NotificationRules[NotificationSubscriptionRuleName]\",\n \"PlugInName\": \"Email\",\n \"RetryInterval\": \"PT3S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification rules subscribers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "04a29393-d52e-4c2d-b888-5fd2d74afa12", "documentation": "Retrieve a notification rule template by path.", "method": "get", "endpoint": "notificationruletemplates", "responses": [ { "uuid": "b5bfaf87-fb80-4046-95a7-e5cf9a3531fe", "body": "{\n \"CategoryNames\": [\n \"MachineNameAlerts\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Description entered by the user\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\ElementTemplates[Template3]\\\\NotificationRuleTemplates[Notification Rule Template]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Functioning\",\n \"TemplateName\": \"MachineName Notification Rule Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification rule template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "40cc4e92-a8db-4752-821d-dd38d8952c92", "documentation": "Retrieve Notification rule templates based on the specified conditions. Returns Notification rule templates using the specified search query string.", "method": "get", "endpoint": "notificationruletemplates/search", "responses": [ { "uuid": "3f0483bb-f015-443e-8fb3-883f76254f4d", "body": "{\n \"Items\": [\n {\n \"CategoryNames\": [\n \"MachineNameAlerts\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Description entered by the user\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\ElementTemplates[Template3]\\\\NotificationRuleTemplates[Notification Rule Template]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Functioning\",\n \"TemplateName\": \"MachineName Notification Rule Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification rule templates matching the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7c82c42d-966f-4313-99f5-729634fa20eb", "documentation": "Delete a notification rule template.", "method": "delete", "endpoint": "notificationruletemplates/:webId", "responses": [ { "uuid": "ba17720b-f7b3-443a-ba5d-1f3797d708f3", "body": "", "latency": 0, "statusCode": 204, "label": "The notification rule template was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c3248ec4-7ed4-4821-8d9f-93706ae40ef9", "documentation": "Get the specified notification rule template.", "method": "get", "endpoint": "notificationruletemplates/:webId", "responses": [ { "uuid": "fffe18b6-fd80-4887-aa81-b32443eae6a8", "body": "{\n \"CategoryNames\": [\n \"MachineNameAlerts\"\n ],\n \"Criteria\": \"Name: EventFrameCriteriaName\",\n \"Description\": \"Description entered by the user\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MultiTriggerEventOption\": \"HighestSeverity\",\n \"Name\": \"MachineName\",\n \"NonrepetitionInterval\": \"PT3S\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\CityName\\\\ElementTemplates[Template3]\\\\NotificationRuleTemplates[Notification Rule Template]\",\n \"ResendInterval\": \"PT5S\",\n \"Status\": \"Functioning\",\n \"TemplateName\": \"MachineName Notification Rule Template\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NTDqD5loBNH0erqeqJodtALAtdcX5JH_5xGEKAAVXTSaAg\"\n}", "latency": 0, "statusCode": 200, "label": "The specified notification rule template.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a31b10fd-e33d-436c-bb18-de889047212a", "documentation": "Update a notification rule template by replacing items in its definition.", "method": "patch", "endpoint": "notificationruletemplates/:webId", "responses": [ { "uuid": "1465f06f-d36a-43a4-9c3d-54eb197a9cb0", "body": "", "latency": 0, "statusCode": 204, "label": "The notification rule template was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cbc6f9c0-d7df-439c-95d3-92686a273bdb", "documentation": "Retrieve notification rule template subscribers.", "method": "get", "endpoint": "notificationruletemplates/:webId/notificationrulesubscribers", "responses": [ { "uuid": "59ae1f73-e885-4ce1-82c9-c0cadb0bc0bb", "body": "{\n \"Items\": [\n {\n \"ConfigString\": \"ToEmail=mike@testemail.com\",\n \"ContactTemplateName\": \"Plant Manager\",\n \"ContactType\": \"Individual\",\n \"DeliveryFormatName\": \"DeliveryFormat\",\n \"Description\": \"Manufacturing Machine MachineName subscription\",\n \"EscalationTimeout\": \"PT3S\",\n \"Id\": \"e9a984d0-f47c-11e7-8454-00155d029708\",\n \"MaximumRetries\": \"3\",\n \"Name\": \"NotificationSubscriptionRuleName\",\n \"NotifyOption\": \"EventStart\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\NotificationRules[NotificationSubscriptionRuleName]\",\n \"PlugInName\": \"Email\",\n \"RetryInterval\": \"PT3S\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1NSLDqD5loBNH0erqeqJodtALA5bYfWno26BGgMQAVXYR0AgPUJJXNlEW1w78rnCXDmcDA\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of notification rule template subscribers.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "3fd50c68-5f6d-4275-ad23-47d262892011", "documentation": "Create a notification rule subscriber.", "method": "post", "endpoint": "notificationruletemplates/:webId/notificationrulesubscribers", "responses": [ { "uuid": "12b57910-221a-404a-bed2-1391b6ecb119", "body": "", "latency": 0, "statusCode": 201, "label": "The notification rule subscriber was created. The response's Location header is a link to the notification rule subscriber.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "19cf60ff-f571-406a-a5cc-069e2c3f4598", "documentation": "Get the security information of the specified security item associated with the notification rule template for a specified user.", "method": "get", "endpoint": "notificationruletemplates/:webId/security", "responses": [ { "uuid": "f782c890-dece-4fb5-aa38-e462f896ffb0", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5e3b3581-167a-434d-93c8-e2dd9c721d59", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1e7e4d5f-d4bf-446f-a2a0-52511e613ce3", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "2de54e32-88ce-4626-bc2c-41bddfb73213", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e60734af-116c-4993-ac73-d46a905f0d8c", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b67d5ccf-94e0-4e90-a5d0-516e543b40a7", "documentation": "Retrieve the security entries associated with the notification rule template based on the specified criteria. By default, all security entries for this notification rule template are returned.", "method": "get", "endpoint": "notificationruletemplates/:webId/securityentries", "responses": [ { "uuid": "36842f97-f2ac-444d-9069-9720f48e9064", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b8f1e6fb-e95b-4c64-8b91-c74b3a5ccb3c", "documentation": "Create a security entry owned by the notification rule template.", "method": "post", "endpoint": "notificationruletemplates/:webId/securityentries", "responses": [ { "uuid": "52640b14-3b24-44b8-8e9b-3cb9f048dc37", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "1419f2af-1fdb-4ee1-b8ac-1f454bc3c3ce", "documentation": "Delete a security entry owned by the notification rule template.", "method": "delete", "endpoint": "notificationruletemplates/:webId/securityentries/:name", "responses": [ { "uuid": "851bc8a5-f703-466a-80f3-38d7dfd1ff14", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d8f9a38b-544c-4e1c-9cd6-de69893989a9", "documentation": "Retrieve the security entry associated with the notification rule template with the specified name.", "method": "get", "endpoint": "notificationruletemplates/:webId/securityentries/:name", "responses": [ { "uuid": "77c54d6d-62d7-4d56-a9ff-76825dc086d5", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1c99eac6-6cf1-4b4d-b3a8-900800724722", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bc2f45f5-f725-4cb8-8fd8-43bcfe33677d", "documentation": "Update a security entry owned by the notification rule template.", "method": "put", "endpoint": "notificationruletemplates/:webId/securityentries/:name", "responses": [ { "uuid": "595ad46a-f5fa-43f8-84ae-7a15028bf811", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b8e35818-f147-49b3-a77a-74308f63690d", "documentation": "Get a point by path.", "method": "get", "endpoint": "points", "responses": [ { "uuid": "822c98a9-ee1c-400b-9d17-681bfe7563da", "body": "{\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Links\": {\n \"Attributes\": \"\",\n \"DataServer\": \"\",\n \"EndValue\": \"\",\n \"InterpolatedData\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n}", "latency": 0, "statusCode": 200, "label": "The specified point.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4ee3b92b-3f0c-4bed-8156-a2b80194136b", "documentation": "Retrieve multiple points by web id or path.", "method": "get", "endpoint": "points/multiple", "responses": [ { "uuid": "c53483ee-9cd1-4626-b6c2-fd25ff39cdf2", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Links\": {\n \"Attributes\": \"\",\n \"DataServer\": \"\",\n \"EndValue\": \"\",\n \"InterpolatedData\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The requested points", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "08505689-b0ec-4db8-9db5-d9c204725cdd", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"Identifier\": \"\\\\\\\\server\\\\path\",\n \"IdentifierType\": \"Path\",\n \"Object\": {\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Links\": {\n \"Attributes\": \"\",\n \"DataServer\": \"\",\n \"EndValue\": \"\",\n \"InterpolatedData\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "Some or all items contain exceptions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "04a931a3-6f00-4ea2-b5a0-75323866c285", "documentation": "Delete a point.", "method": "delete", "endpoint": "points/:webId", "responses": [ { "uuid": "bcf782ba-efa0-4fc5-a5eb-e3598a393b08", "body": "", "latency": 0, "statusCode": 204, "label": "The point was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cce5bcef-30bd-4079-b001-e70da6c4f0f4", "documentation": "Get a point.", "method": "get", "endpoint": "points/:webId", "responses": [ { "uuid": "4d207374-2084-4a07-956b-466e46fa0a61", "body": "{\n \"Descriptor\": \"12 Hour Sine Wave\",\n \"DigitalSetName\": \"\",\n \"DisplayDigits\": -5,\n \"EngineeringUnits\": \"\",\n \"Future\": {{faker 'datatype.boolean'}},\n \"Id\": 82,\n \"Links\": {\n \"Attributes\": \"\",\n \"DataServer\": \"\",\n \"EndValue\": \"\",\n \"InterpolatedData\": \"\",\n \"PlotData\": \"\",\n \"RecordedData\": \"\",\n \"Self\": \"\",\n \"SummaryData\": \"\",\n \"Value\": \"\"\n },\n \"Name\": \"PointName\",\n \"Path\": \"\\\\\\\\MyPIServer\\\\PointName\",\n \"PointClass\": \"classic\",\n \"PointType\": \"Float32\",\n \"Span\": 100,\n \"Step\": {{faker 'datatype.boolean'}},\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1DPa70Wf0zBA06CLkV9ovNQgQCAAAAA\",\n \"Zero\": {{faker 'datatype.number'}}\n}", "latency": 0, "statusCode": 200, "label": "The specified point.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "32234594-fb11-427f-aeb1-8f95578801b4", "documentation": "Update a point. The only PI Point attributes that can be updated include: Name, Descriptor, EngineeringUnits, Step, and DisplayDigits. Other PI Point attributes cannot be updated through PI Web API.", "method": "patch", "endpoint": "points/:webId", "responses": [ { "uuid": "fc7712f8-4a9c-4bc0-a649-753e69cb9faa", "body": "", "latency": 0, "statusCode": 204, "label": "The point was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8eb15604-ba98-40e4-b9da-db50bba210e2", "documentation": "Get point attributes.", "method": "get", "endpoint": "points/:webId/attributes", "responses": [ { "uuid": "ca901e77-0a91-434c-8b22-0f919202acf6", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Point\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"typicalvalue\",\n \"Value\": 50,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of point attributes based on the specified names and name filter.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "182f1ebf-0479-4ba1-a786-fb9913d673c5", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Some or all of the point attribute names could not be found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "7a3c7ed8-28dc-408d-9a73-ed34e6acdf3c", "documentation": "Get a point attribute by name.", "method": "get", "endpoint": "points/:webId/attributes/:name", "responses": [ { "uuid": "dcc7c5f1-8d79-47ae-9ae1-fdb869e479f3", "body": "{\n \"Links\": {\n \"Point\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"typicalvalue\",\n \"Value\": 50,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A point attribute specified by its name.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ecbf84a8-417d-4828-873d-d82cfac978b6", "documentation": "Retrieve a security identity by path.", "method": "get", "endpoint": "securityidentities", "responses": [ { "uuid": "608062ee-3b1d-4bee-9f3b-d843dddaaf5e", "body": "{\n \"Description\": \"\",\n \"Id\": \"f3a5ee49-1838-4aa2-9d79-e16294523db7\",\n \"IsEnabled\": true,\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityIdentity\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityIdentities[MySecurityIdentity]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified security identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4f3ff10d-8102-4f85-89e5-b0bb4e8d508b", "documentation": "Delete a security identity.", "method": "delete", "endpoint": "securityidentities/:webId", "responses": [ { "uuid": "ce8171b7-87b3-453c-9813-df147051958c", "body": "", "latency": 0, "statusCode": 204, "label": "The security identity was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "00d92a71-f5a1-4e18-983b-6a256986f956", "documentation": "Retrieve a security identity.", "method": "get", "endpoint": "securityidentities/:webId", "responses": [ { "uuid": "d4a7fed2-42aa-4d71-96ab-1e3cdd012cb0", "body": "{\n \"Description\": \"\",\n \"Id\": \"f3a5ee49-1838-4aa2-9d79-e16294523db7\",\n \"IsEnabled\": true,\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityMappings\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityIdentity\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityIdentities[MySecurityIdentity]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SIDqD5loBNH0erqeqJodtALASe6l8zgYokqdeeFilFI9tw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified security identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cdbc05b4-75f1-4b09-bdad-cfbdc09fa73b", "documentation": "Update a security identity by replacing items in its definition.", "method": "patch", "endpoint": "securityidentities/:webId", "responses": [ { "uuid": "0ee5bf7e-3fcc-4a18-8141-98a52a1cb560", "body": "", "latency": 0, "statusCode": 204, "label": "The security identity was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "97bdb7f2-c76f-44bb-b07d-21c6333094a6", "documentation": "Get the security information of the specified security item associated with the security identity for a specified user.", "method": "get", "endpoint": "securityidentities/:webId/security", "responses": [ { "uuid": "10dba272-1a5a-4f7f-a883-9437fc5b8732", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8855d250-5b15-4064-954f-8690a38a9d8a", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "59b31b08-2a2b-4dc0-9728-2ae17cdcb7a0", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "8f5b2341-1f7f-4130-84af-125016c1b6c7", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "b0aa25e6-7155-49ae-9db7-865b89e5595d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3de9792f-cc73-4b9b-a2cf-3b14c70e8ed5", "documentation": "Retrieve the security entries associated with the security identity based on the specified criteria. By default, all security entries for this security identity are returned.", "method": "get", "endpoint": "securityidentities/:webId/securityentries", "responses": [ { "uuid": "b4f8f2c7-6efe-4e89-bb6d-3b4e420d3bf5", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bc0d6212-983b-4e6e-b1cc-14deb9431169", "documentation": "Retrieve the security entry associated with the security identity with the specified name.", "method": "get", "endpoint": "securityidentities/:webId/securityentries/:name", "responses": [ { "uuid": "5a2a3a23-8a04-49d1-859d-76ba89e51b83", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "05f84bbd-a79f-42f2-874b-20d9f0c3fd74", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "af061099-4853-451c-aa38-9498fb905b92", "documentation": "Get security mappings for the specified security identity.", "method": "get", "endpoint": "securityidentities/:webId/securitymappings", "responses": [ { "uuid": "71fd8d8e-7952-47f2-984d-64b15eca145f", "body": "{\n \"Items\": [\n {\n \"Account\": \"domain\\\\user\",\n \"Description\": \"\",\n \"Id\": \"ac14ef82-19c0-4a07-96a7-d1fb0b84c05d\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityMapping\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityMappings[MySecurityMapping]\",\n \"SecurityIdentityWebId\": \"I1SIEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SMDqD5loBNH0erqeqJodtALAgu8UrMAZB0qWp9H7C4TAXQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security mappings for the specified security identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "da0bf469-70cc-4876-a02f-688470c8ea29", "documentation": "Retrieve a security mapping by path.", "method": "get", "endpoint": "securitymappings", "responses": [ { "uuid": "e64b12a2-c7b9-4253-8cb7-6a31ecdcb94a", "body": "{\n \"Account\": \"domain\\\\user\",\n \"Description\": \"\",\n \"Id\": \"ac14ef82-19c0-4a07-96a7-d1fb0b84c05d\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityMapping\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityMappings[MySecurityMapping]\",\n \"SecurityIdentityWebId\": \"I1SIEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SMDqD5loBNH0erqeqJodtALAgu8UrMAZB0qWp9H7C4TAXQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified security mapping.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7766030b-e42a-4aa5-a389-e1413c8e0ae8", "documentation": "Delete a security mapping.", "method": "delete", "endpoint": "securitymappings/:webId", "responses": [ { "uuid": "4bd26c9b-8bf3-42e0-9edb-bdee46bbb59e", "body": "", "latency": 0, "statusCode": 204, "label": "The security mapping was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "388f8608-9c30-4483-ae13-30d0f66247a6", "documentation": "Retrieve a security mapping.", "method": "get", "endpoint": "securitymappings/:webId", "responses": [ { "uuid": "4960ff10-caef-4c71-a284-bc62cfade7ea", "body": "{\n \"Account\": \"domain\\\\user\",\n \"Description\": \"\",\n \"Id\": \"ac14ef82-19c0-4a07-96a7-d1fb0b84c05d\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"MySecurityMapping\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\SecurityMappings[MySecurityMapping]\",\n \"SecurityIdentityWebId\": \"I1SIEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1SMDqD5loBNH0erqeqJodtALAgu8UrMAZB0qWp9H7C4TAXQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified security mapping.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8ee65755-b08f-47d0-b4fa-d56ca54856f2", "documentation": "Update a security mapping by replacing items in its definition.", "method": "patch", "endpoint": "securitymappings/:webId", "responses": [ { "uuid": "dc76ebf4-f791-40e1-9e0d-20ac6875c679", "body": "", "latency": 0, "statusCode": 204, "label": "The security mapping was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "278076de-7d13-4bba-b031-49de2fe1b66a", "documentation": "Get the security information of the specified security item associated with the security mapping for a specified user.", "method": "get", "endpoint": "securitymappings/:webId/security", "responses": [ { "uuid": "a3522081-ba01-43e1-9e89-9e69a2dfd7c4", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "1925bfc1-0906-419d-9bb2-56c94ada3ea1", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user mapping.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "570cef0d-e53e-430e-a708-63a0d77b94cd", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user mapping.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "666fd1e0-b5ba-43b0-94b9-1d24c0773471", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3c201652-e2ec-4e5c-8427-76ac0a34696c", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user mapping.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4226280a-e8ed-436f-966a-22ae018a8e1a", "documentation": "Retrieve the security entries associated with the security mapping based on the specified criteria. By default, all security entries for this security mapping are returned.", "method": "get", "endpoint": "securitymappings/:webId/securityentries", "responses": [ { "uuid": "3ea55515-5eb0-49dd-bd5c-9d6006d62a91", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "4f86db2a-2a09-44be-b5f7-03c81d242cc4", "documentation": "Retrieve the security entry associated with the security mapping with the specified name.", "method": "get", "endpoint": "securitymappings/:webId/securityentries/:name", "responses": [ { "uuid": "86571c34-cf12-464e-b0cd-e90bac0126bd", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "143c04f9-c89c-4f25-a52c-28dcc27ae6be", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "541bab4a-8566-4b88-83e2-0fba0d25785a", "documentation": "Receive stream updates", "method": "get", "endpoint": "streams/updates/:marker", "responses": [ { "uuid": "7db948ed-52d7-4ef4-8a6c-4ebb423002ba", "body": "{\n \"Events\": [\n {\n \"Action\": \"Add\",\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"PreviousEventAction\": \"PreviousEventArchived\",\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"LatestMarker\": \"0cbbec466f3a42288c8c47112f54b852_12\",\n \"RequestedMarker\": \"0cbbec466f3a42288c8c47112f54b852_0\",\n \"Source\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"SourceName\": \"Water\",\n \"SourcePath\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Status\": \"Created\"\n}", "latency": 0, "statusCode": 200, "label": "The stream updates have been successfully retrieved", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "04bcc613-1798-4583-a6eb-d09cc9bd1547", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "Cache not found", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "7b843a08-bc79-455b-b26e-99d5fcd5d0f0", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Invalid marker supplied", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a9594fdc-219e-4ccc-b62d-aed7969bc95a", "documentation": "Opens a channel that will send messages about any value changes for the specified stream.", "method": "get", "endpoint": "streams/:webId/channel", "responses": [ { "uuid": "c830fd93-c3ba-4296-910d-b116da9277c0", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 101, "label": "Switches to the Web Socket protocol.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "cc818422-7fac-4c37-a00d-83dbb7223a02", "documentation": "Returns the end-of-stream value of the stream.", "method": "get", "endpoint": "streams/:webId/end", "responses": [ { "uuid": "02598bd2-135c-48d6-b432-c502a5ecd435", "body": "{\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The value at the specified time value.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "27ecd6b2-77b9-4727-8f85-4018e43317c4", "documentation": "Retrieves interpolated values over the specified time range at the specified sampling interval.", "method": "get", "endpoint": "streams/:webId/interpolated", "responses": [ { "uuid": "b5cea36d-eb45-438f-997f-3e437b3cd0cf", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The values that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4df8cd4f-2633-40a1-b96e-dd9c17f5a5d4", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "bb481c38-5455-4996-ad29-842659179275", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support this method, or the supplied filter expression is unsupported, or the desired units of measure are incompatible.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "10971849-515f-487a-b01c-ab6076c9050d", "documentation": "Retrieves interpolated values over the specified time range at the specified sampling interval.", "method": "get", "endpoint": "streams/:webId/interpolatedattimes", "responses": [ { "uuid": "ccc548f8-d0d7-42ea-a583-e2234e651511", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The values that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7cd7f87d-a4ff-41fd-82fd-2803de9ffcec", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "fb47f7de-53a3-42c5-8b0e-f5deeacda261", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support this method, or the supplied filter expression is unsupported, or the desired units of measure are incompatible.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "95955fa0-ca97-4a9d-b523-b64aba70dddf", "documentation": "Retrieves values over the specified time range suitable for plotting over the number of intervals (typically represents pixels).", "method": "get", "endpoint": "streams/:webId/plot", "responses": [ { "uuid": "e603421b-195a-4542-9aff-325e066c57ea", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The values that meet the specified conditions", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "e2d646a3-6a93-4fc1-8502-c75c5c13cd3c", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "deeec730-e405-40a3-99e2-9af81423ee34", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support this method, or the desired units of measure are incompatible.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f69a099d-d184-420e-82ea-f1c1ad92e2c9", "documentation": "Returns a list of compressed values for the requested time range from the source provider.", "method": "get", "endpoint": "streams/:webId/recorded", "responses": [ { "uuid": "9097966a-b6f0-4738-b009-054364c29da6", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Annotations\": [\n {\n \"CreationDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Creator\": \"MyDomain\\\\UserA\",\n \"Description\": \"Signifies a spike in temperature.\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Id\": \"512B6616-CE39-4F70-9048-8C6A025FB592\",\n \"Modifier\": \"MyDomain\\\\UserA\",\n \"ModifyDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Name\": \"Temperature Annotation\",\n \"Value\": \"The temperature spiked because of a malfunction with a unit in our west plant.\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The values that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "4b8cdc4b-b8b8-4f8e-9351-86211bb5d84d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e11b9570-1639-4213-a84c-49fde3dd0ac1", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support the method, or the supplied filter expression is unsupported, or the desired units of measure are incompatible, or an unsupported association was specified.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ab46a967-034c-4a23-83bd-79531743e4e2", "documentation": "Updates multiple values for the specified stream.", "method": "post", "endpoint": "streams/:webId/recorded", "responses": [ { "uuid": "d40dfc22-299b-446f-a065-f42fbaf43cb1", "body": "{\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 204, "label": "All updates executed successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ed97a08b-160e-4806-85ed-6990603e9bdb", "body": "{\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "The operation was a partial success. The response body contains substatuses and errors in the same order as the supplied values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "4fd912b6-9732-4b54-af8e-7f39f5cb706b", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support this operation.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3116a4d6-eca9-42b3-8cd6-bf7676f0525b", "documentation": "Returns a single recorded value based on the passed time and retrieval mode from the stream.", "method": "get", "endpoint": "streams/:webId/recordedattime", "responses": [ { "uuid": "c81d94e7-f1af-4bbf-91f9-71eb0ae43309", "body": "{\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Annotations\": [\n {\n \"CreationDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Creator\": \"MyDomain\\\\UserA\",\n \"Description\": \"Signifies a spike in temperature.\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Id\": \"512B6616-CE39-4F70-9048-8C6A025FB592\",\n \"Modifier\": \"MyDomain\\\\UserA\",\n \"ModifyDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Name\": \"Temperature Annotation\",\n \"Value\": \"The temperature spiked because of a malfunction with a unit in our west plant.\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The value that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "76646d9b-ea07-4db5-91d9-098c0740f073", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "c84ad5b0-6a92-43c9-b4e0-db08ebac1b98", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support the method, or the desired units of measure are incompatible.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "76c13c90-2547-40b6-a33b-a048c73bb2cd", "documentation": "Retrieves recorded values at the specified times.", "method": "get", "endpoint": "streams/:webId/recordedattimes", "responses": [ { "uuid": "ebaa319a-b5ed-4fc0-85d7-ba18ef902fc7", "body": "{\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Annotations\": [\n {\n \"CreationDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Creator\": \"MyDomain\\\\UserA\",\n \"Description\": \"Signifies a spike in temperature.\",\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Id\": \"512B6616-CE39-4F70-9048-8C6A025FB592\",\n \"Modifier\": \"MyDomain\\\\UserA\",\n \"ModifyDate\": \"2016-06-21T14:45:50.2988321Z\",\n \"Name\": \"Temperature Annotation\",\n \"Value\": \"The temperature spiked because of a malfunction with a unit in our west plant.\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"UnitsAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The values that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "696292c0-fb97-4344-bdc0-a7fb9d2953dd", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "e22e6d4b-698e-4801-88ae-210217e17278", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support this method, or the desired units of measure are incompatible.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "78c761c5-2edc-4f17-a454-2897b1e360a2", "documentation": "Returns a summary over the specified time range for the stream.", "method": "get", "endpoint": "streams/:webId/summary", "responses": [ { "uuid": "e7961ac9-e684-48b2-9d61-e821c73cdbec", "body": "{\n \"Items\": [\n {\n \"Type\": \"Total\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The summaries that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "49095d89-06b8-46c4-b5d2-f38062c5bc06", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support this method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f690fbec-f2dd-4918-89c9-11a6bd4459f4", "documentation": "Register for stream updates", "method": "post", "endpoint": "streams/:webId/updates", "responses": [ { "uuid": "5fe3d073-521d-4593-9af3-37bb3c3e54e6", "body": "{\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"LatestMarker\": \"0cbbec466f3a42288c8c47112f54b852_12\",\n \"Source\": \"I1AbEDqD5loBNH0erqeqJodtALA9iLxz4m_5RGAxgAVXYUACw_yrS377vX0uZVHTgkanusw\",\n \"SourceName\": \"Water\",\n \"SourcePath\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Status\": \"Succeeded\"\n}", "latency": 0, "statusCode": 200, "label": "Successful registration", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "55fd226c-911b-454d-b22a-79ac9aa65812", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Invalid webId", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3c6e769d-982a-44c2-9337-f15474d932f6", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "WebId represents a static attribute", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "75ebb042-d972-4fff-8ea9-6ae22b26d0fc", "documentation": "Returns the value of the stream at the specified time. By default, this is usually the current value.", "method": "get", "endpoint": "streams/:webId/value", "responses": [ { "uuid": "b44d2986-10f5-4510-b6ff-91b3b0418c88", "body": "{\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The value at the specified time value.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5cfd5c30-d0c1-46aa-8b9e-b634669194a3", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The data reference does not support the method, or the desired units of measure are incompatible.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9ece61f2-43be-4574-964f-108dfb94bb95", "documentation": "Updates a value for the specified stream.", "method": "post", "endpoint": "streams/:webId/value", "responses": [ { "uuid": "8e3a2171-3696-4816-90d4-5debb9a9e615", "body": "", "latency": 0, "statusCode": 202, "label": "The value was accepted for a potential buffered update. The response's Location header is a link that can be used to examine the result.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "cddc118c-cd93-4310-94ad-08c105405060", "body": "", "latency": 0, "statusCode": 204, "label": "The update operation was successfully applied. The response's Location header is a link that can be used to examine the result.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "29fb81cc-dd66-49bd-9845-2a2b6dfffc1e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "2875982f-2c19-4ada-ac7a-68dbcd3f393b", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "The attribute or data reference does not support this operation, or the specified units are incompatible.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a5eaf518-ce27-4c06-b251-25204fd35d78", "documentation": "Opens a channel that will send messages about any value changes for the specified streams.", "method": "get", "endpoint": "streamsets/channel", "responses": [ { "uuid": "21c10053-5cbe-47ed-99c3-f43b11cf08e2", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 101, "label": "Switches to the Web Socket protocol.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e5b3aae5-46bf-4b48-8c36-034b6a9012e3", "documentation": "Returns End Of Stream values for attributes of the specified streams", "method": "get", "endpoint": "streamsets/end", "responses": [ { "uuid": "27905797-8911-42a1-856d-fc7641f73c35", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "End of stream values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "50a949af-9d82-4350-8d93-4f78492d82b3", "documentation": "Returns interpolated values of the specified streams over the specified time range at the specified sampling interval.", "method": "get", "endpoint": "streamsets/interpolated", "responses": [ { "uuid": "1cdef123-b562-4227-9e8d-4e4d8b793727", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Interpolated values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5178a2c8-87b1-4346-9431-4b524e79bca7", "documentation": "Returns interpolated values of the specified streams at the specified times.", "method": "get", "endpoint": "streamsets/interpolatedattimes", "responses": [ { "uuid": "e895a3bd-6a8c-4b49-875b-7d70685af379", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Interpolated values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9bf525b1-c869-4303-bcd0-79348ec2d8a0", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "464c4aed-7a52-4674-82fc-4314dd913713", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "The request was cancelled.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "f938e683-7408-4dac-9ff0-1e1a0e31f9a4", "documentation": "Returns the base stream's recorded values and subordinate streams' interpolated values at times matching the recorded values' timestamps.", "method": "get", "endpoint": "streamsets/joined", "responses": [ { "uuid": "0fbcd8fa-2406-4b98-8d4e-6f8712cc7d3c", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Recorded values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "7f7f99a4-d2a5-48ca-932b-0b1d03a4ce3a", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "04974bb3-8e9d-41f6-899e-2da083a76478", "documentation": "Returns values of attributes for the specified streams over the specified time range suitable for plotting over the number of intervals (typically represents pixels).", "method": "get", "endpoint": "streamsets/plot", "responses": [ { "uuid": "8ec78b8d-4dd6-4b46-a4bd-d6ef3a9b39fa", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Plot values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5a74252b-5cf5-46a4-bf30-9faf20b1752e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "ae6f2b82-a241-43fe-8f3f-52876501e52a", "documentation": "Returns recorded values of the specified streams.", "method": "get", "endpoint": "streamsets/recorded", "responses": [ { "uuid": "60483d2f-97d3-428e-94b3-db7d7aca2b74", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Recorded values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "984022c5-77a7-4cb4-9bea-4b50ae973502", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1292cebe-69d7-4321-b2cb-547ab0ad16eb", "documentation": "Updates multiple values for the specified streams.", "method": "post", "endpoint": "streamsets/recorded", "responses": [ { "uuid": "2c346381-daca-4e52-94a9-bee4502648a4", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "All updates executed successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d75ade4f-2a40-47f7-bdac-0e61943ca100", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "The operation was a partial success. The response body contains substatuses and errors in the same order as the supplied values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "44670266-ad10-41b1-a603-6c91807c8f1b", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a0dc2c27-abb4-4b52-80a9-c935e28f871d", "documentation": "Returns recorded values based on the passed time and retrieval mode.", "method": "get", "endpoint": "streamsets/recordedattime", "responses": [ { "uuid": "66d69b5a-d40e-4d59-ba7d-a6bc57db06b9", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Recorded values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6168c9c0-f67d-48a5-88a7-cde002f965ed", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d0c981ba-32cc-4ac5-890e-ac601d27e418", "documentation": "Returns recorded values of the specified streams at the specified times.", "method": "get", "endpoint": "streamsets/recordedattimes", "responses": [ { "uuid": "9956021b-9920-471f-9ea0-000cc098b6af", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Recorded values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "0fd41bce-81b5-4581-939a-ac1e93c61e53", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1bbc266f-5e46-492c-8971-3cbf015977da", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "The request was cancelled.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "38de3d37-e6df-4789-9192-d964a571d0da", "documentation": "Returns summary values of the specified streams.", "method": "get", "endpoint": "streamsets/summary", "responses": [ { "uuid": "913c8d37-3d3c-42aa-b2fd-dc26d5858426", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Type\": \"Total\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Summary values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "5fb5931d-30f2-4401-9c23-69632d5cbce0", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "161fd6c3-3005-4693-a547-e0f2746c5177", "documentation": "Receive stream updates", "method": "get", "endpoint": "streamsets/updates", "responses": [ { "uuid": "c446851b-abd8-48c4-834f-bc0f588a7487", "body": "{\n \"Items\": [\n {\n \"Events\": [\n {\n \"Action\": \"Add\",\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"PreviousEventAction\": \"PreviousEventArchived\",\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"LatestMarker\": \"0cbbec466f3a42288c8c47112f54b852_12\",\n \"RequestedMarker\": \"0cbbec466f3a42288c8c47112f54b852_0\",\n \"Source\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\",\n \"SourceName\": \"Water\",\n \"SourcePath\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Status\": \"Created\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The stream updates have been successfully retrieved", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6797d37d-42a2-40e3-ac56-7e9128f644eb", "documentation": "Register for stream updates", "method": "post", "endpoint": "streamsets/updates", "responses": [ { "uuid": "8f07f70f-0815-4990-9018-c6c008a39f69", "body": "{\n \"Items\": [\n {\n \"Exception\": {\n \"Errors\": [\n \"An error has occurred.\"\n ]\n },\n \"LatestMarker\": \"0cbbec466f3a42288c8c47112f54b852_12\",\n \"Source\": \"I1AbEDqD5loBNH0erqeqJodtALA9iLxz4m_5RGAxgAVXYUACw_yrS377vX0uZVHTgkanusw\",\n \"SourceName\": \"Water\",\n \"SourcePath\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Status\": \"Succeeded\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Successful Registration", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "21762bfd-553d-4d03-afa8-86f3469e3e77", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "Any webID supplied is invalid", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "10ee804a-6236-4b3b-a5b9-5ae36296b680", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Any webID supplied is a static attribute", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a3df5652-e576-4b25-8b4a-3ca6789bf36f", "documentation": "Returns values of the specified streams.", "method": "get", "endpoint": "streamsets/value", "responses": [ { "uuid": "7d6af065-c68e-4e8a-9dde-0c8d950d9219", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Summary values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "6b6782d6-9e2f-4ebf-ad7d-de3ae19795f8", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a2890fe9-c749-4cfe-9e54-7ed58754e98b", "documentation": "Updates a single value for the specified streams.", "method": "post", "endpoint": "streamsets/value", "responses": [ { "uuid": "f310d3e8-86e6-4e19-b0e0-68fda47282ef", "body": "{\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "All updates executed successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "27edfdc7-4c76-49fd-a8df-0858d74ced5c", "body": "{\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "The operation was a partial success. The response body contains substatuses and errors in the same order as the supplied values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "1c6327a0-1d3e-4960-bf3c-c4f6d8e44b2d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "cd9e7679-9504-4ecb-9a73-cf6fb7401b14", "documentation": "Opens a channel that will send messages about any value changes for the attributes of an Element, Event Frame, or Attribute.", "method": "get", "endpoint": "streamsets/:webId/channel", "responses": [ { "uuid": "9ac09da7-f277-4e5b-8985-bf7b11462fc5", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 101, "label": "Switches to the Web Socket protocol.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "834b6014-7da1-4dac-bb2f-61a64b914b4c", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "bbaa68b2-6aca-409b-820b-3581f182b92f", "documentation": "Returns End of stream values of the attributes for an Element, Event Frame or Attribute", "method": "get", "endpoint": "streamsets/:webId/end", "responses": [ { "uuid": "21a18fa6-a00a-470d-b428-794cbf49fd8d", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Summary values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "b128190d-9861-4182-aa8e-da4f4ad24ed3", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "9d36faf7-261f-4418-84f8-60d8993b66d8", "documentation": "Returns interpolated values of attributes for an element, event frame or attribute over the specified time range at the specified sampling interval.", "method": "get", "endpoint": "streamsets/:webId/interpolated", "responses": [ { "uuid": "68e2de62-7dfd-4000-940d-6ad748d4c600", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Interpolated values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f50262d9-12e9-4dd0-a25f-4eb19dd6ac0b", "documentation": "Returns interpolated values of attributes for an element, event frame or attribute at the specified times.", "method": "get", "endpoint": "streamsets/:webId/interpolatedattimes", "responses": [ { "uuid": "2d16ead3-a236-4e8b-af50-5061ce317775", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Interpolated values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "39a53f9a-d88d-47c3-b0ef-0343b83e9dda", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "6cb9522d-d980-4511-a840-f7ae92ce64ae", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "The request was cancelled.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "58fad1da-bb68-403b-8bee-f8e7448874f8", "documentation": "Returns values of attributes for an element, event frame or attribute over the specified time range suitable for plotting over the number of intervals (typically represents pixels).", "method": "get", "endpoint": "streamsets/:webId/plot", "responses": [ { "uuid": "2f0601f6-fcf4-4b37-a244-e51925b53d80", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Plot values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "d52b4c44-d559-45df-8190-c1043f6741f9", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "16404aec-157c-446b-be72-22802d46098c", "documentation": "Returns recorded values of the attributes for an element, event frame, or attribute.", "method": "get", "endpoint": "streamsets/:webId/recorded", "responses": [ { "uuid": "f31c3d63-3634-486d-807a-abce9d4f4d82", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Recorded values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "982f9f4d-9544-428d-b01b-e4e104d7d6fc", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "1c5fa4a3-aaa5-4984-96cb-0d634f27a531", "documentation": "Updates multiple values for the specified streams.", "method": "post", "endpoint": "streamsets/:webId/recorded", "responses": [ { "uuid": "73d779a3-551c-4133-ac31-ef97d5efe7d5", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "All updates executed successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c2de9a3d-d3a9-420f-ba66-e92ad3eeb4fa", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "The operation was a partial success. The response body contains substatuses and errors in the same order as the supplied values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "852dad40-afd4-430c-87f0-c81d43e1bf0d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "3d019a21-0051-4b91-a882-f2b196a957b5", "documentation": "Returns recorded values of the attributes for an element, event frame, or attribute.", "method": "get", "endpoint": "streamsets/:webId/recordedattime", "responses": [ { "uuid": "bbb3210a-0109-4fc7-bacd-60d434af6da2", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Recorded values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c7ec9864-c270-4468-a5c1-77cddd9043dd", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "d0205fea-c0ae-45d9-b44b-92fbeb473c23", "documentation": "Returns recorded values of attributes for an element, event frame or attribute at the specified times.", "method": "get", "endpoint": "streamsets/:webId/recordedattimes", "responses": [ { "uuid": "885cec9c-d6bf-46cc-9af2-59869fc17e26", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"UnitsAbbreviation\": \"m\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Recorded values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8ed91e9d-9822-4619-a34a-222abcdb3d6d", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "The request was malformed.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "60787b60-548e-486b-a985-60c7a274cb00", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "The request was cancelled.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "0323e7b5-c4e2-4ac4-8329-f5d4506c88ed", "documentation": "Returns summary values of the attributes for an element, event frame or attribute.", "method": "get", "endpoint": "streamsets/:webId/summary", "responses": [ { "uuid": "7ba339b7-78fe-4955-a7a6-de1e9fb4dfab", "body": "{\n \"Items\": [\n {\n \"Items\": [\n {\n \"Type\": \"Total\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Summary values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "eddeb581-d0d0-4abf-9856-e386ba811ff0", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "72dcd654-fea2-4be5-9b99-7a7879b9409a", "documentation": "Returns values of the attributes for an Element, Event Frame or Attribute at the specified time.", "method": "get", "endpoint": "streamsets/:webId/value", "responses": [ { "uuid": "16de7e7d-627c-4f5c-8b71-2892593c45dc", "body": "{\n \"Items\": [\n {\n \"Links\": {\n \"Source\": \"\"\n },\n \"Name\": \"Water\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement|Water\",\n \"Value\": {\n \"Annotated\": {{faker 'datatype.boolean'}},\n \"Errors\": [\n {\n \"FieldName\": \"Value\",\n \"Message\": [\n \"An error has occurred.\"\n ]\n }\n ],\n \"Good\": true,\n \"Questionable\": {{faker 'datatype.boolean'}},\n \"Substituted\": {{faker 'datatype.boolean'}},\n \"Timestamp\": \"2014-07-22T14:00:00Z\",\n \"UnitsAbbreviation\": \"m\",\n \"Value\": 12.3,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n },\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1AbEDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBAGyPedZG1sUmxOOclp3Flwg\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Summary values of the streams that meet the specified conditions.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "77735503-711f-4cd6-9e90-4da441017d83", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "cf93a799-0345-4a3e-8138-782a63dee479", "documentation": "Updates a single value for the specified streams.", "method": "post", "endpoint": "streamsets/:webId/value", "responses": [ { "uuid": "fc9106c3-ea8c-4836-bfbc-7f9b445d4043", "body": "{\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "All updates executed successfully.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "71805473-0c10-447d-a046-5a81611d6c69", "body": "{\n \"Items\": [\n {\n \"Message\": \"\",\n \"Substatus\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 207, "label": "The operation was a partial success. The response body contains substatuses and errors in the same order as the supplied values.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3719bb97-2a45-4625-be54-c38a38837d7e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported operation on the given AF object.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "b5200684-6673-4b63-b100-62c66c279389", "documentation": "Get system links for this PI System Web API instance.", "method": "get", "endpoint": "system", "responses": [ { "uuid": "1f73d401-f69e-461a-80aa-4b1c74aca81b", "body": "{\n \"Links\": {\n \"CacheInstances\": \"\",\n \"Configuration\": \"\",\n \"Self\": \"\",\n \"Status\": \"\",\n \"UserInfo\": \"\",\n \"Versions\": \"\"\n },\n \"ProductTitle\": \"PI Web API 2016 R2\",\n \"ProductVersion\": \"1.8.0.201\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Links to top level collections and system information.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "de9f0f42-5e2d-4131-be39-bb8fe42dd416", "documentation": "Get AF cache instances currently in use by the system. These are caches from which user requests are serviced. The number of instances depends on the number of users connected to the service, the service's authentication method, and the cache instance configuration.", "method": "get", "endpoint": "system/cacheinstances", "responses": [ { "uuid": "d0b2e627-794e-4767-a3fb-432adf288964", "body": "{\n \"Items\": [\n {\n \"Id\": \"8a5033c9-b77f-431c-9820-c9f538d80dc6\",\n \"LastRefreshTime\": \"2014-07-20T14:08:00Z\",\n \"ScheduledExpirationTime\": \"2014-07-20T23:08:00Z\",\n \"User\": \"MyDomain\\\\Username\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WillRefreshAfter\": \"2014-07-20T18:08:00Z\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Cache instance information.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "da28e7cf-0f30-4e4d-aef5-dc0b019ee1f3", "documentation": "Get the current system configuration.", "method": "get", "endpoint": "system/configuration", "responses": [ { "uuid": "6d9fecbe-5d54-47be-8020-2db9422bfe18", "body": "{}", "latency": 0, "statusCode": 200, "label": "The current system configuration.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0783d853-35d8-4300-9529-cf799c65a0c3", "documentation": "Delete a configuration item.", "method": "delete", "endpoint": "system/configuration/:key", "responses": [ { "uuid": "66525258-1441-4a40-9461-4ba88e9de875", "body": "", "latency": 0, "statusCode": 202, "label": "The change has been accepted, and will take effect when the service can cleanly restart.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "c8eb71a6-3d72-4e15-ba17-36fb87a61280", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The configuration item does not exist.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "409b0037-fce9-4f9e-9385-78150f4902ee", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 500, "label": "An internal error is preventing deletion of the configuration item.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "a600ec38-ba12-42ca-b8b4-15cb59f2f5d2", "documentation": "Get the value of a configuration item.", "method": "get", "endpoint": "system/configuration/:key", "responses": [ { "uuid": "99ac866f-3574-4358-8e58-2d1c1415f476", "body": "{}", "latency": 0, "statusCode": 200, "label": "The value of the configuration item.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "987cb690-4437-4021-b103-78052433344b", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The configuration item does not exist.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "387a7ffb-2e0f-4079-8754-1ed5f4880b27", "documentation": "Get information about this PI Web API instance. Examples of information returned include the system uptime, the number of cache instances for this PI System Web API instance, and the system run state.", "method": "get", "endpoint": "system/status", "responses": [ { "uuid": "22d1858a-dddf-4694-9af6-f660fe575909", "body": "{\n \"CacheInstances\": {{faker 'datatype.number'}},\n \"ServerTime\": \"2014-07-22T14:00:00Z\",\n \"State\": \"Running\",\n \"UpTimeInMinutes\": 32345.6,\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "System Status.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e5d95c5a-f08c-4d78-a70f-39a8bec44e10", "documentation": "Get information about the Windows identity used to fulfill the request. This depends on the service's authentication method and the credentials passed by the client. The impersonation level of the Windows identity is included.", "method": "get", "endpoint": "system/userinfo", "responses": [ { "uuid": "cb1dd65e-22e0-48d7-b764-8972748d2bd0", "body": "{\n \"IdentityType\": \"WindowsIdentity\",\n \"ImpersonationLevel\": \"None\",\n \"IsAuthenticated\": true,\n \"Name\": \"MyDomain\\\\Username\",\n \"SID\": \"S-1-5-21-2083424470-1893017325-1469799231-71366\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Information about the current user.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "9f9a6d3c-8e3f-4128-972e-b792000f2dd2", "body": "{\n \"IdentityType\": \"WindowsIdentity\",\n \"ImpersonationLevel\": \"None\",\n \"IsAuthenticated\": true,\n \"Name\": \"MyDomain\\\\Username\",\n \"SID\": \"S-1-5-21-2083424470-1893017325-1469799231-71366\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 204, "label": "No identity is present.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "15a65466-b882-4ced-857a-e88bbe1095db", "documentation": "Get the current versions of the PI Web API instance and all external plugins.", "method": "get", "endpoint": "system/versions", "responses": [ { "uuid": "50794aeb-602e-4d56-8cf3-54ef9a809dae", "body": "{}", "latency": 0, "statusCode": 200, "label": "A dictionary of assembly name-version information pairs.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2f065750-e70e-46f8-8f82-d3a06e15a094", "documentation": "Retrieve a table category by path.", "method": "get", "endpoint": "tablecategories", "responses": [ { "uuid": "6191d33f-b6b2-4e02-b382-5b136d36f39c", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"89c70cc2-5221-4e77-873f-894a3ea61e7d\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesTable[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified table category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "eb5bfecf-1086-47a2-9419-4df388590f91", "documentation": "Delete a table category.", "method": "delete", "endpoint": "tablecategories/:webId", "responses": [ { "uuid": "fc8ff0e2-d640-4a6e-8a56-90540464bec7", "body": "", "latency": 0, "statusCode": 204, "label": "The table category was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "0e18bf2e-8a16-4b7b-a078-50497c05acf2", "documentation": "Retrieve a table category.", "method": "get", "endpoint": "tablecategories/:webId", "responses": [ { "uuid": "572cf66f-e6ad-423e-a842-26d0f8c0def9", "body": "{\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"89c70cc2-5221-4e77-873f-894a3ea61e7d\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesTable[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified table category.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "8c0472c9-cc00-4ea7-8225-9aae08b9e422", "documentation": "Update a table category by replacing items in its definition.", "method": "patch", "endpoint": "tablecategories/:webId", "responses": [ { "uuid": "205f2fc3-d911-4719-8ab1-5c53fbd60ed4", "body": "", "latency": 0, "statusCode": 204, "label": "The table category was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6413e258-48f6-43ad-8fc1-2adef5b3f04f", "documentation": "Get the security information of the specified security item associated with the table category for a specified user.", "method": "get", "endpoint": "tablecategories/:webId/security", "responses": [ { "uuid": "442e9d66-5688-4852-8f24-6a442b0aae19", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "a129e7c7-8961-4cd2-a87d-7c54e1417bc1", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "cc6390c8-bf47-4e8d-89c8-af245d0618af", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "3bc8dca3-4bb6-45a6-af28-c395c85654e8", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "68a492f9-038d-4201-8907-b0526521fd9e", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "aa8951e2-a69f-4cd0-b565-a0313ec4c038", "documentation": "Retrieve the security entries associated with the table category based on the specified criteria. By default, all security entries for this table category are returned.", "method": "get", "endpoint": "tablecategories/:webId/securityentries", "responses": [ { "uuid": "9d7d7902-b1c8-411c-a072-1eb781846d9c", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6d09fe07-bdb5-4ab9-abba-514a3a64ba67", "documentation": "Create a security entry owned by the table category.", "method": "post", "endpoint": "tablecategories/:webId/securityentries", "responses": [ { "uuid": "d79b3105-e7ea-4283-a2b0-81d949c1c720", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "7f5b1a5f-3eca-4247-a124-2982c0ebbf6e", "documentation": "Delete a security entry owned by the table category.", "method": "delete", "endpoint": "tablecategories/:webId/securityentries/:name", "responses": [ { "uuid": "d7f7db26-a5c0-414c-9ed8-a35885ba50d6", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "bca8c5e5-1aef-4a91-bb02-5eb7423064e2", "documentation": "Retrieve the security entry associated with the table category with the specified name.", "method": "get", "endpoint": "tablecategories/:webId/securityentries/:name", "responses": [ { "uuid": "979836f1-eebb-4e23-81f0-04b58cf5139b", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "96dc42d1-0b5a-403e-86bc-a2ba84400b71", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "4f60a495-5495-4f00-9c28-fb6d352c5701", "documentation": "Update a security entry owned by the table category.", "method": "put", "endpoint": "tablecategories/:webId/securityentries/:name", "responses": [ { "uuid": "13bb25dc-d75f-40f1-aa6b-476d6b22aa02", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "2d38848e-7386-49ef-a421-fa3574cc8879", "documentation": "Retrieve a table by path.", "method": "get", "endpoint": "tables", "responses": [ { "uuid": "e5291387-9fa0-4e16-ad79-1b4dd6176d08", "body": "{\n \"CategoryNames\": [\n \"Table Category\"\n ],\n \"ConvertToLocalTime\": \"false\",\n \"Description\": \"Table of car info.\",\n \"Id\": \"5ff8ba98-89ce-479a-b29e-ddd057096a5f\",\n \"Links\": {\n \"Categories\": \"\",\n \"Data\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CarInfo\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\Tables[CarInfo]\",\n \"TimeZone\": \"Eastern Standard Time\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1BlDqD5loBNH0erqeqJodtALAmLr4X86Jmkeynt3QVwlqXw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified table.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "dfe7ce35-094d-4737-a956-73022bc5c48a", "documentation": "Delete a table.", "method": "delete", "endpoint": "tables/:webId", "responses": [ { "uuid": "c77a41f7-6ad0-4076-bd01-952b7ef16d67", "body": "", "latency": 0, "statusCode": 204, "label": "The table was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "d1f8ac7b-51d9-4c0a-988a-3a356203799b", "documentation": "Retrieve a table.", "method": "get", "endpoint": "tables/:webId", "responses": [ { "uuid": "90518d03-2797-4e57-9f0b-66fdb43311be", "body": "{\n \"CategoryNames\": [\n \"Table Category\"\n ],\n \"ConvertToLocalTime\": \"false\",\n \"Description\": \"Table of car info.\",\n \"Id\": \"5ff8ba98-89ce-479a-b29e-ddd057096a5f\",\n \"Links\": {\n \"Categories\": \"\",\n \"Data\": \"\",\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CarInfo\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\Tables[CarInfo]\",\n \"TimeZone\": \"Eastern Standard Time\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1BlDqD5loBNH0erqeqJodtALAmLr4X86Jmkeynt3QVwlqXw\"\n}", "latency": 0, "statusCode": 200, "label": "The specified table.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "6b923adf-70e1-4670-82d2-6d27319e50d8", "documentation": "Update a table by replacing items in its definition.", "method": "patch", "endpoint": "tables/:webId", "responses": [ { "uuid": "dd941a4a-9c2a-4f6a-88e4-fe7b8d951157", "body": "", "latency": 0, "statusCode": 204, "label": "The table was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "80ece2a0-1250-436a-a348-d6dffbcb4d48", "documentation": "Get a table's categories.", "method": "get", "endpoint": "tables/:webId/categories", "responses": [ { "uuid": "723a7fd6-d76e-42a5-b76d-4823131f6e9d", "body": "{\n \"Items\": [\n {\n \"Description\": \"Relative energy use per ton of process feed.\",\n \"Id\": \"89c70cc2-5221-4e77-873f-894a3ea61e7d\",\n \"Links\": {\n \"Database\": \"\",\n \"Security\": \"\",\n \"SecurityEntries\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"CategoryName\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\Database\\\\CategoriesTable[CategoryName]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1BCDqD5loBNH0erqeqJodtALAwgzHiSFSd06HP4lKPqYefQ\"\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of categories.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a996b8cd-610e-4f1a-9d4c-8260f69bd2cf", "documentation": "Get the table's data.", "method": "get", "endpoint": "tables/:webId/data", "responses": [ { "uuid": "0fc79fb4-65ff-4dd0-8ae7-2d878e4077c4", "body": "{\n \"Columns\": {},\n \"Rows\": [\n {}\n ],\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The data for the specified table.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "24dbd966-9662-42b5-bb3c-3370bcebd004", "documentation": "Update the table's data.", "method": "put", "endpoint": "tables/:webId/data", "responses": [ { "uuid": "b3172ac2-b4ca-4dd2-895e-746bab7ffd31", "body": "", "latency": 0, "statusCode": 201, "label": "The table data was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "e65eb4b9-c41c-4c82-848b-e2dd96ae8193", "documentation": "Get the security information of the specified security item associated with the table for a specified user.", "method": "get", "endpoint": "tables/:webId/security", "responses": [ { "uuid": "7fc6199a-4478-4910-bf13-be8f929691c4", "body": "{\n \"Items\": [\n {\n \"CanAnnotate\": true,\n \"CanDelete\": true,\n \"CanExecute\": true,\n \"CanRead\": true,\n \"CanReadData\": true,\n \"CanSubscribe\": true,\n \"CanSubscribeOthers\": true,\n \"CanWrite\": true,\n \"CanWriteData\": true,\n \"HasAdmin\": true,\n \"Links\": {\n \"Owner\": \"\",\n \"Self\": \"\"\n },\n \"OwnerWebId\": \"I1EmDqD5loBNH0erqeqJodtALAYIKyyz2F5BGAxQAVXYRDBA\",\n \"Rights\": [\n \"Read\",\n \"WriteData\"\n ],\n \"SecurityItem\": \"Default\",\n \"UserIdentity\": \"domain\\\\user\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "Security rights.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "8a20b2e9-3d0e-4f3c-8871-d09485c8bf90", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 400, "label": "An invalid or local account is specified as the user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "65d1e6a2-5641-4fa3-b0c3-2ee76089aa24", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 401, "label": "Access denied for the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "ff00802e-6768-4af8-ac02-c8354dff9452", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 409, "label": "Unsupported when using Anonymous authentication method.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false }, { "uuid": "f5efb4a5-4b1e-4285-b352-b19b22292375", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 502, "label": "Failed to retrieve the specified user identity.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "38927e16-c471-427b-8cbd-8cf359295240", "documentation": "Retrieve the security entries associated with the table based on the specified criteria. By default, all security entries for this table are returned.", "method": "get", "endpoint": "tables/:webId/securityentries", "responses": [ { "uuid": "d4dc281b-2148-4ac9-9b72-1cd765931c12", "body": "{\n \"Items\": [\n {\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n }\n ],\n \"Links\": {\n \"First\": \"\",\n \"Last\": \"\",\n \"Next\": \"\",\n \"Previous\": \"\"\n }\n}", "latency": 0, "statusCode": 200, "label": "A list of security entries matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5df37615-20c1-4147-8a09-4deda4232326", "documentation": "Create a security entry owned by the table.", "method": "post", "endpoint": "tables/:webId/securityentries", "responses": [ { "uuid": "d0aa4655-2315-46ce-b385-404977ce8dbf", "body": "", "latency": 0, "statusCode": 201, "label": "The security entry was created. The response's Location header is a link to the security entry.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "637d2215-47fd-437d-bff6-fc1ab6815461", "documentation": "Delete a security entry owned by the table.", "method": "delete", "endpoint": "tables/:webId/securityentries/:name", "responses": [ { "uuid": "500e1a52-e1e1-46b3-9b66-09ffde99feb6", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c8c8194e-dd5d-40e1-a85b-ec992524ad0f", "documentation": "Retrieve the security entry associated with the table with the specified name.", "method": "get", "endpoint": "tables/:webId/securityentries/:name", "responses": [ { "uuid": "45aa7ed0-3039-4a84-8174-685bc7310bf1", "body": "{\n \"AllowRights\": [\n \"Read\",\n \"ReadData\"\n ],\n \"DenyRights\": [\n \"Write\",\n \"Execute\",\n \"Admin\"\n ],\n \"Links\": {\n \"SecurableObject\": \"\",\n \"SecurityIdentity\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"domain\\\\user1\",\n \"SecurityIdentityName\": \"domain\\\\user1\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n }\n}", "latency": 0, "statusCode": 200, "label": "The security entry matching the specified condition.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true }, { "uuid": "ffe4ca10-a154-44e1-9c9e-3b53a7689fdc", "body": "{\n \"Errors\": [\n \"An error has occurred.\"\n ]\n}", "latency": 0, "statusCode": 404, "label": "The security entry with the specified name is not found.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false } ], "enabled": true, "responseMode": null }, { "uuid": "46e7ea7c-4d27-419c-9555-7751118cf363", "documentation": "Update a security entry owned by the table.", "method": "put", "endpoint": "tables/:webId/securityentries/:name", "responses": [ { "uuid": "43cf0d55-b963-4742-a560-5551aba0b408", "body": "", "latency": 0, "statusCode": 204, "label": "The security entry was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "849c3148-ed9d-4aa0-b59d-d970338c120f", "documentation": "Retrieve a Time Rule Plug-in by path.", "method": "get", "endpoint": "timeruleplugins", "responses": [ { "uuid": "305068b2-0646-41c5-962d-8c00df120729", "body": "{\n \"AssemblyFileName\": \"OSIsoft.AF.Time.TimeRule.Periodic.dll\",\n \"AssemblyID\": \"7a635b27-3c3c-4a5f-bba9-01f06e9e525b\",\n \"AssemblyLoadProperties\": [\n \"None\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Creates regular periodic time periods.\",\n \"Id\": \"d655f414-9655-4ad6-a615-182fa38200c1\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"Periodic\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsTimeRule[Periodic]\",\n \"Version\": \"2.8.5.7552\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1TPDqD5loBNH0erqeqJodtALAFPRV1lWW1kqmFRgvo4IAwQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified Time Rule Plug-in.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ffa419ed-cf72-4144-9e5f-9fbad30da352", "documentation": "Retrieve a Time Rule Plug-in.", "method": "get", "endpoint": "timeruleplugins/:webId", "responses": [ { "uuid": "4fa72738-15fd-4868-a7bf-6b7d9fdda49a", "body": "{\n \"AssemblyFileName\": \"OSIsoft.AF.Time.TimeRule.Periodic.dll\",\n \"AssemblyID\": \"7a635b27-3c3c-4a5f-bba9-01f06e9e525b\",\n \"AssemblyLoadProperties\": [\n \"None\"\n ],\n \"AssemblyTime\": \"2016-05-25T14:01:07Z\",\n \"CompatibilityVersion\": 2,\n \"Description\": \"Creates regular periodic time periods.\",\n \"Id\": \"d655f414-9655-4ad6-a615-182fa38200c1\",\n \"IsBrowsable\": true,\n \"IsNonEditableConfig\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"AssetServer\": \"\",\n \"Self\": \"\"\n },\n \"LoadedAssemblyTime\": \"1970-01-01T00:00:00Z\",\n \"LoadedVersion\": \"\",\n \"Name\": \"Periodic\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\PlugInsTimeRule[Periodic]\",\n \"Version\": \"2.8.5.7552\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1TPDqD5loBNH0erqeqJodtALAFPRV1lWW1kqmFRgvo4IAwQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified Time Rule Plug-in.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "80522d9f-c23e-4a5b-83ab-54cfd82c91a6", "documentation": "Retrieve a Time Rule by path.", "method": "get", "endpoint": "timerules", "responses": [ { "uuid": "9a0a2cda-e3b1-41fa-a695-4d621bb0caab", "body": "{\n \"ConfigString\": \"Frequency=300\",\n \"ConfigStringStored\": \"\",\n \"Description\": \"Creates regular periodic time periods.\",\n \"DisplayString\": \"Frequency=300\",\n \"EditorType\": \"OSIsoft.AF.Time.TimeRule.PeriodicConfig\",\n \"Id\": \"1514eb44-94c5-11e7-8443-00155d84c200\",\n \"IsConfigured\": true,\n \"IsInitializing\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Analysis\": \"\",\n \"AnalysisTemplate\": \"\",\n \"PlugIn\": \"\",\n \"Self\": \"\"\n },\n \"MergeDuplicatedItems\": {{faker 'datatype.boolean'}},\n \"Name\": \"Periodic\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\\\\TimeRule\",\n \"PlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1TRXDqD5loBNH0erqeqJodtALAROsUFcWU5xGEQwAVXYTCAAROsUFcWU5xGEQwAVXYTCAA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested Time Rule.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f6e5ba92-bb41-4724-8dde-01049cc96a04", "documentation": "Delete a Time Rule.", "method": "delete", "endpoint": "timerules/:webId", "responses": [ { "uuid": "ef900cc9-ab95-46c6-b44c-c5d1b4ac553d", "body": "", "latency": 0, "statusCode": 204, "label": "The Time Rule was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "16b17f48-3a46-438d-934f-295ee4ba48d8", "documentation": "Retrieve a Time Rule.", "method": "get", "endpoint": "timerules/:webId", "responses": [ { "uuid": "85efe7cd-6221-40f6-93fb-d0c503524fc7", "body": "{\n \"ConfigString\": \"Frequency=300\",\n \"ConfigStringStored\": \"\",\n \"Description\": \"Creates regular periodic time periods.\",\n \"DisplayString\": \"Frequency=300\",\n \"EditorType\": \"OSIsoft.AF.Time.TimeRule.PeriodicConfig\",\n \"Id\": \"1514eb44-94c5-11e7-8443-00155d84c200\",\n \"IsConfigured\": true,\n \"IsInitializing\": {{faker 'datatype.boolean'}},\n \"Links\": {\n \"Analysis\": \"\",\n \"AnalysisTemplate\": \"\",\n \"PlugIn\": \"\",\n \"Self\": \"\"\n },\n \"MergeDuplicatedItems\": {{faker 'datatype.boolean'}},\n \"Name\": \"Periodic\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\MyDatabase\\\\MyElement\\\\Analyses[MyAnalysis]\\\\TimeRule\",\n \"PlugInName\": \"Periodic\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1TRXDqD5loBNH0erqeqJodtALAROsUFcWU5xGEQwAVXYTCAAROsUFcWU5xGEQwAVXYTCAA\"\n}", "latency": 0, "statusCode": 200, "label": "The requested Time Rule.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "a5cab33e-dd6f-4cc9-b237-0630b430a948", "documentation": "Update a Time Rule by replacing items in its definition.", "method": "patch", "endpoint": "timerules/:webId", "responses": [ { "uuid": "dc2ba8b1-c8f8-4fd5-9505-e3a3483aad12", "body": "", "latency": 0, "statusCode": 204, "label": "The Time Rule was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "c65990a8-ba4d-47ce-8013-7e08f9601415", "documentation": "Retrieve a unit class by path.", "method": "get", "endpoint": "unitclasses", "responses": [ { "uuid": "86b77d18-9427-42b9-8e4a-8bc2f5494df9", "body": "{\n \"CanonicalUnitAbbreviation\": \"W\",\n \"CanonicalUnitName\": \"watt\",\n \"Description\": \"Power Unit Class\",\n \"Id\": \"f925b94d-6efc-4b94-a50d-0015c391f249\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"CanonicalUnit\": \"\",\n \"Self\": \"\",\n \"Units\": \"\"\n },\n \"Name\": \"Power\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\UOMDatabase\\\\UOMClasses[Power]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1UCDqD5loBNH0erqeqJodtALATbkl-fxulEulDQAVw5HySQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified unit class.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b17c2977-d5d3-40bf-92d3-675152bf8dae", "documentation": "Delete a unit class.", "method": "delete", "endpoint": "unitclasses/:webId", "responses": [ { "uuid": "1baf5a03-e571-49d5-8023-2ffc323eb536", "body": "", "latency": 0, "statusCode": 204, "label": "The unit class was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "f1bd4ee9-09d8-4dca-a77a-d2aa8bec9fee", "documentation": "Retrieve a unit class.", "method": "get", "endpoint": "unitclasses/:webId", "responses": [ { "uuid": "8b2e512c-25cb-4137-85d2-dc3ef1a712d8", "body": "{\n \"CanonicalUnitAbbreviation\": \"W\",\n \"CanonicalUnitName\": \"watt\",\n \"Description\": \"Power Unit Class\",\n \"Id\": \"f925b94d-6efc-4b94-a50d-0015c391f249\",\n \"Links\": {\n \"AssetServer\": \"\",\n \"CanonicalUnit\": \"\",\n \"Self\": \"\",\n \"Units\": \"\"\n },\n \"Name\": \"Power\",\n \"Path\": \"\\\\\\\\MyAssetServer\\\\UOMDatabase\\\\UOMClasses[Power]\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1UCDqD5loBNH0erqeqJodtALATbkl-fxulEulDQAVw5HySQ\"\n}", "latency": 0, "statusCode": 200, "label": "The specified unit class.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5d70d339-1b2b-463b-8a32-0c7b10217726", "documentation": "Update a unit class.", "method": "patch", "endpoint": "unitclasses/:webId", "responses": [ { "uuid": "5115e037-c8c0-474c-b6b4-7910eb0da7fd", "body": "", "latency": 0, "statusCode": 204, "label": "The unit class was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5b65b6de-c989-4082-a795-29d0d435d56b", "documentation": "Get the canonical unit of a unit class.", "method": "get", "endpoint": "unitclasses/:webId/canonicalunit", "responses": [ { "uuid": "8ecc1713-52d6-4d3e-8f5b-696f76ef8d3d", "body": "{\n \"Abbreviation\": \"Hz\",\n \"Description\": \"Hertz Unit\",\n \"Factor\": 1,\n \"Id\": \"8121ac8e-3ce2-4794-95e3-1783d5d6f4fc\",\n \"Links\": {\n \"Class\": \"\",\n \"ReferenceUnit\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"Hertz\",\n \"Offset\": {{faker 'datatype.float'}},\n \"Path\": \"\\\\\\\\MyAssetServer\\\\UOMDatabase\\\\Hertz\",\n \"ReferenceFactor\": 1,\n \"ReferenceOffset\": {{faker 'datatype.float'}},\n \"ReferenceUnitAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1UtDqD5loBNH0erqeqJodtALAjqwhgeI8lEeV4xeD1db0_A\"\n}", "latency": 0, "statusCode": 200, "label": "the canonical unit of the specified unit class.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "428cfa74-0d73-4417-bda8-0441a23e49a5", "documentation": "Get a list of all units belonging to the unit class.", "method": "get", "endpoint": "unitclasses/:webId/units", "responses": [ { "uuid": "9a4b1e2d-7c7b-4778-9b7e-0237e1148720", "body": "{\n \"Abbreviation\": \"Hz\",\n \"Description\": \"Hertz Unit\",\n \"Factor\": 1,\n \"Id\": \"8121ac8e-3ce2-4794-95e3-1783d5d6f4fc\",\n \"Links\": {\n \"Class\": \"\",\n \"ReferenceUnit\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"Hertz\",\n \"Offset\": {{faker 'datatype.float'}},\n \"Path\": \"\\\\\\\\MyAssetServer\\\\UOMDatabase\\\\Hertz\",\n \"ReferenceFactor\": 1,\n \"ReferenceOffset\": {{faker 'datatype.float'}},\n \"ReferenceUnitAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1UtDqD5loBNH0erqeqJodtALAjqwhgeI8lEeV4xeD1db0_A\"\n}", "latency": 0, "statusCode": 200, "label": "The list of units in the unit class.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "b36d90aa-e210-4904-84c4-f4c13fea6e8a", "documentation": "Create a unit in the specified Unit Class.", "method": "post", "endpoint": "unitclasses/:webId/units", "responses": [ { "uuid": "b3b6abe8-3e8d-4b55-b791-5a8d9b1c25cc", "body": "", "latency": 0, "statusCode": 201, "label": "The unit was created. The response's Location header is a link to the unit.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "5fa7d64e-0cef-477c-bd71-16b412eeca46", "documentation": "Retrieve a unit by path.", "method": "get", "endpoint": "units", "responses": [ { "uuid": "39b451e6-e62b-49e0-80aa-b22aef91c22d", "body": "{\n \"Abbreviation\": \"Hz\",\n \"Description\": \"Hertz Unit\",\n \"Factor\": 1,\n \"Id\": \"8121ac8e-3ce2-4794-95e3-1783d5d6f4fc\",\n \"Links\": {\n \"Class\": \"\",\n \"ReferenceUnit\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"Hertz\",\n \"Offset\": {{faker 'datatype.float'}},\n \"Path\": \"\\\\\\\\MyAssetServer\\\\UOMDatabase\\\\Hertz\",\n \"ReferenceFactor\": 1,\n \"ReferenceOffset\": {{faker 'datatype.float'}},\n \"ReferenceUnitAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1UtDqD5loBNH0erqeqJodtALAjqwhgeI8lEeV4xeD1db0_A\"\n}", "latency": 0, "statusCode": 200, "label": "The specified unit.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "664c85b2-7eee-4204-a8ef-acc7acda790a", "documentation": "Delete a unit.", "method": "delete", "endpoint": "units/:webId", "responses": [ { "uuid": "a5b050ac-c06c-400a-b260-e759bdad24fa", "body": "", "latency": 0, "statusCode": 204, "label": "The unit was deleted.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "ae9daf7b-77e0-42fa-90d4-15ff441c2c27", "documentation": "Retrieve a unit.", "method": "get", "endpoint": "units/:webId", "responses": [ { "uuid": "7f743aef-5ff1-4c00-a262-5bdaf31a8a07", "body": "{\n \"Abbreviation\": \"Hz\",\n \"Description\": \"Hertz Unit\",\n \"Factor\": 1,\n \"Id\": \"8121ac8e-3ce2-4794-95e3-1783d5d6f4fc\",\n \"Links\": {\n \"Class\": \"\",\n \"ReferenceUnit\": \"\",\n \"Self\": \"\"\n },\n \"Name\": \"Hertz\",\n \"Offset\": {{faker 'datatype.float'}},\n \"Path\": \"\\\\\\\\MyAssetServer\\\\UOMDatabase\\\\Hertz\",\n \"ReferenceFactor\": 1,\n \"ReferenceOffset\": {{faker 'datatype.float'}},\n \"ReferenceUnitAbbreviation\": \"\",\n \"WebException\": {\n \"Errors\": [\n \"An error has occurred.\"\n ],\n \"StatusCode\": \"{{oneOf (array '100' '101' '200' '201' '202' '203' '204' '205' '206' '207' '300' '301' '302' '303' '304' '305' '306' '307' '400' '401' '402' '403' '404' '405' '406' '407' '408' '409' '410' '411' '412' '413' '414' '415' '416' '417' '426' '500' '501' '502' '503' '504' '505')}}\"\n },\n \"WebId\": \"I1UtDqD5loBNH0erqeqJodtALAjqwhgeI8lEeV4xeD1db0_A\"\n}", "latency": 0, "statusCode": 200, "label": "The specified unit.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null }, { "uuid": "73c62f3c-63b3-4fda-9129-2ab0467c32de", "documentation": "Update a unit.", "method": "patch", "endpoint": "units/:webId", "responses": [ { "uuid": "d53e2f10-bc5f-4784-a449-c2df0579bdb1", "body": "", "latency": 0, "statusCode": 204, "label": "The unit was updated.", "headers": [ { "key": "Content-Type", "value": "application/json" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true } ], "enabled": true, "responseMode": null } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [ { "key": "", "value": "" } ], "proxyResHeaders": [ { "key": "", "value": "" } ], "data": [] }