Where can i find the API vaules avilebale for event.deployment.deploymentProperties.state

Compass
1

Hi
Trying to push (manually at this point) historical events into compass activity via API.
Where can I find the optional values for: “event.deployment.deploymentProperties.state”
(besides PENDING)

    "event": {
        "deployment": {
            "updateSequenceNumber": 3,
            "displayName": "text",
            "description": "version hotfix",
            "url": "https://xxx.url.com",
            "lastUpdated": "2023-06-11T13:15:00Z",
            "externalEventSourceId": "xxx-manual",
            "deploymentProperties": {
              "sequenceNumber": 3,
              "state": "PENDING",   <--------here

Thanks

1 Like
2

Hi @shays, and welcome to the community!

That’s indeed not easily discoverable, even though everything is documented in principle. Compass is built atop a GraphQL schema, and while this implies well documented types that enable IDE type inference and inspection, the GraphQL API reference as such is not as accessible as it should be.

Notably it lacks deep links at the level you are asking for, but starting from mutations_createCompassEvent, you can click through the inline dialog to reach CompassCreateEventInput → CompassEventInput → CompassCreateDeploymentEventInput → CompassCreateDeploymentEventPropertiesInput → CompassDeploymentEventState.

If you already know or can guess the type you are looking for, an alternate path is to use the GraphQL API toolkit reference, which documents the enumeration CompassDeploymentEventState directly.

Property Name Default value Description
Cancelled CANCELLED
Failed FAILED
InProgress IN_PROGRESS
Pending PENDING
RolledBack ROLLED_BACK
Successful SUCCESSFUL
Unknown UNKNOWN
2 Likes