playbook

Playbook style configuration management and automation. Enables controls over what has been targeted, completed, error's and reties of flows. Playbook enables you to quickly modify flows and track where it has been applied. Advanced functionality includes chaining playbooks one after another.

Triggers

Playbook Search

Trigger for looping through playbooks and their occurrences.

Input

Name	Description	Type	Required	Syntax
playbookName		input	False	False
sequence		input	False	False
incomplete		checkbox	False	False
excludeIncrementSequence		checkbox	False	False
playbookLimit		input	False	False
maxAttempts		input	False	False
delayBetweenAttempts		input	False	False

---

Actions

Playbook Start

Used to start a playbook for a provided playbook occurrence UID string.

Input

Name	Description	Type	Required	Syntax
playbookName		input	False	False
occurrence		input	False	False
playbookData		json-input	False	False
version		input	False	False
alwaysRun		checkbox	False	False
maxAttempts		input	False	False
keepHistory		checkbox	False	False
delayBetweenAttempts		input	False	False
sequence		input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

Playbook End

Define the end of a playbook within a flow.

Input

Name	Description	Type	Required	Syntax
result		checkbox	False	False
resultData		json-input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

Playbook Get

Get a playbook occurrence item.

Input

Name	Description	Type	Required	Syntax
occurrence		input	False	False
playbookName		input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

playbook Add

Add an occurrence into a playbook.

Input

Name	Description	Type	Required	Syntax
occurrence		input	False	False
playbookName		input	False	False
playbookData		json-input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

playbook Bulk Add

Add multiple occurrences into a playbook.

Input

Name	Description	Type	Required	Syntax
occurrences		json-input	False	False
occurrencesField		input	False	False
playbookName		input	False	False
playbookData		json-input	False	False
manual		checkbox	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

Playbook Update Data

Update a playbooks occurrence.

Input

Name	Description	Type	Required	Syntax
occurrence		input	False	False
playbookName		input	False	False
playbookData		json-input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

playbook Start Update

Update a defined playbook start action by action ID.

Input

Name	Description	Type	Required	Syntax
action_id		input	False	False
version		input	False	False
maxAttempts		input	False	False
delayBetweenAttempts		input	False	False
sequence		input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

Playbook Search Action

Search for occurrences within a playbook.

Input

Name	Description	Type	Required	Syntax
playbookName		input	False	False
sequence		input	False	False
incomplete		checkbox	False	False
excludeIncrementSequence		checkbox	False	False
playbookLimit		input	False	False
maxAttempts		input	False	False
delayBetweenAttempts		input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}

---

API

GET /integration/playbook/

Args

Returns

GET /integration/playbook/includes/[file]

Args

Returns

GET /integration/playbook/[playbookName]/

Args

Returns

GET /integration/playbook/[playbookName]/playbookResultsTable/[action]/

Args

Returns

POST /integration/playbook/[playbookName]/[occurrenceID]/clear/

Args

Returns