Workflows

Workflows describe the process of executing and integrating source code. We will see how to get the list of workflows and their properties.

The workflows model

The workflows model contains essential information about the execution and integration of the source code of a project, team, and developer.

Properties

Name
id
Type
string
Description
Unique identifier for the workflow.
Name
name
Type
string
Description
The name for the workflow.
Name
headBranch
Type
string
Description
The head branch for the workflow.
Name
runNumber
Type
integer
Description
The run number for the workflow.
Name
status
Type
string
Description
The status for the workflow.
Name
htmlUrl
Type
string
Description
The url for the workflow.
Name
createdAt
Type
timestamp
Description
Timestamp of when the commit was created.
Name
updatedAt
Type
timestamp
Description
Timestamp of when the commit was updated.
Name
actor
Type
object
Description
Author of workflow.
Name
triggeringActor
Type
object
Description
Triggering author of workflow.
Name
repositoryName
Type
string
Description
The name of the repository.
Name
repositoryId
Type
string
Description
The id of the repository.
Name
provider
Type
string
Description
The name of the provider.

GET/api/dashboard/workflows

List all workflows

Request

GET

/api/dashboard/workflows

curl -G https://api.pulzen-gateway/api/dashboard/workflows \
  -H "Authorization: Basic {token}"

Response

{
    "id": "9259484620",
    "name": "Deploy service",
    "headBranch": "qa",
    "path": ".github/workflows/deploy-service.yml",
    "displayTitle": "Deploy service",
    "runNumber": 726,
    "event": "workflow_dispatch",
    "status": "in_progress",
    "conclusion": null,
    "workflowId": "59764066",
    "htmlUrl": "https://github.com/CleveritDemo/taylor-frontend/actions/runs/9259484620",
    "createdAt": "2024-05-27T19:30:19Z",
    "updatedAt": "2024-05-27T19:30:38Z",
    "pullRequests": [],
    "actor": {
        "login": "LBrieva"
    },
    "triggeringActor": {
        "login": "LBrieva"
    },
    "runAttempt": 1,
    "repositoryName": "taylor-frontend",
    "repositoryId": "R_kgDOJqnh2w",
    "mergeBy": "LBrieva",
    "provider": "GITHUB",
    "prInfo": {
        "id": "R_kgDOJqnh2w",
        "state": "merged",
        "mergedBy": "LBrieva"
    },
    "pullRequestIds": [
        "160"
    ],
    "firstPr": null
}

Query Parameters:

provider: Can be one of the following: GITHUB, GITLAB, BITBUCKET, AZUREDEVOPS.
dateStart: Format YYYY-MM-DD.
dateEnd: Format YYYY-MM-DD.