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

toc

Easy Heading Free

titleExpandClickable	true
navigationTitle	On this Page
navigationExpandOption	expand-all-by-default

: 200

Section

List

Get all workflows

Lists all the workflows configured in the Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflowworkflows

Pagination query string parameters

Sorting query string parameters

Query String Parameters

descriptionstring

Name	Type	Required	Description
sparse	boolean	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

Response

Section

Get all workflows, filtered

Lists workflows configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/getAll

Pagination query string parameters

Sorting query string parameters

Common filter

Response

Code Block

language	js

{
  "workflow": [{

Code Block

language	js

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

Status

Response code Description

Success

: 200, 404

Section

Get a single workflow

Get information about a single workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflowworkflows/:id

Path Parameters

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

Query String Parameters

Name	Type	Required	Description
transform	boolean	Optional	Whether to transform the output. Default "false"
section	string	Optional	The section required for the output. The value can be "templates", "rules", "events"

Response

Code Block

language	js

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

Status

Response code Description

200 Success

404 The given workflow id was not found

Section

Add single

Section

Add a

workflow

Adds a single workflow to Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflowworkflows

Request Body Parameters

Name	Type	Required	Description
description	string	Required	A description of the workflow

Query String Parameters

Name

Type

Required

Description

type

stringempty

boolean

Optional

Required

Accepted values are: "connector" and "service"

If connector is set If true, the workflow created will be empty ( with no plans).By default, the following plans events will be created:

onScan
onAddUpdate
onDelete
onPublish
onError

Examples

Add a single workflow

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

Example

Code Block

language	js

POST /aspire/_api/workflows?type=connector
{
  "description": "Publish to Elastic"
  ...
}

Response

Code Block

language	js

{
  "serviceworkflow": {
    "id": "AAABcID5GBc=",
    "description": "Publish to Elastic",
    "type": "connector"
    ....
  },
  "message": "optional response message"
}

Status

Response code Description

201 Created

406 Not acceptable - there was an issue validating the input

Section

: 200, 406

Section

Update workflows, filtered

Update connectors configured in the Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed

Delete workflow(s)

Delete one or more workflow from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE PUT /aspire/_api/serviceworkflows/:id

DELETE /aspire_api/service

Path and Request Body Parameters

Name Type Required Description

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

updateAll

Common filter

Update body parameter

Response

Code Block

language	js

Examples

Delete a single workflow

Code Block

language	js

{
  "idmessage": "AAABcID5GBc=update result response message"
}

Status: 200, 406

Section

Delete multiple workflows

Code Block

language	js

[{
  "id": "AAABcID5GBc="
},
{
  "id": "AAABcIueWUc="
}]

, filtered

Delete multiple workflows from Aspire, filtered by a specified criteria, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/deleteAll

Common filter

ResponseDelete multiple workflows(alternative form)

Code Block

language	js

{
  "idmessage": ["AAABcID5GBc=", "AAABcIueWUc="]
}

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

"delete result response message"
}

Status: 200, 404, 406

Section

Delete workflow(s)

Delete one or more workflows from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflows/:id

DELETE /aspire/_api/workflows

POST /aspire/_api/workflows/delete

Path Parameters and Query parameters

Section

Get a workflow plan

Get a plan from a workflow in Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id/:planId

Path Parameters

string

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

Body Parameter

Name	Type	Required	The identifier of the plan to get		Description
ids	string	Required	The identifier(s) of the workflow(s) to delete

ExamplesResponse

Code Block

language	js

DELETE /aspire/_api/workflows/AAABcID5GBc

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

POST /aspire/_api/workflows/delete
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js

{{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate"
    }
  }
  "message": "optionaldelete result 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

: 200, 404, 406

Section

Get a workflow event

Get a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed

Create workflow plan(s)

Create one or more workflow plans in Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT GET /aspire_api/workflow/:idPUT /aspire_api/workflowworkflows/:id/:planIdeventId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to add a plan toreturn
eventIdplanId	string	Required	The identifier of the plan event to add

Examples

get

ResponseCreate a single plan

Code Block

language	js

{
  "idworkflow": "onScan"
}

Create multiple plans

Code Block

language	js

[{
{
    "id": "onScanAAABcIueWUc="
},
{
    "iddescription": "onAddUpdate"
}]

Create multiple plans (alternative version)

Code Block

language	js

Publish to Elasticsearch"
    "event": {
      "id": ["onScan", "onAddUpdate"]
}

Response

Code Block

language	js

{
  "workflow": {onUpdate"
       ....
    "id": "AAABcIueWUc=",}
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": ["onScan", "onAddUpdate"]
    }
  }
  "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

}
}

Status: 200, 404, 406

Request Body Parameters

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

Response

Section

Get workflow events

Get a event from a workflow in Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/:id

Path

Delete a workflow plan

Delete a workflow plan from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/workflow/:id/:planId

Path and Request Body Parameters

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

Response

Code Block

language	js

{
    "messageworkflow": "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

Create a workflow plan item

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

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/workflow/:id/:planId/:type

Path Parameters

Name Type Required Description

id string Required The identifier of the workflow(s) to return

planId string Required The identifier of the plan to get

type string Required The type of the item to create

Item Type Parameter Name Parameter Type Required Description

Rule <TODO> Application Rule Condition Exit

Code Block

language	js

{
  "workflow": {
 {
        "id": "72022651-c2f4-45a9-9e18-2b0ace529cda",
        "type": "connector",
        "description": "Test Workflow",
        "checksum": "2b8dc08a2da838304528b4695109e2379da9a670c5a195dcd27355e8daa20a8b",
        "events": {
            "event": [
                {
                    "id": "AAABcIueWUc=onScan",
    "description": "Publish to Elasticsearch"
           "plan": {
 },
       "id": "onAddUpdate",
        "rule": {
                    "id": "AAABcQwxWUc=onAddUpdate",
        ...
        },
    }
            }{
  "message": "optional response message"
}

Status

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

Update a workflow plan item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire_api/workflow/:id/:planId/:itemId

Path Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow(s) to useplanIdstringRequired

The identifier of the plan to use

itemIdstringRequiredThe 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 plan item above

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate",
      "rule": {
                "id": "onDelete"
                },
                {
                    "id": "onPublish",
                    "item": {
                        "id": "404fefb7-b7f4-48cf-a7b1-81872587a85b",
                        "type": "reference",
                        "idruleId": "AAABcQwxWUc=5d1273b8-9dc0-4f6d-89f3-fe6f331a6067",
        ...
        }
    }
  }
  "messageenabled": true
  "optional response message"
}

Status

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

Delete a workflow plan item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire_api/workflow/:id/:planId/:itemId

Path Parameters

                 }
                },
                {
                    "id": "onError"
                },
                {
                    "id": "onIdentity"
                },
                {
                    "id": "onIdentityError"
                }
            ]
        }
    }
}

Status: 200, 404, 406

Response

Section

Create workflow event(s)

Create one or more workflow events in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflows/:id

PUT /aspire/_api/workflows/:id/:eventId

Path Parameters

Name Type Required Description

id string Required The identifier of the workflow to use

planId string Required The identifier of the plan to use

itemId string Required The identifier of the node item to delete

Code Block

language	js

{
  "message": "optional response message"
}

Status

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

Move a workflow plan item

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

PUT/aspire_api/workflow/:id/:planId/:src/:dest

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to use
planId	string	Required	The identifier of the plan to use
(s) to add a event to
eventIdsrc	string	Required	The identifier of the plan item event to moveadd
dest	string	Required	The identifier of the new parent for the moved item

Response

Examples

Create multiple events (body parameter)

Code Block

language	js

[{
  "messageid": "optional response messagescan"
},
{
  "id": "addUpdate"
}]

StatusResponse

Response

Code Block

Description

language

200Success404Not found - a given workflow identifier was not found406Not acceptable - there was an issue validating the input Section

js

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

Get workflow templates

Retrieve all workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id/template

Path and Query String Parameters

NameTypeRequiredDescriptionidstringRequiredThe identifier of the workflow to get the templates fordescriptionstringOptionalFilter workflows to only those whose description matches the given expression

Response

Code Block

language	js

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

Status

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

}
  }
}

Status: 200, 404, 406

Section

Delete a workflow event

Delete a workflow event from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed

Get a workflow template

Retrieve a workflow templates from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET DELETE /aspire/_api/workflowworkflows/:id/template/:templateIdeventId

Path Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow to get the templates for(s) to use
eventIdtemplateId	string	Required	The identifier of the template event to getdelete

Response

Code Block

language	js

{
  "templatemessage": [{
      "id": "AAABcQwrWUc",
      ...
    }]
  "message": "optional "delete result 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

: 200, 404, 406

Response

Section

Create a workflow event item

Create a workflow event item - a rule, condition and the like, this endpoint need the at least the ADMINISTRATOR role to be executed

Get workflow plan rules

Get all the rules for a given workflow.

Panel

borderColor	black
bgColor	#fafafb

GET POST /aspire/_api/workflowworkflows/:id/:eventId/rule:type

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to return rules for

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate",
      "rule": [{
        "id": "ddSWeq123",
        "description": "Some rule",
        "type": "application",
        ...
      },
      {
        "id": "ddSWeq124",
        "description": "Some rule",
        "type": "groovy",
        ...
      }]
    }
  }
  "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

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. The valid parents for reference items are the root node, items of the type condition or references which ruleId is for a rule of type "folder"
	orderId	integer	Required	The position (which in the children of the parent node) where this reference should be inserted. For example 0 means at the beginning, in the case of using a number greater than the current number of children within the parent node the item will be inserted at the end
	ruleId	String	Required	The rule to be referenced, it must exist
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
condition	parentId	string	Required	The identifier of the node in to which the item should be inserted. The valid parents for condition items are references which ruleId is for a rule of type "choice".
	value	object	Required	The value to be compared against
	conditionType	String	Required	The value type, possible types are "string", "boolean", "integer", "long", "double", "float"
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
	template	String	Required	The condition template id.
exit	parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node. The valid parents for exit items are the root node, items of the type condition or references which ruleId is for a rule of type "folder"
	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="

Get a workflow plan rule

Delete one or more services 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

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "planevent": {
      "id": "onAddUpdate",
      "rule": {
        "id": "ddSWeq123AAABcQwxWUc=",
        "description": "Some rule",
...
      }
    "type": "application",}
        ...
      }
    }
  }
  "message": "optional response message"
}

Status

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

}
}

Status: 200, 404, 406

Request Body Parameters

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

Response

Section

Update a workflow event item

Update a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed

Create a workflow rule

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

POST PUT /aspire/_api/workflowworkflows/:id/rule:eventId/:itemId

Path Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow(s) to create a rule forreturn
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 rule item created. Some examples are shown below

Rule

Item Type	Parameter Name	Parameter Type	Required	Description

groovy

reference

<TODO>

parentId

application

string

Response

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate",
      "rule": {
        "id": "ddSWeq123",
        "description": "Some rule",
        "type": "application",
        ...
      }
    }
  }
  "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

Required	The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent.
	ruleId	String	Optional	The rule to be referenced, it must exist
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
condition	parentId	string	Required	The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent.
	value	object	Optional	The value to be compared against
	type	String	Optional	The value type, possible types are "string", "boolean", "integer", "long", "double", "float"
	enabled	boolean	Optional	Whether or not the item is enabled (default true)
	template	String	Optional	The condition template id.
exit	parentId	string	Required	The identifier of the parent node of the item to update. The parent cannot be updated using this method, use the move event item method to change the parent.
	enabled	boolean	Optional	Whether or not the item is enabled (default true)

Response

Code Block

language	js

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

Update a workflow rule

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire_api/workflow/: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

Code Block

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "planevent": {
      "id": "onAddUpdate",
      "rule": {
        "id": "ddSWeq123AAABcQwxWUc=",
        "description": "Some rule",
        "type": "application",
        ...
      }
    }
  }
  "message": "optional response message"
}

Status

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

: 200, 404, 406

Status

Section

Delete single workflow event item

Delete a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed

Delete workflow rules <<<<

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET DELETE /aspire/_api/workflowworkflows/:id/:planIdeventId/:parentId/:itemId

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow (s) to returnuse
planIdeventId	string	Required	The identifier of the plan event to getuse

Response

parentId

code

string

language	js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate"
    }
  }
  "message": "optional response message"
}

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

Required	The identifier of the node with the item to be deleted
itemId	integer	Required	The identifier of the item to delete

Response

Code Block

language	js

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Status

Section

Move a workflow event item

Move a workflow event item from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

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

Path

Copy or Share workflow rules <<<<

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id/:planId

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow (s) to returnuse
planIdeventId	string	Required	The identifier of the plan event to getuse

ResponseBody Parameters

code

Name

language

Type

js

{
  "workflow": {
    "id": "AAABcIueWUc=",
    "description": "Publish to Elasticsearch"
    "plan": {
      "id": "onAddUpdate"
    }
  }
  "message": "optional response message"
}

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

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
orderId	integer	Optional	The position (which in the children of the parent node) where this item should be inserted. For example 0 means at the beginning, in the case of using a number greater than the current number of children within the parent node the item will be inserted at the end. If no provided the item will be moved at the end of the children list of the new parent.

Response

Code Block

language	js

{
  "message": "move result response message"
}

Status: 200, 404, 406

Section

Get workflow templates

Retrieve all workflow templates from Aspire, this endpoint need the at least the OPERATOR role to be executed.

Get workflow libraries <<<<

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflowworkflows/:id/:planIdtemplates

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow (s) to return
planId	string	Required	The identifier of the plan to get

Response

to get the templates for

Response

Code Block

language	js

Code Block

language	js

{
  "workflowtemplate": [{
      "id": "AAABcIueWUc=AAABcQwrWUc",
    "description": "Publish to Elasticsearch" ...
    "plan": {
  },
	    "id": "onAddUpdateAAABcQwrWUd",
    }
  }...
  "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

: 200, 404, 406

Section

Get single workflow template

Retrieve a single workflow templates from Aspire, this endpoint need the at least the OPERATOR role to be executed

Get a workflow library <<<<

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflowworkflows/:id/template/:planIdtemplateId

Path and Request Body Parameters

Name	Type	Required	Description
id	string	Required	The identifier of the workflow (s) to returnto get the templates for
templateIdplanId	string	Required	The identifier of the plan template to get

Response

Code Block

language	js

{
  "template": [{
      "id": "AAABcQwrWUc",
      ...
    }]
}

Status: 200, 404, 406

Section

Get single workflow rule

Get a single workflow rule from Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/: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",
      ...
    }
  }
}

Status: 200, 404, 406

Section

Get workflow rules

Get workflow rules from Aspire, this endpoint need the at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/:id/rules

Path Parameters

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

Response

Code Block

language	js

{
    "workflow": {
        "id": "72022651-c2f4-45a9-9e18-2b0ace529cda",
        "type": "connector",
        "description": "Test Workflow",
        "checksum": "2b8dc08a2da838304528b4695109e2379da9a670c5a195dcd27355e8daa20a8b",
        "rules": {
            "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067": {
                "appName": "Publish_To_File",
                "config": "com.accenture.aspire:app-publish-to-file",
                "type": "application",
                "description": "Publish to File",
                "properties": {
                    "debug": "false",
                    "logFileType": "true",
                    "logFile": "${app.name}/publishToFile.jobs",
                    "numJobs": 5
                },
                "id": "5d1273b8-9dc0-4f6d-89f3-fe6f331a6067"
            }
        }
    }
}

Status: 200, 404, 406

Section

Create a workflow rule

Create a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/workflows/: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.

Rule Type	Parameter Name	Parameter Type	Required	Description
application	type	string	Required	The rule type, in the case of application the value must be "application"
	description	string	Required	The rule description. Any spaces will be replaced with "_" after creation
	config	string	Required	The maven coordinates of the rule application
	properties	object	Optional	A nested JSON object that contains any additional property required by the application. The properties will vary depending of the application.
	enabled	boolean	Optional	Whether or not the rule is enabled (default true)
	*appType	string	Optional	This field is only required if Aspire will be used with the UI. This field is used to associate the rule to the proper dxf from the resource manager
	*_type	string	Optional	This field is only required if Aspire will be used with the UI.
template	type	string	Required	The rule type, in the case of rules based on templates, type must match the type of the template, for example if the template type is "choice" the rule type also must be "choice"
	template	string	Required	The id of the template to use for the rule
	properties	object	Optional	A nested JSON object that contains any additional property required by the template. The properties will vary depending of the template.
	enabled	boolean	Optional	Whether or not the rule is enabled (default true)
custom	type	string	Required	The rule type, in the case of custom rules the value must be "custom"
	description	string	Required	The rule description. Any spaces will be replaced with "_" after creation
	script	string	Required	The custom groovy script to execute.

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

Parameter Name	Parameter Type	Required	Description
parentId	string	Optional	The identifier of the node in to which the item should be inserted. Defaults to the root node
orderId	integer	Optional	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": {
      "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: 200, 404, 406

Section

Update single workflow rule

Updatee a single workflow rule in Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

PUT /aspire/_api/workflows/: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

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=",
    "description": "Publish to Elasticsearch"
    "rule": {
      "id": "ddSWeq123",
      "description": "Some rule",
      "type": "application",
      ...
    }
  }
}

Status: 200, 404, 406

Section

Delete single workflow rule

Deletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

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)
ruleId	string	Required	The identifier of the rule to delete

Response

Code Block

language	js

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Section

Delete workflow rules

Deletes a single workflow rule from Aspire, this endpoint need the at least the ADMINISTRATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

DELETE /aspire/_api/workflows/:id/rules

Path Parameters

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

Query Parameters

Name	Type	Required	Description
id	string	Required	One or more rule ids to be deleted

Response

Code Block

language	js

{
  "message": "delete result response message"
}

Status: 200, 404, 406

Section

Export workflow(s)

Export one or more workflows from Aspire, this endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire/_api/workflows/export

GET /aspire/_api/workflows/export/:id

POST /aspire/_api/workflows/exportAll

Info

Every configuration item has the option to export from the UI, using the single menu or by the bulk actions:

Image AddedImage Added

Note
Something important that you need to know is that when you export a config item that depends on another, the export will contain also all the dependencies.

Note
Take into consideration that components with resources loaded into elastic, will be exported, but the resource itself will not, so you will need to reupload the resource and go and select your resource in the component again.

Path Parameters and Query parameters

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

Body Parameter

Name	Type	Required	Description
ids	string	Required	The identifier(s) of the workflow(s) to export

Examples

Code Block

language	js
theme	RDark

GET /aspire/_api/workflows/export/AAABcID5GBc

DELETE /aspire/_api/workflows/export?id=AAABcID5GBc&id=AAABcID5GBd

POST /aspire/_api/workflows/export
{
  "ids":["AAABcID5GBc","AAABcID5GBd"]
}

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkflow",          
          "templates": {
            "template": [
              ...
            ]
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules": {
            "rule": [
              ...
            ]
          }
        }
      ]
    }
  }
}

Status: 200, 404, 406

Section

Export multiple connections, filtered

Export multiple connections from Aspire, filtered by a specified criteria, this endpoint needs at least the OPERATOR role to be executed.

Panel

borderColor	black
bgColor	#fafafb

POST /aspire/_api/connections/exportAll

Filters: The connection filter definition here

Response

Code Block

language	js
theme	RDark

{
  "export": {
    "workflows": {
      "workflow": [
        {
          "id": "<workflow_id>",
          "type": "connector",
          "description": "myWorkflow",          
          "templates": {
            "template": [
              ...
            ]
          },
          "events": {
            "event": [
              ...
            ]
          },
          "rules

Code Block

language	js

{ "workflow

": {

"id

        "rule":

"AAABcIueWUc=",

"description": "Publish to Elasticsearch"

...

"plan":

{

"id": "onAddUpdate"

 ]
          }
        }

"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

    ]
    }
  }
}

Status: 200

Section

Import

The import usage can be found here

Response

Section

Filters
Anchor
FiltersAnchor
FiltersAnchor

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

Seed filter:

Section

Reload workflow libraries <<<<

?? Needed?????

Delete one or more services from Aspire.

Panel

borderColor	black
bgColor	#fafafb

GET /aspire_api/workflow/:id/:planId

Path and Request Body Parameters

Name Type Required Description

id string Required The identifier of the workflow(s) to return

planId string Required The identifier of the plan to get

Code Block

language	js
theme	RDark

{ 
  "workflowfilter" : {
    "idids" : "AAABcIueWUc=",["ID1", "ID2", "ID3", ...],
    "descriptiontype" : "Publish to ElasticsearchTYPE",
    "plandescription" : {"DESCRIPTION",
      "id""deleteIncrementalPolicy": "deletePolicyId",
	"credentials" : "onAddUpdatecredentialId",
	"throttlePolicy"    }
  }
  "message": "optional response message"
}

Status

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

: "throttlePolicyId",
	"routingPolicies" : ["RP1", "RP2", "RP3", ...]
  }
}

Page tree

Page History

Versions Compared

Old Version 6

New Version Current

Key

Get all workflows

Get all workflows, filtered

Get a single workflow

Add single

workflow

Update workflows, filtered

Delete workflow(s)

Delete multiple workflows

, filtered

Delete workflow(s)

Get a workflow plan

Get a workflow event

Create workflow plan(s)

Get workflow events

Delete a workflow plan

Create a workflow plan item

Update a workflow plan item

Delete a workflow plan item

Create workflow event(s)

Move a workflow plan item

Get workflow templates

Delete a workflow event

Get a workflow template

Create a workflow event item

Get workflow plan rules

Get a workflow plan rule

Update a workflow event item

Create a workflow rule

Update a workflow rule

Delete single workflow event item

Delete workflow rules <<<<

Move a workflow event item

Copy or Share workflow rules <<<<

Get workflow templates

Get workflow libraries <<<<

Get single workflow template

Get a workflow library <<<<

Get single workflow rule

Get workflow rules

Create a workflow rule

Update single workflow rule

Delete single workflow rule

Delete workflow rules

Export workflow(s)

Export multiple connections, filtered

Import

Filters AnchorFiltersAnchorFiltersAnchor

Reload workflow libraries <<<<

Filters
Anchor
FiltersAnchor
FiltersAnchor