| Anchor | ||||
|---|---|---|---|---|
|
Environments Workflow executions can be accessed and modified through this API using GET this allows for the retrieval of workflow executions and there logs.
Authentication - Use Basic Authentication for this API.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/workflowexecution/{workflowExecutionId} |
...
This GET service will find an environment execution with the given Id and return the JSON representation of the object.
...
Parameter | Type | Required | Description |
|---|---|---|---|
| workflowExecutionId | URL | Yes | This is a URL parameter for the Id which is used to find and return an environmentexecution. |
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Workflow Execution was found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Workflow Execution not found |
| 500 | Unexpected internal server error |
...
The GET request would return the following JSON environment execution object
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"workflowVersionId": 228650,
"workflowState": "<State Info>",
"parentWorkflowExecutionId": null,
"dockerImageName": null,
"projectWorkflowId": 4113,
"predeployWorkflowExecId": null,
"createdOn": "2022-03-21T17:58:30.933+0000",
"createdBy": "fdadmin",
"updatedOn": "2022-03-21T17:58:40.085+0000",
"updatedBy": "fdadmin",
"versionNumber": 7,
"reviewStatus": null,
"endTime": "2022-03-21T17:58:40.071+0000",
"abortedBy": null,
"abortedOn": null,
"workflowExecutionId": 1174966,
"executionStatus": "Success",
"workflowType": "DEPLOY",
"startTime": "2022-03-21T17:58:32.500+0000",
"workflowRequestId": 268609,
"projectId": 4107,
"environmentId": 11595,
"projectVersionId": 1966876,
"workflowId": 4126,
"instanceId": 4204
} |
...
GET (Using Query Parameters)
This GET service will return a list of environments executions in the form of JSON objects based on the query parameters code and name. Environments Executions 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 environmentsexecutions.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/workflowExecution? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:workflowExecutionId={workflowExecutionId} workflowRequestId={workflowRequestId} |
...
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Matching Workflow Executions returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 500 | Unexpected internal server error |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"workflowVersionId": 228650,
"workflowState": "<State Info>",
"parentWorkflowExecutionId": null,
"dockerImageName": null,
"projectWorkflowId": 4113,
"predeployWorkflowExecId": null,
"createdOn": "2022-03-21T17:58:30.933+0000",
"createdBy": "fdadmin",
"updatedOn": "2022-03-21T17:58:40.085+0000",
"updatedBy": "fdadmin",
"versionNumber": 7,
"reviewStatus": null,
"endTime": "2022-03-21T17:58:40.071+0000",
"abortedBy": null,
"abortedOn": null,
"workflowExecutionId": 1174966,
"executionStatus": "Success",
"workflowType": "DEPLOY",
"startTime": "2022-03-21T17:58:32.500+0000",
"workflowRequestId": 268609,
"projectId": 4107,
"environmentId": 11595,
"projectVersionId": 1966876,
"workflowId": 4126,
"instanceId": 4204
} |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"workflowVersionId": 228650,
"workflowState": "<State Info>",
"parentWorkflowExecutionId": null,
"dockerImageName": null,
"projectWorkflowId": 4113,
"predeployWorkflowExecId": null,
"createdOn": "2022-03-21T17:58:30.933+0000",
"createdBy": "fdadmin",
"updatedOn": "2022-03-21T17:58:40.085+0000",
"updatedBy": "fdadmin",
"versionNumber": 7,
"reviewStatus": null,
"endTime": "2022-03-21T17:58:40.071+0000",
"abortedBy": null,
"abortedOn": null,
"workflowExecutionId": 1174966,
"executionStatus": "Success",
"workflowType": "DEPLOY",
"startTime": "2022-03-21T17:58:32.500+0000",
"workflowRequestId": 268609,
"projectId": 4107,
"environmentId": 11595,
"projectVersionId": 1966876,
"workflowId": 4126,
"instanceId": 4204
}
]
|
...
Parameter | Type | Required | Description |
|---|---|---|---|
| workflowExecutionId | URL | Yes | This is a URL parameter for the Id which is used to find and return an environmentexecution |
Result
logs.zip contains a folder named after the endpoint Id and then zero or more text files “PluginLogs_<Request_Id>_<Project_Id>.txt”
...