GraphQL API Queries

GraphQL is another format to use when making requests to FlexDeploy servers. To get started you will need to download a way to make GraphQL Requests to your FlexDeploy server. Throughout this example we will be using Postman in order to send out GraphQL requests.

Making a Request

First, there are some steps in postman that need to be done before writing a request.

1. Create an HTTP Request

2. Make sure the Request is a POST request

3. Set the URL to the format below, replacing the FLEXDEPLOY_SERVER_HOSTNAME and FLEXDEPLOY_SERVER_PORT with your FlexDeploy server’s hostname and port respectively

   1. http(s)://{{FLEXDEPLOY_SERVER_HOSTNAME}}:{{FLEXDEPLOY_SERVER_PORT}}/flexdeploy/rest/v2/graphql

4. Set up security information under the “Authorization” tab. Either Basic Auth (username and password) or a token can be used here

5. Under the “Body” tab of the request, switch the body format to GraphQL by clicking on the dot next to “GraphQL”

After that is done we can now start to create our request. An example request is provided below.

query envState($where: [WhereInput], $sort: [SortInput], $page: PageInput) {
    reportEnvironmentState(where: $where, sort: $sort, page: $page) {
        next
        hasMore
        items {
            endTime
            environmentName
            executionStatus
            instanceName
            objectPath
            packageName
            partialDeployments
            projectName
            projectVersionName
            projectWorkflowType
        }
    }
}

Variables

There are three main variables to use with FlexDeploy GraphQL queries: where, sort, and page.

input WhereInput {
  field: String!
  type: WhereTypeEnum!
  innerWhere: [WhereInput!]
  value: String
}

enum WhereTypeEnum {
  eq
  ne
  eqi
  gt
  lt
  inc
  inci
  ninc
  btwn
  rel
  empty
  nempty
}

input SortInput {
  field: String!
  direction: SortEnum
}

enum SortEnum {
  asc
  desc
}

input PageInput {
  limit: Int
  offset: Int
}

All of the above variables object above are then bundled together in on variable object. It is not required to always include all three variables in the object. For example, if you wanted to only filter and not sort, you would only need to include the where variable. Below is an example of the combined variable object with all three variables used.

{
    "sort": [
        {
            "field": "projectName",
            "direction": "asc"
        }
    ],
    "where": [
        {
            "field": "environmentName",
            "type": "eqi",
            "value": "QA"
        },
        {
            "field": "projectWorkflowType",
            "type": "eq",
            "value": "DEPLOY"
        }
    ],
    "page": { 
        limit: 20 
    }
}

Selection Set

The biggest difference between GraphQL and REST is the option selection of elements to be returned in a query. This can make queries return faster if only the information that is needed by the query is returned. This is called a subselection set. In our above example we can see we have this block of text:

items {
            endTime
            environmentName
            executionStatus
            instanceName
            objectPath
            packageName
            partialDeployments
            projectName
            projectVersionName
            projectWorkflowType
        }

Here is where we can control what is being returned in the query. GraphQL will only return fields present in the subselection.

Example Queries: