The Hive Project¶

Node: theHiveProject · Full type: n8n-nodes-base.theHiveProject · Version: 1

Credentials¶

theHiveProjectApi (alias: @the)

CREDENTIAL @the = theHiveProjectApi "My The Hive Project"

Operations¶

Resource: `alert`¶

`create`¶

Parameter	Type	Default	Details
`alertFields`	resourceMapper	{...}	required
`observableUi`	fixedCollection	{}	groups: `values`

`deleteAlert`¶

Parameter	Type	Default	Details
`alertId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`

`executeResponder`¶

Parameter	Type	Default	Details
`id`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`responder`	options	""	required

`get`¶

Parameter	Type	Default	Details
`alertId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`options`	collection	{}	keys: `includeSimilarAlerts`, `includeSimilarCases`

`merge`¶

Parameter	Type	Default	Details
`alertId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`

`promote`¶

Parameter	Type	Default	Details
`alertId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`options`	collection	{}	keys: `caseTemplate`

`search`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`filters`	fixedCollection	{}	groups: `values`
`sort`	fixedCollection	{}	groups: `fields`
`options`	collection	{}	keys: `returnCount`, `extraData`, `extraData`, `extraData`, `extraData`, `extraData`, ...

`update`¶

Parameter	Type	Default	Details
`alertUpdateFields`	resourceMapper	{...}	required

`status`¶

Parameter	Type	Default	Details
`alertId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`status`	options	""	required

Resource: `case`¶

`addAttachment`¶

Parameter	Type	Default	Details
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`attachmentsUi`	fixedCollection	{}	groups: `values`
`options`	collection	{}	keys: `canRename`

`create`¶

Parameter	Type	Default	Details
`caseFields`	resourceMapper	{...}	required

`deleteAttachment`¶

Parameter	Type	Default	Details
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`attachmentId`	options	""	required

`deleteCase`¶

Parameter	Type	Default	Details
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`

`executeResponder`¶

Parameter	Type	Default	Details
`id`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`responder`	options	""	required

`get`¶

Parameter	Type	Default	Details
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`

`getAttachment`¶

Parameter	Type	Default	Details
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`attachmentId`	options	""	required
`options`	collection	{}	keys: `fileName`, `dataPropertyName`

`getTimeline`¶

Parameter	Type	Default	Details
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`

`search`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	50
`filters`	fixedCollection	{}	groups: `values`
`sort`	fixedCollection	{}	groups: `fields`
`options`	collection	{}	keys: `returnCount`, `extraData`, `extraData`, `extraData`, `extraData`, `extraData`, ...

`update`¶

Parameter	Type	Default	Details
`caseUpdateFields`	resourceMapper	{...}	required

Resource: `comment`¶

`add`¶

Parameter	Type	Default	Details
`addTo`	options	"alert"	`alert`, `case`
`id`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`id`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`message`	string	""	required

`deleteComment`¶

Parameter	Type	Default	Details
`commentId`	resourceLocator	{...}	required; modes: `list`, `id`

`search`¶

Parameter	Type	Default	Details
`searchIn`	options	"all"	`all`, `alert`, `case`
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`alertId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`returnAll`	boolean	false
`limit`	number	50
`filters`	fixedCollection	{}	groups: `values`
`sort`	fixedCollection	{}	groups: `fields`
`options`	collection	{}	keys: `returnCount`, `extraData`, `extraData`, `extraData`, `extraData`, `extraData`, ...

`update`¶

Parameter	Type	Default	Details
`commentId`	resourceLocator	{...}	required; modes: `list`, `id`
`message`	string	""	required

Resource: `observable`¶

`create`¶

Parameter	Type	Default	Details
`createIn`	options	"case"	`case`, `alert`
`id`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`id`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`dataType`	options	"file"	required
`data`	string	""	required
`attachmentsUi`	fixedCollection	{}	required; groups: `values`
`observableFields`	resourceMapper	{...}	required

`deleteObservable`¶

Parameter	Type	Default	Details
`observableId`	resourceLocator	{...}	required; modes: `list`, `id`

`executeAnalyzer`¶

Parameter	Type	Default	Details
`observableId`	resourceLocator	{...}	required; modes: `list`, `id`
`dataType`	options	""
`analyzers`	multiOptions	[]	required

`executeResponder`¶

Parameter	Type	Default	Details
`id`	resourceLocator	{...}	required; modes: `list`, `id`
`responder`	options	""	required

`get`¶

Parameter	Type	Default	Details
`observableId`	resourceLocator	{...}	required; modes: `list`, `id`

`search`¶

Parameter	Type	Default	Details
`searchIn`	options	"all"	`all`, `alert`, `case`
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`alertId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`returnAll`	boolean	false
`limit`	number	50
`filters`	fixedCollection	{}	groups: `values`
`sort`	fixedCollection	{}	groups: `fields`
`options`	collection	{}	keys: `returnCount`, `extraData`, `extraData`, `extraData`, `extraData`, `extraData`, ...

`update`¶

Parameter	Type	Default	Details
`observableUpdateFields`	resourceMapper	{...}	required

Resource: `page`¶

`create`¶

Parameter	Type	Default	Details
`location`	options	"case"	`case`, `knowledgeBase`
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`title`	string	""	required
`category`	string	""	required
`content`	string	""	required

`deletePage`¶

Parameter	Type	Default	Details
`location`	options	"knowledgeBase"	`case`, `knowledgeBase`
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`pageId`	resourceLocator	{...}	required; modes: `list`, `id`

`search`¶

Parameter	Type	Default	Details
`searchInKnowledgeBase`	boolean	true
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`returnAll`	boolean	false
`limit`	number	50
`filters`	fixedCollection	{}	groups: `values`
`sort`	fixedCollection	{}	groups: `fields`
`options`	collection	{}	keys: `returnCount`, `extraData`, `extraData`, `extraData`, `extraData`, `extraData`, ...

`update`¶

Parameter	Type	Default	Details
`location`	options	"case"	`case`, `knowledgeBase`
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`pageId`	resourceLocator	{...}	required; modes: `list`, `id`
`content`	string	""
`options`	collection	{}	keys: `category`, `title`, `order`

Resource: `query`¶

`executeQuery`¶

Parameter	Type	Default
`queryJson`	json	"=[
{
"_name": "listOrganisation..."	required

Resource: `task`¶

`create`¶

Parameter	Type	Default	Details
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`taskFields`	resourceMapper	{...}	required

`deleteTask`¶

Parameter	Type	Default	Details
`taskId`	resourceLocator	{...}	required; modes: `list`, `id`

`executeResponder`¶

Parameter	Type	Default	Details
`id`	resourceLocator	{...}	required; modes: `list`, `id`
`responder`	options	""	required

`get`¶

Parameter	Type	Default	Details
`taskId`	resourceLocator	{...}	required; modes: `list`, `id`

`search`¶

Parameter	Type	Default	Details
`allCases`	boolean	true
`caseId`	resourceLocator	{...}	required; modes: `list`, `url`, `id`
`returnAll`	boolean	false
`limit`	number	50
`filters`	fixedCollection	{}	groups: `values`
`sort`	fixedCollection	{}	groups: `fields`
`options`	collection	{}	keys: `returnCount`, `extraData`, `extraData`, `extraData`, `extraData`, `extraData`, ...

`update`¶

Parameter	Type	Default	Details
`taskUpdateFields`	resourceMapper	{...}	required

Resource: `log`¶

`addAttachment`¶

Parameter	Type	Default	Details
`logId`	resourceLocator	{...}	required; modes: `list`, `id`
`attachmentsUi`	fixedCollection	{}	groups: `values`

`create`¶

Parameter	Type	Default	Details
`taskId`	resourceLocator	{...}	required; modes: `list`, `id`
`logFields`	resourceMapper	{...}	required
`attachmentsUi`	fixedCollection	{}	groups: `values`

`deleteLog`¶

Parameter	Type	Default	Details
`logId`	resourceLocator	{...}	required; modes: `list`, `id`

`deleteAttachment`¶

Parameter	Type	Default	Details
`logId`	resourceLocator	{...}	required; modes: `list`, `id`
`attachmentId`	options	""	required

`executeResponder`¶

Parameter	Type	Default	Details
`id`	resourceLocator	{...}	required; modes: `list`, `id`
`responder`	options	""	required

`get`¶

Parameter	Type	Default	Details
`logId`	resourceLocator	{...}	required; modes: `list`, `id`

`search`¶

Parameter	Type	Default	Details
`allTasks`	boolean	true
`taskId`	resourceLocator	{...}	required; modes: `list`, `id`
`returnAll`	boolean	false
`limit`	number	50
`filters`	fixedCollection	{}	groups: `values`
`sort`	fixedCollection	{}	groups: `fields`
`options`	collection	{}	keys: `returnCount`, `extraData`, `extraData`, `extraData`, `extraData`, `extraData`, ...

Parameter Details¶

observableUi children:

values group:

Parameter	Type	Default
`dataType`	options	""
`data`	string	""
`binaryProperty`	string	"data"
`message`	string	""
`tags`	string	""

options children:

Parameter	Type	Default	Details
`includeSimilarAlerts`	boolean	false
`includeSimilarCases`	boolean	false

filters children:

values group:

Parameter	Type	Default	Details
`field`	string	""
`field`	options	""
`field`	options	""
`field`	options	""
`field`	options	""
`field`	options	""	`message`, `date`
`field`	options	""	`message`
`field`	options	""	`category`, `content`, `title`
`operator`	options	"_eq"	`_between`, `_like`, `_endsWith`, `_eq`, `_gt`, `_gte`, `_in`, `_lt`, ... (12 total)
`value`	string	""
`values`	string	""
`from`	string	""
`to`	string	""

sort children:

fields group:

Parameter	Type	Default	Details
`field`	string	""
`field`	options	""
`field`	options	""
`field`	options	""
`field`	options	""
`field`	options	""	`message`, `date`
`field`	options	""	`message`
`field`	options	""	`category`, `content`, `title`
`direction`	options	"asc"	`asc`, `desc`

attachmentsUi children:

values group:

Parameter	Type	Default	Details
`field`	string	"data"

Example¶

NODE "theHiveProject" @the AS "The Hive Project" {
  resource: "alert",
  operation: "executeQuery",
  message: {{ $json.message }},
  data: {{ $json.data }},
  title: {{ $json.title }}
}

The Hive Project¶

Credentials¶

Operations¶

Resource: alert¶

create¶

deleteAlert¶

executeResponder¶

get¶

merge¶

promote¶

search¶

update¶

status¶

Resource: case¶

addAttachment¶

create¶

deleteAttachment¶

deleteCase¶

executeResponder¶

get¶

getAttachment¶

getTimeline¶

search¶

update¶

Resource: comment¶

add¶

deleteComment¶

search¶

update¶

Resource: observable¶

create¶

deleteObservable¶

executeAnalyzer¶

executeResponder¶

get¶

search¶

update¶

Resource: page¶

create¶

deletePage¶

search¶

update¶

Resource: query¶

executeQuery¶

Resource: task¶

create¶

deleteTask¶

executeResponder¶

get¶

search¶

update¶

Resource: log¶

addAttachment¶

create¶

deleteLog¶

deleteAttachment¶

executeResponder¶

get¶

search¶

Parameter Details¶

Example¶

Resource: `alert`¶

`create`¶

`deleteAlert`¶

`executeResponder`¶

`get`¶

`merge`¶

`promote`¶

`search`¶

`update`¶

`status`¶

Resource: `case`¶

`addAttachment`¶

`create`¶

`deleteAttachment`¶

`deleteCase`¶

`executeResponder`¶

`get`¶

`getAttachment`¶

`getTimeline`¶

`search`¶

`update`¶

Resource: `comment`¶

`add`¶

`deleteComment`¶

`search`¶

`update`¶

Resource: `observable`¶

`create`¶

`deleteObservable`¶

`executeAnalyzer`¶

`executeResponder`¶

`get`¶

`search`¶

`update`¶

Resource: `page`¶

`create`¶

`deletePage`¶

`search`¶

`update`¶

Resource: `query`¶

`executeQuery`¶

Resource: `task`¶

`create`¶

`deleteTask`¶

`executeResponder`¶

`get`¶

`search`¶

`update`¶

Resource: `log`¶

`addAttachment`¶

`create`¶

`deleteLog`¶

`deleteAttachment`¶

`executeResponder`¶

`get`¶

`search`¶