Robocorp Cloud API - Postman Collection

Robocorp Cloud API.postman_collection.json

{
	"info": {
		"_postman_id": "ad3436c2-9c0d-4e27-97d3-8eeb26dcbc70",
		"name": "Robocorp Cloud API",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "Process API V1",
			"item": [
				{
					"name": "Start A Process",
					"request": {
						"method": "POST",
						"header": [
							{
								"key": "Accept",
								"value": "application/json",
								"type": "text"
							},
							{
								"key": "Content-Type",
								"value": "application/json",
								"type": "text"
							}
						],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs"
							]
						},
						"description": "Start a process in a workspace."
					},
					"response": []
				},
				{
					"name": "List Process Runs In A Workspace",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/pruns?state=COMPL&limit=3",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"pruns"
							],
							"query": [
								{
									"key": "state",
									"value": "COMPL"
								},
								{
									"key": "limit",
									"value": "3"
								}
							]
						}
					},
					"response": []
				},
				{
					"name": "Monitor Process Status",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs/{{process-run-id}}",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs",
								"{{process-run-id}}"
							]
						},
						"description": "After triggering the process via API you can monitor the process run status."
					},
					"response": []
				},
				{
					"name": "List Robot Runs",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs/{{process-run-id}}/robotRuns?limit=10",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs",
								"{{process-run-id}}",
								"robotRuns"
							],
							"query": [
								{
									"key": "limit",
									"value": "10"
								}
							]
						}
					},
					"response": []
				},
				{
					"name": "Get Robot Run",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs/{{process-run-id}}/robotRuns/{{robot-run-id}}",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs",
								"{{process-run-id}}",
								"robotRuns",
								"{{robot-run-id}}"
							]
						}
					},
					"response": []
				},
				{
					"name": "List Robot Run Events",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs/{{process-run-id}}/robotRuns/{{robot-run-id}}/events",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs",
								"{{process-run-id}}",
								"robotRuns",
								"{{robot-run-id}}",
								"events"
							]
						}
					},
					"response": []
				},
				{
					"name": "List Robot Run Console Messages",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs/{{process-run-id}}/robotRuns/{{robot-run-id}}/messages?limit=10",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs",
								"{{process-run-id}}",
								"robotRuns",
								"{{robot-run-id}}",
								"messages"
							],
							"query": [
								{
									"key": "limit",
									"value": "10"
								}
							]
						}
					},
					"response": []
				},
				{
					"name": "List Robot Run Artifacts",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs/{{process-run-id}}/robotRuns/{{robot-run-id}}/artifacts",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs",
								"{{process-run-id}}",
								"robotRuns",
								"{{robot-run-id}}",
								"artifacts"
							]
						}
					},
					"response": []
				},
				{
					"name": "Get A Robot Artifact",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-process-api}}/workspaces/{{workspace-id}}/processes/{{process-id}}/runs/{{process-run-id}}/robotRuns/{{robot-run-id}}/artifacts/{{artifact-id}}/{{filename}}",
							"host": [
								"{{url-process-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"processes",
								"{{process-id}}",
								"runs",
								"{{process-run-id}}",
								"robotRuns",
								"{{robot-run-id}}",
								"artifacts",
								"{{artifact-id}}",
								"{{filename}}"
							]
						}
					},
					"response": []
				}
			]
		},
		{
			"name": "Robot API V2",
			"item": [
				{
					"name": "Create A New Robot",
					"request": {
						"method": "POST",
						"header": [],
						"body": {
							"mode": "raw",
							"raw": "{\r\n  \"name\": \"name-of-the-new-robot\"\r\n}"
						},
						"url": {
							"raw": "{{url-robot-api}}/workspaces/{{workspace-id}}/robots",
							"host": [
								"{{url-robot-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"robots"
							]
						}
					},
					"response": []
				},
				{
					"name": "Get A Link To Upload A Robot",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-robot-api}}{{url-robot-api}}/workspaces/{{workspace-id}}/robots/{{robot-id}}/file/uploadLink",
							"host": [
								"{{url-robot-api}}{{url-robot-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"robots",
								"{{robot-id}}",
								"file",
								"uploadLink"
							]
						}
					},
					"response": []
				},
				{
					"name": "Get A Link To Download A Robot",
					"request": {
						"method": "GET",
						"header": [],
						"url": {
							"raw": "{{url-robot-api}}{{url-robot-api}}/workspaces/{{workspace-id}}/robots/{{robot-id}}/file/downloadLink",
							"host": [
								"{{url-robot-api}}{{url-robot-api}}"
							],
							"path": [
								"workspaces",
								"{{workspace-id}}",
								"robots",
								"{{robot-id}}",
								"file",
								"downloadLink"
							]
						}
					},
					"response": []
				}
			]
		}
	],
	"auth": {
		"type": "apikey",
		"apikey": [
			{
				"key": "value",
				"value": "RC-WSKEY {{api-key}}",
				"type": "string"
			},
			{
				"key": "key",
				"value": "Authorization",
				"type": "string"
			}
		]
	},
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	],
	"variable": [
		{
			"key": "url",
			"value": "https://api.eu1.robocorp.com/"
		},
		{
			"key": "url-process-api",
			"value": ""
		},
		{
			"key": "url-robot-api",
			"value": ""
		},
		{
			"key": "api-key",
			"value": ""
		},
		{
			"key": "workspace-id",
			"value": ""
		},
		{
			"key": "process-id",
			"value": ""
		},
		{
			"key": "process-run-id",
			"value": ""
		},
		{
			"key": "robot-run-id",
			"value": ""
		},
		{
			"key": "artifact-id",
			"value": ""
		},
		{
			"key": "filename",
			"value": ""
		},
		{
			"key": "robot-id",
			"value": ""
		}
	]
}