API Schema and Structure
Harness' schema determines what parameters your queries can specify as arguments, and what data can be returned.
Following GraphQL conventions, Harness schema is represented in terms of fields, types, enums, nodes, edges, and connections.
note
The ! following the type means that this field is required.
Before You Begin
Fields
The Harness API's schema includes fields representing the following Harness entities. Note that many of these <entityId> or <entity> fields are also transformed within the schema into an <entity>Aggregation, <entity>Connection, and/or <entity>Filter. Use the API Explorer's search box to discover the available fields and their usage.
| Field Name | Harness Entity/Notes |
applicationId | Harness Application. |
serviceId | Harness Service. |
environmentId | Harness Environment. |
workflowId | Harness Workflow. |
pipelineId | Harness Pipeline. |
executionId | A Harness deployment (execution). |
artifactId | Artifact deployed via Harness. |
cloudProviderId | Cloud Provider configured in Harness. |
Instance | Instance deployed via Harness. |
connectorId | Connector configured in Harness. |
description | Description of a Workflow, Pipeline, etc. |
id | Unique ID of a Harness entity. |
name | Name of a Workflow, Pipeline, etc. |
total | Total number of a parent Harness entity. |
status, ExecutionStatus | Deployment's execution status. |
createdAt | Time when deployment was queued in Harness. |
startedAt | Time when deployment's execution began. |
TimeSeriesAggregation | Used to group returned statistics (on deployments, instances, etc.) by time. |
TriggerFilter | One or more Harness Triggers. |
limit | Pagination throttler. |
offset | Pagination pointer. |