GraphQL for API endpoints

• GraphiQL is a graphical, interactive, in-browser Integrated development environment (IDE) used to search and interact with the GraphQL server that is similar to Swagger with added functionality.
• GraphQL is used to query API endpoints from the server and is an alternative to REST API with efficient performance capabilities.

1. Create a User access key (UAK).
2. In order to access the GraphQL IDE, you need to have a running instance of HCL™ Accelerate and navigate to the following URL:

   https://my_accelerate:port/graphiql

3. In the upper left hand corner of the browser window, click to set headers and authenticate with HCL™ Accelerate.
4. In the Headers window, enter Authorization in the Header key field.
5. In the Header value field, paste the user access key.
6. Click the Save button.
7. In the upper right hand corner of the browser window, click Docs and three column sections appear on the display. From left to right, the columns consist of the following sections:
   • Query
   • Response
   • Documentation
     Note: In the documentation section, there are the following operation types:

     Operation type	Description
     Query	Used by the client to request data on the server.
     Mutation	Used to create new data and update and delete existing data.
     Subscription	Used to create and support a connection to the server in real time. Subscriptions are event based.

     Note: Each of the aforementioned operation types are links and when you click any in the list, the available FIELDS associated with the types are displayed below.
8. To search for an API endpoint and run a query, perform the following steps:
   • In the documentation section, enter the name of the endpoint in the Search docs field and press enter.
   • Locate and click the required endpoint.
   • Hover over the endpoint name and then click the ADD QUERY button to add the endpoint to the query section.
   • If required, add any parameters to the query.
   • Click either the Run query button in the query section or the Send Request button on the upper right hand corner of the browser window to run the query.
   • In the response section, the results of the query are displayed.

• Normalized metrics
• Metrics files
• Deployment data
• Build data

curl -X POST "https://localhost/api/v1/metrics" \
      -H "accept: application/json" \
      -H "Authorization: UserAccessKey my_access_key" \
      -H "Content-Type: application/json" \
      -k \
      -v \
      -d '{
            "tenantId": "5ade13625558f2c6688d15ce",
            "dataSet": "Tutorial data set",
            "record": {
              "metricDefinitionId": "AVG_BUILD_DURATION",
              "recordName": "My tutorial record",
              "pluginType": "plugin",
              "dataFormat": "custom",
              "executionDate": 1570028414997,
              "value": {
                "BuildDuration": 199
              },
              "description": "Tutorial data record"
            },
            "application": {
              "name": "Metric Tutorial"
            }
          }'

curl --request POST \
--url https://my_accelerate:port/api/v1/metrics/upload \
-H "Authorization: UserAccessKey my_access_key" \
-F file=@junit.xml \
-F 'payload={
"tenantId": "my_tenant_ID",
"dataSet": "Feb",
"application":
{ "name": "my App22" }

,
"environment": "Prod",
"record":
{ "metricDefinitionId": "Functional Tests", "pluginType": "junitXML", "dataFormat": "junitXML" }

}
' \
-k