Warning

title	Page in development

This page is in development and as such, its contents may be incorrect

The workflow API provides functionality that allows a administrator to perform actions such as adding and configuring workflow

Table of Contents

Response

Section

List

Get all workflows

Lists all the workflows configured in the Aspire

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflow

Query String Parameters

Name

from

Type

integer

Required

Description

description string Optional Filter workflows to only those whose description matches the given expression

sparse boolean Optional Only return minimal data such as identifier, description, name etc

Optional	Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	Sort mode "asc" for ascending sort, "desc" for descending sort
expand	string	Optional	List of fields to expand, * will expand everything
sparse	boolean	Optional	Only return minimal data such as identifier, description, name etc

Response

Code Block

language	js

{
  "

Code Block

language	js

{
  "workflow": [{
    "id": "AAABcID5GBc=",
    "description": "Publish to Elasticsearch",
    ...
  },
  {
    "id": "AAABcIueWUc=",
    "description": "Normalise data",
    ...
  }]
}

Status

Response code	Description
200	Success

Section

Get

a single workflow

all workflows, filtered

Lists workflows configured in the Aspire, filtered by a specified criteriaGet information about a single workflow in Aspire

Panel

borderColor	black
bgColor	#fafafb

GET POST /aspire/_api/workflowworkflows/:idgetAll

Path Query String Parameters

idstring

Name	Type	Required	Description
from	integer	RequiredOptional	The id of the workflow to return

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcID5GBc=",
    "description": "Publish to Elasticsearch",
    ...
  }
}

Status

Response code Description

200 Success

404 The given workflow id was not found

Section

Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	Sort mode "asc" for ascending sort, "desc" for descending sort
expand	string	Optional	List of fields to expand, * will expand everything
sparse	boolean	Optional	Only return minimal data such as identifier, description, name etc

Add a workflow

Adds a workflow to Aspire

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow

Request Body Parameters

Name	Type	Required	Description
descriptionfilter	stringJSON	Required	A description of the workflow

Query String Parameters

Name Type Required Description

type

string

Required

Accepted values are: "connector" and "service"

If connector is set the workflow created with the following events will be created:

onScan
onAddUpdate
onDelete
onPublish
onError

If service is set the workflow will be created without events.

Filters retrieved connectors. Check the filter definition here

Response

Code Block

language	js

{
  "workflow": [{
    "id": "AAABcID5GBc=",

Examples

Add a single workflow: /aspire/_api/workflow?type=connector

Code Block

language	js

{
  "description": "Publish to ElasticElasticsearch"
}

Response

Code Block

language	js

{
  "workflow":,
    ...
  },
  {
    "id": "AAABcID5GBcAAABcIueWUc=",
    "description": "PublishNormalise to Elasticdata",
    "type": "connector"
    ....
  }]
}

Status

Response code	Description
201200	Created
406	Not acceptable - there was an issue validating the input
Success

Section

Get a single workflow

Get information about a single workflow in Aspire

Section

Delete workflow(s)

Delete one or more workflow from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE GET /aspire/_api/workflow/:idDELETE /aspire/_api/workflow

Path and Query String Parameters

identifier(s) (s) delete

Name	Type	Required	Description
id	string	Required	The	id of the workflow	to	return

ExamplesResponse

Delete a single workflow

Code Block

language	js

DELETE /aspire/_api/workflows/AAABcID5GBc=

Delete multiple workflows

Code Block

language	js

DELETE /aspire/_api/workflows?id=AAABcID5GBc=&id=AAABcIueWUc=

Response

Code Block

language	js

{
	"message": "optional response message"
{
  "workflow": {
    "id": "AAABcID5GBc=",
    "description": "Publish to Elasticsearch",
    ...
  }
}

Status

Response code	Description
200	Success
404	Not found - a The given workflow identifier id was not found
406	Not acceptable - there was an issue validating the input

Section

Add single workflow

Adds a single workflow to Aspire

Get a workflow event

Get a event from a workflow in Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET POST /aspire/_api/workflow/:id/:eventId

Body Path Parameters

string

Name	Type	Required	Description
iddescription	string	Required	The identifier A description of the workflow(s) to return	eventId

Query String Parameters

Name	Type	Required	The identifier of the event to get

Response

Description

type

string

Required

Accepted values are: "connector" and "service"

If connector is set the workflow created with the following events will be created:

onScan
onAddUpdate
onDelete
onPublish
onError

If service is set the workflow will be created without events.

Example

Code Block

language	js

/aspire/_api/workflow?type=connector

Code Block

language	js

{
  "workflowdescription": "Publish to Elastic"
}

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUcAAABcID5GBc=",
    "description": "Publish to ElasticsearchElastic",
    "eventtype": {
      "id": "onUpdate""connector"
       ....
    }
  }
}

Status

Response code	Description
200201	SuccessCreated
404406	Not found - a given workflow identifier was not found	406	Not acceptable - there was acceptable - there was an issue validating the input

Section

Delete multiple workflows, filtered

Delete multiple workflows from Aspire, filtered by a specified criteria

Create workflow event(s)

Create one or more workflow events in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT POST /aspire/_api/workflowworkflows/:id

PUT /aspire/_api/workflow/:id/:eventId

deleteAll

Body Path Parameters

Name	Type	Required	Description
idfilter	stringJSON	Required	The identifier of the workflow(s) to add a event to
eventId	string	Required	The identifier of the event to add

Examples

Create a single event

Create multiple events (body parameter)

Filters workflows to be deleted. Check the filter definition here

Response

Code Block

language	js

[{
  "idmessage": "scan"
},
{
  "id": "addUpdate"
}]

Create multiple events (alternative version)

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": ["scan", "addUpdate"]
    }
  }
}

optional response message"
}

See Response Body for details regrading the response body returned where multiple items are affected with some (or all) returning errors

Status

Response code	Description
200	Success
404	Not found - a given credential identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete single workflow

Delete a single workflow from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflow/:id

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier(s) of the workflow(s) to delete

Example

Code Block

language	js

DELETE /aspire/_api/workflows/AAABcID5GBc=

Response

Code Block

language	js

{
	"message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete

Get a workflow event

Delete Get a workflow event from a workflow in Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE GET /aspire/_api/workflow/:id/:eventId

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to usereturn
eventId	string	Required	The identifier of the event to deleteget

Response

Code Block

language	js

{
  "workflow": {
    "messageid": "optional response message"
}

Status

AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onUpdate"
       ....
    }
  }
}

Status

Response code	Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Create

a

workflow event

item

(s)

Create a workflow event item - a rule, condition and the likeone or more workflow events in Aspire.

Panel

borderColor	black
bgColor	#fafafb

POST PUT /aspire/_api/workflow/:id

PUT /:eventIdaspire/_api/workflow/:id/:typeeventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to returnadd a event to
eventId	string	Required	The identifier of the event to get
type	string	Required	The type of the item to create

Request Body Parameters

The request body parameters will differ depending on the type of item created. Some examples are shown below

add

Examples

Create a single event

Create multiple events (body parameter)

Code Block

language	js

[{
  "id": "scan"
},
{
  "id": "addUpdate"
}]

Create multiple events (alternative version)

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": ["scan", "addUpdate"]
    }
  }
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Response

Section

Delete a workflow event

Delete a workflow event from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflow/:id/:eventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to use
eventId	string	Required	The identifier of the event to delete

Response

Item Type Parameter Name Parameter Type Required Description

Reference parentId string Optional The identifier of the node in to which the item should be inserted. Defaults to the root node

orderId integer Required The position (which in the children of the parent node) where this reference should be inserted ruleId String Required The rule to be referenced enabled boolean Optional Whether or not the item is enabled (default true)

Condition parentId string Optional The identifier of the node in to which the item should be inserted. Defaults to the root node

value object Required The value to be compared against enabled boolean Optional Whether or not the item is enabled (default true)

Exit parentId string Optional The identifier of the node in to which the item should be inserted. Defaults to the root node

orderId integer Required The position (which in the children of the parent node) where this reference should be inserted enabled boolean Optional Whether or not the item is enabled (default true)

Code Block

language	js

{
  "workflowmessage": {
"optional response   "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "AAABcQwxWUc=",
        ...
      }
    }
  }
}

Status

Response codeDescription200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input

message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Response

Section

Create a workflow event item

Create a workflow event item - a rule, condition and the like.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow/:id/:eventId/:type

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to return
eventId	string	Required	The identifier of the event to get
type	string	Required	The type of the item to create

Body Parameters

The request body parameters will differ depending on the type of item created. Some examples are shown below

Item Type	Parameter Name	Parameter Type	Required	Description
Reference	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node

Section

Update a workflow event item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflow/:id/:eventId/:orderId

Path Parameters

The identifier of the event to use

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to use
eventId	string	Required
	orderId	integer	Required	The order identifier of the item to update

Request Body Parameters

The request body parameters will differ depending on the type of item created. See Create a workflow event item above

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "AAABcQwxWUc=",
        ...
      }
    }
  }
}

Status

Response code Description

200 Success

404 Not found - a given workflow identifier was not found

406 Not acceptable - there was an issue validating the input

Section

position (which in the children of the parent node) where this reference should be inserted
	ruleId	String	Required	The rule to be referenced
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
Condition	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node
	value	object	Required	The value to be compared against
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
Exit	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node
	orderId	integer	Required	The position (which in the children of the parent node) where this reference should be inserted
	enabled	boolean	Optional	Whether or not the item is enabled (default true)

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "AAABcQwxWUc=",
        ...
      }
    }
  }
}

Delete a workflow event item

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflow/:id/:eventId/:parentId/:orderId

Path Parameters

Name Type Required Description

id string Required The identifier of the workflow to use

eventId string Required The identifier of the event to use

parentId string Required The identifier of the node with the item to be deleted

orderId integer Required The order identifier of the item to delete

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Move

Update a workflow event item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflow/:id/move:eventId/:eventIdorderId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to use
eventId	string	Required	The identifier of the event to use

Body Parameters

Type

orderId	integer	Name		Required	Description	src	string	Required	The The order identifier of the event item to move
dest	string	Required	The identifier of the new parent for the moved item

Response

update

Body Parameters

The request body parameters will differ depending on the type of item created. See Create a workflow event item above

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "AAABcQwxWUc=",
        ...
      }
    }
  }
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete single workflow event item

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflow/:id/:eventId/:parentId/:orderId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to use
eventId	string	Required	The identifier of the event to use
parentId	string	Required	The identifier of the node with the item to be deleted
orderId	integer	Required	The order identifier of the item to delete

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Move a workflow event item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT/aspire/_api/workflow/:id/move/:eventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to use
eventId	string	Required	The identifier of the event to use

Body Parameters

Name	Type	Required	Description
src	string	Required	The identifier of the event item to move
dest	string	Required	The identifier of the new parent for the moved item

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get workflow templates

Retrieve all workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/:id/templates

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to get the templates for

Query String Parameters

Name	Type	Required	Description
from	integer	Optional	Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	Sort mode "asc" for ascending sort, "desc" for descending sort

Response

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    },
	  "id": "AAABcQwrWUd",
      ...
    }]
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get all workflow templates, filtered

Lists workflow templates configured in the Aspire, filtered by a specified criteria

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/:id/templates/getAll

Query String Parameters

Name	Type	Required	Description
from	integer	Optional	Indicates the initial page to be retrieved
size	integer	Optional	Specifies the size of results page
sortBy	string	Optional	Field by which results are sorted
sortMode	string	Optional	Sort mode "asc" for ascending sort, "desc" for descending sort
expand	string	Optional	List of fields to expand, * will expand everything

Body Parameters

Name	Type	Required	Description
filter	JSON	Required	Filters retrieved workflow templates. Check the filter definition here

Response

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    },
	  "id": "AAABcQwrWUd",
      ...
    }]
  "message": "optional response message"
}

Status

Response code	Description
200	Success

Section

Get single workflow template

Retrieve a single workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflow/:id/template/:templateId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to get the templates for
templateId	string	Required	The identifier of the template to get

Response

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    }]
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get single workflow rule

Get a single workflow rule from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflow/:id/rule/:ruleId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to return rules for
ruleId	string	Required	The identifier of the rule to get

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
      ...
    }
  }

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

an issue validating the input

Response

Section

Create a workflow rule

Create a single workflow rule in Aspire.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow/:id/rules

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to create a rule for

Body Parameters

The request body parameters will differ depending on the type of rule created. Some examples are shown below

Rule Type	Parameter Name	Parameter Type	Required	Description
groovy	<TODO>
application

Optionally you may opt to add the created rule to a workflow event by adding the following query parameters

Parameter Name	Parameter

Get workflow templates

Retrieve all workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/:id/templates

Path and Query String Parameters

id

Name	Type	Required	Description
parentId	string	Required	The identifier of the workflow to get the templates for
description	string	Optional	Filter workflows to only those whose description matches the given expression

Response

	The identifier of the node in to which the item should be inserted. Defaults to the root node
orderId	integer	Required	The position (which in the children of the parent node) where this reference should be inserted

Response when parentId used

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event":

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUconAddUpdate",
       ..."rule": {
    }]    "id": "ddSWeq123",
  "message": "optional response message"
}

Status

Response code Description

200 Success

404 Not found - a given workflow identifier was not found

406 Not acceptable - there was an issue validating the input

Section

      "description": "Some rule",
        "type": "application",
        ...
      }
    }
  }
}

Response without parentId

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "rule":

Get a workflow template

Retrieve a workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflow/:id/template/:templateId

Path Parameters

Name Type Required Description

id string Required The identifier of the workflow to get the templates for

templateId string Required The identifier of the template to get

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUcddSWeq123",
      ..."description": "Some rule",
    }]
  "messagetype": "optional response message"application",
      ...
    }
  }
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Get a

Update single workflow rule

Get one or more Updatee a single workflow rule from in Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET PUT /aspire/_api/workflow/:id/rule/:ruleIdruleId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to return rules update a rule for
ruleIdruleId	string	Required	The identifier of the rule to getupdate

Response

Body Parameters

The request body parameters will differ depending on the type of rule created. See Create a workflow rule above

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
    "description":  ...
    }
  }
}

Status

Response code Description

200 Success

404 Not found - a given workflow identifier was not found

406 Not acceptable - there was an issue validating the input

"Publish to Elasticsearch"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
      ...
    }
  }
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Delete single workflow rule

Deletes a single workflow rule from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflows/:id/rule/:ruleId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow from which to delete rule(s) or the identifier of the rule to delete when used in the body
ruleId	string	Required	The identifier of the rule to delete

Response

Code Block

language	js

{
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Request Body Parameters

The request body parameters will differ depending on the type of rule created. Some examples are shown below

Optionally you may opt to add the created rule to a workflow event by adding the following query parameters

Response when parentId used

Section

Get workflow item types

Lists all available workflow item types

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/itemType

Response

Code Block

language	js

{
  type: [ "application", "publisher", "function"]
}

Section

Create a workflow rule

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflow/:id/rules

Path Parameters

Name Type Required Description

id string Required The identifier of the workflow to create a rule for

Rule Type Parameter Name Parameter Type Required Description

groovy <TODO> application

Parameter Name Parameter Type Required Description

parentId string Required The identifier of the node in to which the item should be inserted. Defaults to the root node

orderId integer Required The position (which in the children of the parent node) where this reference should be inserted

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "event": {
      "id": "onAddUpdate",
      "rule": {
        "id": "ddSWeq123",
        "description": "Some rule",
        "type": "application",
        ...
      }
    }
  }
}

Response without parentId

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
      ...
    }
  }
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Request Body Parameters

The request body parameters will differ depending on the type of rule created. See Create a workflow rule above

Section

Get specific workflow items by type

Returns a workflow item by its type

Update a workflow rule

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT GET /aspire/_api/workflowworkflows/itemType/:id/rule/:ruleId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow

to update a rule for

ruleId string Required The identifier of the rule to update

item type

Example

Code Block

language	js

/aspire/_aspire/workflows/types/applications

Response

Code Block

language	js

{
    items: [{
			  "id": "AAABcID5GBc="
			  "type": "application",
        	  "description": "Application_1",
          	  "workflow": {
coordinates": "com.accenture.aspire:aspire-example-app"
            },
            {
			  "id": 	"AAABcIueWUcAAABcID5GBd=",
	 		  "type": "descriptionapplication":,
 "Publish to Elasticsearch"
    "rule": {
      "iddisplay": "ddSWeq123Application_2",
      "description": "Some rule",
      "typecoordinates": "application",com.accenture.aspire:aspire-example-app"
      ...
    }
  }]
}

Status

Response code	Description
200	Success
404	Not found - a given workflow identifier was not found
406	Not acceptable - there was an issue validating the input

Section

Description
200	Success

Examples

Delete multiple workflows

Section

Get connector type dxf

Returns the dxf for a specific workflow item type

Delete workflow rule(s)

Delete one or more workflows from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE GET /aspire/_api/workflows/:id/rule

DELETE /aspire/_api/workflows/:id/rule/:ruleId

Path and Query String Parameters

Name Type Required Description

id

string

Required

The identifier of the workflow from which to delete rule(s) or the identifier of the rule to delete when used in the body

ruleId string Required The identifier of the rule to delete

Code Block

language	js

DELETE /aspire/_api/workflows/AAABcID5GBc%3D/rule?id=AAABcID5GBc=&id=AAABcIueWUc=

itemType/:itemTypeId/dxf

Response

Code Block

language	js

{
  "dxf": {...}
  "message": "optional response message"
}

Status

Response code	Description
200	Success
404	Not found - a given service identifier was not found

Not acceptable - there was an issue validating the input

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

Some endpoint queries require a filter. A filter is basically a JSON object with the following format:

Credentials filter:Response

Code Block

language	js

  "filter" : {
    "ids" : ["ID1", "ID2", "ID3", ...],
    "type" : "TYPE",
    "messagedescription" : "optionalDESCRIPTION"
 response message"}
}

Status

Note
When using endpoints that use this filter, the filter cannot be empty: at least one field of the filter must be specified.

Response code

Description

200

Success

404

Not found - a given workflow identifier was not found

406

Page tree

Page History

Versions Compared

Old Version 43

New Version 44

Key

Get all workflows

Get

all workflows, filtered

Add a workflow

Get a single workflow

Delete workflow(s)

Add single workflow

Get a workflow event

Delete multiple workflows, filtered

Create workflow event(s)

Delete single workflow

Get a workflow event

Create

workflow event

(s)

Delete a workflow event

Create a workflow event item

Update a workflow event item

Delete a workflow event item

Update a workflow event item

Delete single workflow event item

Move a workflow event item

Get workflow templates

Get all workflow templates, filtered

Get single workflow template

Get single workflow rule

Create a workflow rule

Get workflow templates

Get a workflow template

Update single workflow rule

Delete single workflow rule

Get workflow item types

Create a workflow rule

Get specific workflow items by type

Update a workflow rule

Get connector type dxf

Delete workflow rule(s)

Filters AnchorFiltersAnchorFiltersAnchor

Filters
Anchor
FiltersAnchor
FiltersAnchor