Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
Top

Environments Workflow executions can be accessed and modified through this API using GET this allows for the retrieval of workflow executions and there logs.

...

Most functions return a JSON workflow execution object. The workflow execution object has these attributes:

AttributesTypeDescription
workflowExecutionIdLongThis is the unique id of the workflow execution
dockerImageNameStringThis is the name of the docker image
environmentIdLongThis is the unique Id of the environment
executionStatusStringThis is the status of the execution i.e. Success, Failure, Running
instanceIdLongThis is the unique Id of the instance
parentWorkflowExecutionIdLongThis is the unique id of a parent execution, if one exists
predeployWorkflowExecutionIdLongThis is the unique id of a pre-deploy execution, if one was used
projectIdLongThis is the unique Id of the project
projectVersionIdLongThis is the unique Id of the project version
projectWorkflowIdLongThis is the unique Id of the project workflow
endTimeTimestampThis is the time the execution ended, if it has ended
startTimeTimestampThis is the time the execution started
workflowRequestIdLongThis is the unique id of the workflow request
workflowVersionIdLongThis is the unique id of the workflow version
createdOnTimestampThis is the time the execution was created
createdByStringThis is the user who created the execution
updatedOnTimestampThis is the time the execution was updated
updatedByStringThis is the user who updated the execution last
versionIntegerThis the version number of the execution
workflowStateStringThis is the state of the workflow


Back to Top

...


GET

There are two implementations of GET. One will find a workflow execution with the given Id and return the JSON representation of the workflow execution. The other will find a list of workflow executions matching the parameters supplied to it.

...

Info
titleAPI URL

http://host:port/flexdeploy/rest/v1/workflowexecution/{workflowExecutionId}

Parameters


Parameter

Type

Required

Description

workflowExecutionIdURLYesThis is a URL parameter for the Id which is used to find and return an environment


Example

If we had an workflow execution in our database with an Id of 1110091 and had the following attributes

...

GET (Using Query Parameters)

This GET service will return a list of environments in the form of JSON objects based on the query parameters code and name. Environments are only returned if they match all of the specified query parameters. If no query parameters are given this request will return the entire list of environments.


Info
titleAPI URLs

http://host:port/flexdeploy/rest/v1/topology/workflowExecution?

...

Tip

The query parameters are not case sensitive. Searching by name=NAME is the same as searching by name=name.

Parameters

Parameter

Type

Required

Description

workflowRequestId

URLNoThis is a URL query parameter for the workflowRequestId which is used to search the workflow executions.

Example

If we had a workflow execution in our database with an Id of 1110091 and had the following attributes

...

Info

http://host:port/flexdeploy/rest/v1/workflowexecution/{workflowExecutionId}/logs

Parameters

Parameter

Type

Required

Description

workflowExecutionIdURLYesThis is a URL parameter for the Id which is used to find and return an environment

Result

logs.zip contains a folder named after the endpoint Id and then zero or more text files “PluginLogs_<Request_Id>_<Project_Id>.txt”

...