{
	"info": {
		"_postman_id": "c3c81aa8-0dba-4f27-a7c4-8963e13be218",
		"name": "OpenAV Orchestrator",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
		"_exporter_id": "32668379"
	},
	"item": [
		{
			"name": "Get System State",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/systems/{{system}}/state",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"systems",
						"{{system}}",
						"state"
					]
				},
				"description": "Will return the state of a system, which is the interpreted configuration of a system."
			},
			"response": []
		},
		{
			"name": "Clear System Cache",
			"request": {
				"method": "DELETE",
				"header": [],
				"url": {
					"raw": "{{url}}/api/systems/{{system}}/cache",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"systems",
						"{{system}}",
						"cache"
					]
				},
				"description": "Removes caches which are specific to a system. This does not clear cached DNS entries for that system."
			},
			"response": []
		},
		{
			"name": "Update System State",
			"request": {
				"method": "PUT",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "{\n    \"power\": {\n        \"value\": true\n    }\n}",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{url}}/api/systems/{{system}}/state",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"systems",
						"{{system}}",
						"state"
					]
				},
				"description": "Updates the state of a system. Send only the parts of the JSON data structure that needs to be updated."
			},
			"response": []
		},
		{
			"name": "Create Client Error",
			"request": {
				"method": "POST",
				"header": [],
				"body": {
					"mode": "raw",
					"raw": "\"This is a test error\"",
					"options": {
						"raw": {
							"language": "json"
						}
					}
				},
				"url": {
					"raw": "{{url}}/api/errors/client",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"errors",
						"client"
					]
				},
				"description": "Creates a specific error that is a client error. The Orchestrator gathers errors from multipled sources, and dispatches them to various places integrated with it. Sometime it's useful for a Client to leverage this central gathering point to make its own errors percolate through the same channels. For example, if a system control website is setup for users, and the browser's Javascript has an error, it can use this to report on it."
			},
			"response": []
		},
		{
			"name": "List Errors",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/errors",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"errors"
					],
					"query": [
						{
							"key": "system",
							"value": "test",
							"disabled": true
						},
						{
							"key": "channel",
							"value": "client",
							"disabled": true
						},
						{
							"key": "severity",
							"value": "3",
							"disabled": true
						},
						{
							"key": "code",
							"value": "WQ2r1U4gSX8A",
							"disabled": true
						}
					]
				},
				"description": "Returns a list of errors from the past 24 hours. Errors are obsoleted beyond that."
			},
			"response": []
		},
		{
			"name": "Clear Global Cache",
			"request": {
				"method": "DELETE",
				"header": [],
				"url": {
					"raw": "{{url}}/api/cache",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"cache"
					]
				},
				"description": "Remove any and all cached state, DNS, configurations, memory cache, et cetera. Useful when making changes to an evolving system configuration, to not have to wait before testing them."
			},
			"response": []
		},
		{
			"name": "Get Version",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "{{url}}/api/version",
					"host": [
						"{{url}}"
					],
					"path": [
						"api",
						"version"
					]
				},
				"description": "Returns the Orchestrator's version. It's set when instantiating the orchestrator's container, passed as the `VERSION` environment variable."
			},
			"response": []
		}
	]
}