Verifying the Content Services GraphQL API deployment

After you deploy and configure the Content Services GraphQL API, you can verify the deployment and test your connection to Content Platform Engine.

To validate the GraphQL deployment:

• Access the GraphQL ping page with basic authentication that uses a login URL like the following examples:

  • https://graphql-<project_name>.<Infrastructure_node_IP_or_hostname>/content-services-graphql/ping

  • https://<Zen_URL>/content-services-graphql/ping

  The product information appears in your browser:

  {
  "Build-Date" : "October 31, 2019 at 16:50",
  "Implementation-Title" : "IBM FileNet Content Services GraphQL API - content-graphql-api",
  "Implementation-Version" : "20191031-1650-415-Administrator",
  "Product-Version" : "5.5.4",
  "Build-Number" : "415"
  }

• If GraphiQL is enabled, you can validate the API connection to your Content Platform Engine.
  If you have basic authentication that is configured, you can access the GraphQL API with your basic authentication by using a login URL like the following examples:

  • https://graphql-<project_name>.<Infrastructure_node_ip_or_hostname>/content-services-graphql

  • https://<Zen_URL>/content-services-graphql

  You can use a query like the following example to test the connection to Content Platform Engine:

  {
    _apiInfo(repositoryIdentifier: "ObjectStore1") {
      buildDate
      buildNumber
      implementationVersion
      implementationTitle
      productVersion
      cpeInfo {
        cpeURL
        cpeUser
        repositoryName
      }
    }
  }

  The value for the repositoryIdentifier is the Content Platform Engine object store name (symbolic name) or ID (GUID). A successful connection provides a return like the following example:

  {
  "data": {
  "_apiInfo": {
  "buildDate": " October 31, 2019 at 16:50 ",
  "buildNumber": "415",
  "implementationVersion": "20190529-0058-198-user123",
  "implementationTitle": "IBM ECM Content Services GraphQL API - content-graphql-api",
  "productVersion": "5.5.4",
  "cpeInfo": {
  "cpeURL": "http://cpe_host:port/wsi/FNCEWS40MTOM/",
  "cpeUser": "CN=Admin,OU=Shared,OU=Engineering,OU=Company123,DC=adam2016,DC=com",
  "repositoryName": "Object Store 1"
  }
  }
  }

• If you encounter an XSRF issue with the cpd URL, see Configuring security against Cross-Site Request Forgery (CSRF).