{"_id":"5c2248bc4100b3001f39e466","project":"55faf11ba62ba1170021a9a7","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":46,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f","5c222bed4bc358002f21459a","5c22412594a2a5005cc9e919","5c41ae1c33592700190a291e","5c8a525e2ba7b2003f9b153c","5cbf14d58c79c700ef2b502e","5db6f03a6e187c006f667fa4"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5c22412594a2a5005cc9e919","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-12-25T14:39:33.459Z","from_sync":false,"order":31,"slug":"sb-cli","title":"SB Command Line Interface"},"user":"566590c83889610d0008a253","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-12-25T15:11:56.321Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"##Overview\n\nUse the following commands to manage tasks via the Seven Bridges Command Line Interface.\n\n##tasks create\n\nCreate a new task.\n\nThe `project_id` takes the form of `{project_owner}/{project}`, where `{project_owner}` is the username of the user who created the project and {project} is not the project's full given name, but its short name.\n\nThe `app_id` is formatted as: `{project_owner}/{project}/{app_short_name}/{revision_number}`.\n\nYou can set the value for `inputs_file` if you want to describe the inputs in a JSON file. If you do not set the value, the command expects inputs description from stdin.\n\nSimilarly, if you are performing a batch task, you can set the value for `batch_criteria_file` if you want to describe batch criteria in a JSON file. If you do not set the value, the command expects a batch criteria description from stdin.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb tasks create [--name <name_value>] [--description <description_value>] --project_id <project_id_value> --app_id <app_id_value> --inputs_file <inputs_file_value> [--batch_by <batch_by_value>] [--batch_input <batch_input_value>] [--run_now] [flags]\\n\\nFlags:\\n      --name string          The name of the task.\\n      --description string   Human-readable description of the task.\\n      --project_id string    The project in which you want to create the task.\\n      --app_id string        The id of the app you want to run.\\n      --inputs_file string   The file describing the input object. If omitted, input from stdin is expected.\\n      --batch_by string      Filename for file that contains a specification of batch criteria.\\n      --batch_input string   The ID of the input on which you wish to batch.\\n      --run_now              Set to true to run a task immediately upon creation.\\n  -h, --help                 help for create\",\n      \"language\": \"text\",\n      \"name\": \"tasks create\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##tasks list\n\nGet a list of tasks that you can access.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb tasks list [--status <status_value>] [--project <project_value>] [--parent <parent_value>] [flags]\\n\\nFlags:\\n      --status string    List only tasks that have the specified status.\\n      --project string   List only tasks from the specified project.\\n      --parent string    List only child tasks from the specified task.\\n  -h, --help             help for list\",\n      \"language\": \"text\",\n      \"name\": \"tasks list\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##tasks get\n\nGet the details of the specified task.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb tasks get <task_id> [--inputs_only] [flags]\\n\\nArguments:\\n      task_id   ID of the task.\\n\\nFlags:\\n      --inputs_only   Get only inputs for the task (JSON output only).\\n  -h, --help          help for get\",\n      \"language\": \"text\",\n      \"name\": \"tasks get\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##tasks update\n\nUpdate task details.\n\nYou can set the value for inputs_file if you want to describe the inputs in a JSON file. If you do not set the value, the command expects an inputs description from stdin.\n\nSimilarly, if you are performing a batch task, you can set the value for `batch_criteria_file` if you want to describe batch criteria in a JSON file. If you do not set the value, the command expects a batch criteria description from stdin.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb tasks update <task_id> [--name <name_value>] [--description <description_value>] [--inputs_file <inputs_file_value>] [--batch_by <batch_by_value>] [--batch_input <batch_input_value>] [flags]\\n\\nArguments:\\n      task_id   ID of the task.\\n\\nFlags:\\n      --name string          The updated name for the task.\\n      --description string   Updated description of the task.\\n      --inputs_file string   Filename for file that contains a dictionary of input objects.\\n      --batch_by string      Filename for file that contains a specification of batch criteria.\\n      --batch_input string   The ID of the input on which you wish to batch.\\n  -h, --help                 help for update\",\n      \"language\": \"text\",\n      \"name\": \"tasks update\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##tasks run\n\nRun a specified task.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb tasks run <task_id> [flags]\\n\\nArguments:\\n      task_id   ID of the task.\\n\\nFlags:\\n  -h, --help   help for run\",\n      \"language\": \"text\",\n      \"name\": \"tasks run\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n##tasks abort\n\nAbort the specified task. Only a task whose status is either \"RUNNING\" or \"QUEUED\" may be aborted.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Usage:\\n  sb tasks abort <task_id> [flags]\\n\\nArguments:\\n      task_id   ID of the task.\\n\\nFlags:\\n  -h, --help   help for abort\",\n      \"language\": \"text\",\n      \"name\": \"tasks abort\"\n    }\n  ]\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>","excerpt":"","slug":"tasks-1","type":"basic","title":"Tasks"}
##Overview Use the following commands to manage tasks via the Seven Bridges Command Line Interface. ##tasks create Create a new task. The `project_id` takes the form of `{project_owner}/{project}`, where `{project_owner}` is the username of the user who created the project and {project} is not the project's full given name, but its short name. The `app_id` is formatted as: `{project_owner}/{project}/{app_short_name}/{revision_number}`. You can set the value for `inputs_file` if you want to describe the inputs in a JSON file. If you do not set the value, the command expects inputs description from stdin. Similarly, if you are performing a batch task, you can set the value for `batch_criteria_file` if you want to describe batch criteria in a JSON file. If you do not set the value, the command expects a batch criteria description from stdin. [block:code] { "codes": [ { "code": "Usage:\n sb tasks create [--name <name_value>] [--description <description_value>] --project_id <project_id_value> --app_id <app_id_value> --inputs_file <inputs_file_value> [--batch_by <batch_by_value>] [--batch_input <batch_input_value>] [--run_now] [flags]\n\nFlags:\n --name string The name of the task.\n --description string Human-readable description of the task.\n --project_id string The project in which you want to create the task.\n --app_id string The id of the app you want to run.\n --inputs_file string The file describing the input object. If omitted, input from stdin is expected.\n --batch_by string Filename for file that contains a specification of batch criteria.\n --batch_input string The ID of the input on which you wish to batch.\n --run_now Set to true to run a task immediately upon creation.\n -h, --help help for create", "language": "text", "name": "tasks create" } ] } [/block] <div align="right"><a href="#top">top</a></div> ##tasks list Get a list of tasks that you can access. [block:code] { "codes": [ { "code": "Usage:\n sb tasks list [--status <status_value>] [--project <project_value>] [--parent <parent_value>] [flags]\n\nFlags:\n --status string List only tasks that have the specified status.\n --project string List only tasks from the specified project.\n --parent string List only child tasks from the specified task.\n -h, --help help for list", "language": "text", "name": "tasks list" } ] } [/block] <div align="right"><a href="#top">top</a></div> ##tasks get Get the details of the specified task. [block:code] { "codes": [ { "code": "Usage:\n sb tasks get <task_id> [--inputs_only] [flags]\n\nArguments:\n task_id ID of the task.\n\nFlags:\n --inputs_only Get only inputs for the task (JSON output only).\n -h, --help help for get", "language": "text", "name": "tasks get" } ] } [/block] <div align="right"><a href="#top">top</a></div> ##tasks update Update task details. You can set the value for inputs_file if you want to describe the inputs in a JSON file. If you do not set the value, the command expects an inputs description from stdin. Similarly, if you are performing a batch task, you can set the value for `batch_criteria_file` if you want to describe batch criteria in a JSON file. If you do not set the value, the command expects a batch criteria description from stdin. [block:code] { "codes": [ { "code": "Usage:\n sb tasks update <task_id> [--name <name_value>] [--description <description_value>] [--inputs_file <inputs_file_value>] [--batch_by <batch_by_value>] [--batch_input <batch_input_value>] [flags]\n\nArguments:\n task_id ID of the task.\n\nFlags:\n --name string The updated name for the task.\n --description string Updated description of the task.\n --inputs_file string Filename for file that contains a dictionary of input objects.\n --batch_by string Filename for file that contains a specification of batch criteria.\n --batch_input string The ID of the input on which you wish to batch.\n -h, --help help for update", "language": "text", "name": "tasks update" } ] } [/block] <div align="right"><a href="#top">top</a></div> ##tasks run Run a specified task. [block:code] { "codes": [ { "code": "Usage:\n sb tasks run <task_id> [flags]\n\nArguments:\n task_id ID of the task.\n\nFlags:\n -h, --help help for run", "language": "text", "name": "tasks run" } ] } [/block] <div align="right"><a href="#top">top</a></div> ##tasks abort Abort the specified task. Only a task whose status is either "RUNNING" or "QUEUED" may be aborted. [block:code] { "codes": [ { "code": "Usage:\n sb tasks abort <task_id> [flags]\n\nArguments:\n task_id ID of the task.\n\nFlags:\n -h, --help help for abort", "language": "text", "name": "tasks abort" } ] } [/block] <div align="right"><a href="#top">top</a></div>