{ "info" : { "name" : "svc-sundial", "schema" : "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description" : { "content" : "A service for scheduling and running Docker-based jobs" }, "version" : "2.0.0-dev" }, "item" : [ { "name" : "healthchecks", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/metrics", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "metrics" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "name" : "GET /_internal_/metrics", "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - string", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/_internal_/metrics", "host" : [ "{{BASE_URL}}" ], "path" : [ "_internal_", "metrics" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "header" : [ ] }, "body" : "\"178ed150aea5\"", "code" : 200 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "processes", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes" ], "query" : [ { "key" : "process_definition_name", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "start_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "end_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "max_records", "disabled" : true, "description" : { "content" : "Type: integer | Required: false" } }, { "key" : "allowed_statuses", "disabled" : false, "description" : { "content" : "Type: [process_status] | Required: true" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Retrieves a list of process runs based on search parameters." }, "header" : [ ] }, "name" : "GET /api/processes/", "description" : { "content" : "Retrieves a list of process runs based on search parameters." }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [process]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes" ], "query" : [ { "key" : "process_definition_name", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } }, { "key" : "start_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "end_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "max_records", "disabled" : true, "description" : { "content" : "Type: integer | Required: false" } }, { "key" : "allowed_statuses", "disabled" : false, "description" : { "content" : "Type: [process_status] | Required: true" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Retrieves a list of process runs based on search parameters." }, "header" : [ ] }, "body" : "[ {\n \"start_time\" : \"2026-10-18T10:33:38.419Z\",\n \"task\" : [ {\n \"start_time\" : \"2026-10-18T10:33:38.419Z\",\n \"execution_state\" : [ {\n \"metadata_entry_id\" : \"be56f0a2-17e4-4f52-beed-405db732bb5b\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"2c4a628b36c0\",\n \"value\" : \"4cbc7cd1bbfc\"\n } ],\n \"process_id\" : \"cc37c54b-e665-4943-bd45-a54dbebab748\",\n \"process_definition_name\" : \"45c312c9e4fb\",\n \"task_definition_name\" : \"623f910c1cfb\",\n \"status\" : \"running\",\n \"metadata_entries\" : [ {\n \"metadata_entry_id\" : \"99523288-657c-4b95-81f6-91873c66c71a\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"d5a4a93ca0d3\",\n \"value\" : \"e8cfb0829c74\"\n } ],\n \"previous_attempt_count\" : 1,\n \"end_time\" : \"2026-10-18T10:33:38.419Z\",\n \"log_entries\" : [ {\n \"log_entry_id\" : \"57ce9516-6648-4604-bb44-61328b3f3b2e\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"source\" : \"f1e860004f3d\",\n \"message\" : \"e61c41d91455\"\n } ],\n \"task_id\" : \"23af7a76-f8ef-4d81-a63d-5d234d07e5fd\"\n } ],\n \"process_id\" : \"8d46296b-b78f-4c1e-bab1-8cb2b26b2cfe\",\n \"process_definition_name\" : \"4ffaf9b0882c\",\n \"status\" : \"failed\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/:process_id", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes", ":process_id" ], "query" : [ ], "variable" : [ { "key" : "process_id", "value" : "{{process_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieves a process run" }, "header" : [ ] }, "name" : "GET /api/processes/:process_id", "description" : { "content" : "Retrieves a process run" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - process", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/:process_id", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes", ":process_id" ], "query" : [ ], "variable" : [ { "key" : "process_id", "value" : "{{process_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Retrieves a process run" }, "header" : [ ] }, "body" : "{\n \"start_time\" : \"2026-10-18T10:33:38.419Z\",\n \"task\" : [ {\n \"start_time\" : \"2026-10-18T10:33:38.419Z\",\n \"execution_state\" : [ {\n \"metadata_entry_id\" : \"7494287f-dda3-4c08-b38c-e5aca1efa19a\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"e4ca6c312f78\",\n \"value\" : \"7a7a05953b1e\"\n } ],\n \"process_id\" : \"9820ab02-0c25-43b7-a96e-ac8d7a9ab3c3\",\n \"process_definition_name\" : \"aaa9ab2b7546\",\n \"task_definition_name\" : \"7f8aac8ba048\",\n \"status\" : \"succeeded\",\n \"metadata_entries\" : [ {\n \"metadata_entry_id\" : \"48258194-8dbc-447d-a0f1-faf553bdd9b6\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"7e3d89c059d9\",\n \"value\" : \"50f151ae852d\"\n } ],\n \"previous_attempt_count\" : 1,\n \"end_time\" : \"2026-10-18T10:33:38.419Z\",\n \"log_entries\" : [ {\n \"log_entry_id\" : \"bf9d476e-c609-4b03-9973-f1178fa97351\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"source\" : \"581ff78be72c\",\n \"message\" : \"d354d61d4ccb\"\n } ],\n \"task_id\" : \"48f77414-8dfc-454f-a150-281c46541d8e\"\n } ],\n \"process_id\" : \"99b31ca8-f794-4223-bc15-e27e63d43854\",\n \"process_definition_name\" : \"b490dfe4450f\",\n \"status\" : \"running\"\n}", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/:process_id/retry", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes", ":process_id", "retry" ], "query" : [ ], "variable" : [ { "key" : "process_id", "value" : "{{process_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Retries a failed process run by restarting failed tasks; tasks will be given a single additional attempt" }, "header" : [ ] }, "name" : "POST /api/processes/:process_id/retry", "description" : { "content" : "Retries a failed process run by restarting failed tasks; tasks will be given a single additional attempt" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/:process_id/retry", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes", ":process_id", "retry" ], "query" : [ ], "variable" : [ { "key" : "process_id", "value" : "{{process_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Retries a failed process run by restarting failed tasks; tasks will be given a single additional attempt" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/:process_id/kill", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes", ":process_id", "kill" ], "query" : [ ], "variable" : [ { "key" : "process_id", "value" : "{{process_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Terminates an active process" }, "header" : [ ] }, "name" : "POST /api/processes/:process_id/kill", "description" : { "content" : "Terminates an active process" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/processes/:process_id/kill", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "processes", ":process_id", "kill" ], "query" : [ ], "variable" : [ { "key" : "process_id", "value" : "{{process_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Terminates an active process" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "process_definitions", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Get all currently registered process definitions" }, "header" : [ ] }, "name" : "GET /api/process_definitions/", "description" : { "content" : "Get all currently registered process definitions" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [process_definition]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions" ], "query" : [ ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Get all currently registered process definitions" }, "header" : [ ] }, "body" : "[ {\n \"task_definitions\" : [ {\n \"backoff_base_seconds\" : 1,\n \"task_definition_name\" : \"13fd58f99b06\",\n \"backoff_exponent\" : 1,\n \"require_explicit_success\" : true,\n \"max_attempts\" : 1,\n \"max_runtime_seconds\" : 1,\n \"dependencies\" : [ {\n \"task_definition_name\" : \"bcbe35f9f565\",\n \"success_required\" : true\n } ],\n \"executable\" : {\n \"shell_script_command\" : {\n \"script\" : \"520e66242f6e\",\n \"environment_variables\" : [ {\n \"variable_name\" : \"04c46c1eb972\",\n \"value\" : \"d37a52f6c0ff\"\n } ]\n }\n }\n } ],\n \"paused\" : true,\n \"schedule\" : {\n \"cron_schedule\" : {\n \"day_of_week\" : \"e7bcabafeca5\",\n \"minutes\" : \"a1bb25fd2f99\",\n \"hours\" : \"2ad49659376d\",\n \"day_of_month\" : \"acfe1e02a45b\",\n \"month\" : \"7231b20972df\"\n }\n },\n \"overlap_action\" : \"wait\",\n \"notifications\" : [ {\n \"email\" : {\n \"name\" : \"4cfbed25fc9f\",\n \"email\" : \"262b36df2741\",\n \"notify_when\" : \"on_state_change_and_failures\"\n }\n } ],\n \"process_definition_name\" : \"5cc22e2c7260\",\n \"process_description\" : \"1f42dab04c48\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Get a registered process definition" }, "header" : [ ] }, "name" : "GET /api/process_definitions/:process_definition_name", "description" : { "content" : "Get a registered process definition" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - process_definition", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "GET", "description" : { "content" : "Get a registered process definition" }, "header" : [ ] }, "body" : "{\n \"task_definitions\" : [ {\n \"backoff_base_seconds\" : 1,\n \"task_definition_name\" : \"6eedaed97088\",\n \"backoff_exponent\" : 1,\n \"require_explicit_success\" : true,\n \"max_attempts\" : 1,\n \"max_runtime_seconds\" : 1,\n \"dependencies\" : [ {\n \"task_definition_name\" : \"b6b9541b5104\",\n \"success_required\" : true\n } ],\n \"executable\" : {\n \"shell_script_command\" : {\n \"script\" : \"7c32a09d5c0d\",\n \"environment_variables\" : [ {\n \"variable_name\" : \"1d1210637f78\",\n \"value\" : \"1d14c23b689b\"\n } ]\n }\n }\n } ],\n \"paused\" : true,\n \"schedule\" : {\n \"cron_schedule\" : {\n \"day_of_week\" : \"436398bd7493\",\n \"minutes\" : \"422632f7deca\",\n \"hours\" : \"675a973b1476\",\n \"day_of_month\" : \"74e6fc453f2f\",\n \"month\" : \"5169f4a66bb7\"\n }\n },\n \"overlap_action\" : \"wait\",\n \"notifications\" : [ {\n \"email\" : {\n \"name\" : \"db4a28489753\",\n \"email\" : \"b96110b5f881\",\n \"notify_when\" : \"on_state_change_and_failures\"\n }\n } ],\n \"process_definition_name\" : \"6a0a70f38214\",\n \"process_description\" : \"ce96885f08e4\"\n}", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates or creates a process definition" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"task_definitions\" : [ {\n \"backoff_base_seconds\" : 1,\n \"task_definition_name\" : \"103bd728ac35\",\n \"backoff_exponent\" : 1,\n \"require_explicit_success\" : true,\n \"max_attempts\" : 1,\n \"max_runtime_seconds\" : 1,\n \"dependencies\" : [ {\n \"task_definition_name\" : \"d3622e5fb52d\",\n \"success_required\" : true\n } ],\n \"executable\" : {\n \"shell_script_command\" : {\n \"script\" : \"22aa6c1ae6f0\",\n \"environment_variables\" : [ {\n \"variable_name\" : \"b98186c3c2bc\",\n \"value\" : \"bb55f01c9455\"\n } ]\n }\n }\n } ],\n \"paused\" : true,\n \"schedule\" : {\n \"cron_schedule\" : {\n \"day_of_week\" : \"f65dc671a793\",\n \"minutes\" : \"3a2c2e309fb2\",\n \"hours\" : \"854a29390c95\",\n \"day_of_month\" : \"c718ee12bf11\",\n \"month\" : \"038f61e0aa4b\"\n }\n },\n \"overlap_action\" : \"wait\",\n \"notifications\" : [ {\n \"email\" : {\n \"name\" : \"cf700e335e58\",\n \"email\" : \"4e93b84c91de\",\n \"notify_when\" : \"on_state_change_and_failures\"\n }\n } ],\n \"process_definition_name\" : \"769fb4b8dd8b\",\n \"process_description\" : \"7872fd63a546\"\n}", "mode" : "raw" } }, "name" : "PUT /api/process_definitions/:process_definition_name", "description" : { "content" : "Updates or creates a process definition" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"PUT requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - process_definition", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "PUT", "description" : { "content" : "Updates or creates a process definition" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "{\n \"task_definitions\" : [ {\n \"backoff_base_seconds\" : 1,\n \"task_definition_name\" : \"103bd728ac35\",\n \"backoff_exponent\" : 1,\n \"require_explicit_success\" : true,\n \"max_attempts\" : 1,\n \"max_runtime_seconds\" : 1,\n \"dependencies\" : [ {\n \"task_definition_name\" : \"d3622e5fb52d\",\n \"success_required\" : true\n } ],\n \"executable\" : {\n \"shell_script_command\" : {\n \"script\" : \"22aa6c1ae6f0\",\n \"environment_variables\" : [ {\n \"variable_name\" : \"b98186c3c2bc\",\n \"value\" : \"bb55f01c9455\"\n } ]\n }\n }\n } ],\n \"paused\" : true,\n \"schedule\" : {\n \"cron_schedule\" : {\n \"day_of_week\" : \"f65dc671a793\",\n \"minutes\" : \"3a2c2e309fb2\",\n \"hours\" : \"854a29390c95\",\n \"day_of_month\" : \"c718ee12bf11\",\n \"month\" : \"038f61e0aa4b\"\n }\n },\n \"overlap_action\" : \"wait\",\n \"notifications\" : [ {\n \"email\" : {\n \"name\" : \"cf700e335e58\",\n \"email\" : \"4e93b84c91de\",\n \"notify_when\" : \"on_state_change_and_failures\"\n }\n } ],\n \"process_definition_name\" : \"769fb4b8dd8b\",\n \"process_description\" : \"7872fd63a546\"\n}", "mode" : "raw" } }, "body" : "{\n \"task_definitions\" : [ {\n \"backoff_base_seconds\" : 1,\n \"task_definition_name\" : \"0e04d3e4e512\",\n \"backoff_exponent\" : 1,\n \"require_explicit_success\" : true,\n \"max_attempts\" : 1,\n \"max_runtime_seconds\" : 1,\n \"dependencies\" : [ {\n \"task_definition_name\" : \"4d026f1bb61f\",\n \"success_required\" : true\n } ],\n \"executable\" : {\n \"shell_script_command\" : {\n \"script\" : \"30ef3de72fc7\",\n \"environment_variables\" : [ {\n \"variable_name\" : \"e579d0f255e1\",\n \"value\" : \"fa84a89b8868\"\n } ]\n }\n }\n } ],\n \"paused\" : true,\n \"schedule\" : {\n \"cron_schedule\" : {\n \"day_of_week\" : \"187119908970\",\n \"minutes\" : \"c06cacbc17f6\",\n \"hours\" : \"cf7c909d7021\",\n \"day_of_month\" : \"a246290bce65\",\n \"month\" : \"4d592a622f80\"\n }\n },\n \"overlap_action\" : \"wait\",\n \"notifications\" : [ {\n \"email\" : {\n \"name\" : \"595a33eae9c6\",\n \"email\" : \"9f1b0a02f867\",\n \"notify_when\" : \"on_state_change_and_failures\"\n }\n } ],\n \"process_definition_name\" : \"77bfa72c54cb\",\n \"process_description\" : \"6080d93c904e\"\n}", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a registered process definition" }, "header" : [ ] }, "name" : "DELETE /api/process_definitions/:process_definition_name", "description" : { "content" : "Deletes a registered process definition" }, "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "DELETE", "description" : { "content" : "Deletes a registered process definition" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name/trigger", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name", "trigger" ], "query" : [ { "key" : "task_definition_name", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } } ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Triggers a new instance of the process" }, "header" : [ ] }, "name" : "POST /api/process_definitions/:process_definition_name/trigger", "description" : { "content" : "Triggers a new instance of the process" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name/trigger", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name", "trigger" ], "query" : [ { "key" : "task_definition_name", "disabled" : true, "description" : { "content" : "Type: string | Required: false" } } ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Triggers a new instance of the process" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name/pause", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name", "pause" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Pause the process schedule" }, "header" : [ ] }, "name" : "POST /api/process_definitions/:process_definition_name/pause", "description" : { "content" : "Pause the process schedule" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name/pause", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name", "pause" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Pause the process schedule" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name/resume", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name", "resume" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Resume the process schedule" }, "header" : [ ] }, "name" : "POST /api/process_definitions/:process_definition_name/resume", "description" : { "content" : "Resume the process schedule" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/process_definitions/:process_definition_name/resume", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "process_definitions", ":process_definition_name", "resume" ], "query" : [ ], "variable" : [ { "key" : "process_definition_name", "value" : "{{process_definition_name}}", "description" : { "content" : "Type: string | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Resume the process schedule" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" }, { "name" : "tasks", "item" : [ { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks" ], "query" : [ { "key" : "process_definition_name", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "task_definition_name", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "allowed_statuses", "disabled" : false, "description" : { "content" : "Type: [task_status] | Required: true" } }, { "key" : "start_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "end_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "limit", "disabled" : true, "description" : { "content" : "Type: integer | Required: false" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Retrieves the most recent tasks meeting the given criteria" }, "header" : [ ] }, "name" : "GET /api/tasks/", "description" : { "content" : "Retrieves the most recent tasks meeting the given criteria" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"GET requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 200 - [task]", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks" ], "query" : [ { "key" : "process_definition_name", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "task_definition_name", "disabled" : false, "description" : { "content" : "Type: string | Required: true" } }, { "key" : "allowed_statuses", "disabled" : false, "description" : { "content" : "Type: [task_status] | Required: true" } }, { "key" : "start_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "end_time", "disabled" : true, "description" : { "content" : "Type: date-time-iso8601 | Required: false" } }, { "key" : "limit", "disabled" : true, "description" : { "content" : "Type: integer | Required: false" } } ], "variable" : [ ] }, "method" : "GET", "description" : { "content" : "Retrieves the most recent tasks meeting the given criteria" }, "header" : [ ] }, "body" : "[ {\n \"start_time\" : \"2026-10-18T10:33:38.419Z\",\n \"execution_state\" : [ {\n \"metadata_entry_id\" : \"1a576947-9bdf-4974-8f76-27ffccb1f367\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"b427b45df9a9\",\n \"value\" : \"2f5533033c6b\"\n } ],\n \"process_id\" : \"26d24386-158f-4ce9-b148-b80f877921df\",\n \"process_definition_name\" : \"ab0468dd57a7\",\n \"task_definition_name\" : \"18a90472ccb1\",\n \"status\" : \"pending\",\n \"metadata_entries\" : [ {\n \"metadata_entry_id\" : \"22123736-87a9-463a-9bb4-bb96152285db\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"ff8d49e05c75\",\n \"value\" : \"07d9ecc95afa\"\n } ],\n \"previous_attempt_count\" : 1,\n \"end_time\" : \"2026-10-18T10:33:38.419Z\",\n \"log_entries\" : [ {\n \"log_entry_id\" : \"369b8c23-7f97-404b-a461-e4b4bbc655d0\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"source\" : \"ac121b871416\",\n \"message\" : \"8ca8be3dfd83\"\n } ],\n \"task_id\" : \"75fdf380-c952-4fac-baed-6c3022faa68b\"\n} ]", "code" : 200 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/log_entries", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "log_entries" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Appends log entries for a task; intended for use within the task executable" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "[ {\n \"log_entry_id\" : \"24bdbd57-d7db-4136-82b5-fc76770619dc\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"source\" : \"df25e785f058\",\n \"message\" : \"87d1f9afde14\"\n} ]", "mode" : "raw" } }, "name" : "POST /api/tasks/:task_id/log_entries", "description" : { "content" : "Appends log entries for a task; intended for use within the task executable" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/log_entries", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "log_entries" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Appends log entries for a task; intended for use within the task executable" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "[ {\n \"log_entry_id\" : \"24bdbd57-d7db-4136-82b5-fc76770619dc\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"source\" : \"df25e785f058\",\n \"message\" : \"87d1f9afde14\"\n} ]", "mode" : "raw" } }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/metadata", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "metadata" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Appends metadata entries for a task; intended for use within the task executable" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "[ {\n \"metadata_entry_id\" : \"9fffe93e-0223-45e4-a2de-db55b2b94eb9\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"ddab3879ef87\",\n \"value\" : \"8326b3c37160\"\n} ]", "mode" : "raw" } }, "name" : "POST /api/tasks/:task_id/metadata", "description" : { "content" : "Appends metadata entries for a task; intended for use within the task executable" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/metadata", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "metadata" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Appends metadata entries for a task; intended for use within the task executable" }, "header" : [ { "key" : "Content-Type", "value" : "application/json", "description" : { "content" : "Required to send JSON body" } } ], "body" : { "raw" : "[ {\n \"metadata_entry_id\" : \"9fffe93e-0223-45e4-a2de-db55b2b94eb9\",\n \"when\" : \"2026-10-18T10:33:38.419Z\",\n \"key\" : \"ddab3879ef87\",\n \"value\" : \"8326b3c37160\"\n} ]", "mode" : "raw" } }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/succeed", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "succeed" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Marks the task as having succeeded" }, "header" : [ ] }, "name" : "POST /api/tasks/:task_id/succeed", "description" : { "content" : "Marks the task as having succeeded" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/succeed", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "succeed" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Marks the task as having succeeded" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" }, { "request" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/fail", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "fail" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Marks the task as having failed" }, "header" : [ ] }, "name" : "POST /api/tasks/:task_id/fail", "description" : { "content" : "Marks the task as having failed" }, "event" : [ { "listen" : "test", "script" : { "exec" : [ "pm.test(\"POST requests should return 2xx\", function () {", " pm.response.to.be.success;", "});" ], "type" : "text/javascript" } } ], "response" : [ { "name" : "Example 204 - unit", "originalRequest" : { "url" : { "raw" : "{{BASE_URL}}/api/tasks/:task_id/fail", "host" : [ "{{BASE_URL}}" ], "path" : [ "api", "tasks", ":task_id", "fail" ], "query" : [ ], "variable" : [ { "key" : "task_id", "value" : "{{task_id}}", "description" : { "content" : "Type: uuid | Required: true" }, "disabled" : false } ] }, "method" : "POST", "description" : { "content" : "Marks the task as having failed" }, "header" : [ ] }, "code" : 204 } ], "type" : "item" } ], "type" : "folder" } ], "event" : [ ], "variable" : [ { "key" : "BASE_URL", "value" : "", "type" : "string" } ] }