Resources

Solution Instances

Solution Instances are the end user's configuration of your Solutions. Instances contain their own auths and config data.

Get solution instances (user/master token)

Type: Query

Operation: get-solution-instances

Request Examples

{
  "query": "query ($ownerId: String!){\n\tviewer {\n\t\tsolutionInstances(criteria: { owner: $ownerId }) {\n\t\t\tedges {\n\t\t\t\tnode {\n\t\t\t\t\tid\n\t\t\t\t\tname\n\t\t\t\t\tenabled\n\t\t\t\t\towner\n\t\t\t\t\tcreated\n\t\t\t\t\tsolutionVersionFlags {\n\t\t\t\t\t\thasNewerVersion\n\t\t\t\t\t\trequiresUserInputToUpdateVersion\n\t\t\t\t\t\trequiresSystemInputToUpdateVersion\n\t\t\t\t\t}\n\t\t\t\t\tworkflows {\n\t\t\t\t\t\tedges {\n\t\t\t\t\t\t\tnode {\n\t\t\t\t\t\t\t\ttriggerUrl\n\t\t\t\t\t\t\t\tid\n\t\t\t\t\t\t\t\tsourceWorkflowId\n                                sourceWorkflowName\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t\tauthValues {\n\t\t\t\t\t\texternalId\n\t\t\t\t\t\tauthId\n\t\t\t\t\t}\n\t\t\t\t\tconfigValues {\n\t\t\t\t\t\texternalId\n\t\t\t\t\t\tvalue\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\tcursor\n\t\t\t}\n\t\t\tpageInfo {\n\t\t\t\tstartCursor\n\t\t\t\tendCursor\n\t\t\t\thasNextPage\n\t\t\t\thasPreviousPage\n\t\t\t}\n\t\t}\n\t}\n}",
  "variables": {
    "ownerId": "13b3ab9c-XXXX-XXXX-XXXX-c4dd07fbbfa4"
  }
}

Response Examples

{
  "data": {
    "viewer": {
      "solutionInstances": {
        "edges": [
          {
            "node": {
              "id": "533d48e8-XXXX-XXXX-XXXX-74ff887198d3",
              "name": "Sample Instance",
              "enabled": true,
              "owner": "13b3ab9c-XXXX-XXXX-XXXX-c4dd07fbbfa4",
              "created": "2019-12-03T21:11:09.456Z",
              "solution": {
                "id": "b73d4e07xxx-xxx-xxx-xxx-xxxafad23d94",
                "title": "Slack webhook solution",
                "description": "sends a message to a slack channel of your choice"
              },
              "solutionVersionFlags": {
                "hasNewerVersion": true,
                "requiresUserInputToUpdateVersion": true,
                "requiresSystemInputToUpdateVersion": false
              },
              "workflows": {
                "edges": [
                  {
                    "node": {
                      "triggerUrl": null,
                      "id": "89f8ebeb-XXXX-XXXX-XXXX-be070f3cd0f8",
                      "sourceWorkflowId": "3af6461f-XXXX-XXXX-XXXX-91ada5769f90"
                    }
                  }
                ]
              },
              "authValues": [
                {
                  "externalId": "external_slack_authentication",
                  "authId": "dcbc11f1-XXXX-XXXX-XXXX-b7f90dafcf28"
                }
              ],
              "configValues": []
            },
            "cursor": "NTMzZDQ4ZTgtNjM2Zi00M2FkLTk1ZjItNzRmZjg4NzE5OGQz"
          }
        ],
        "pageInfo": {
          "startCursor": "NTMzZDQ4ZTgtNjM2Zi00M2FkLTk1ZjItNzRmZjg4NzE5OGQz",
          "endCursor": "NTMzZDQ4ZTgtNjM2Zi00M2FkLTk1ZjItNzRmZjg4NzE5OGQz",
          "hasNextPage": false,
          "hasPreviousPage": false
        }
      }
    }
  }
}

Create solution instance (user token)

Type: Mutation

Operation: create-solution-instance

Request Examples

{
  "query": "mutation ($solutionId: ID!, $instanceName: String!){\n   createSolutionInstance(input: {\n       solutionId: $solutionId\n       instanceName: $instanceName\n   }) {\n     solutionInstance {\n       id\n       name\n       enabled\n       created\n       workflows {\n           edges {\n               node {\n                   id\n                   triggerUrl\n                   sourceWorkflowId\n               }\n           }\n       }\n     }\n   }\n }",
  "variables": {
    "solutionId": "b3422397-XXXX-XXXX-XXXX-57e7e66771b3",
    "instanceName": "Gene Slack star instance 2"
  }
}

Response Examples

{
  "data": {
    "createSolutionInstance": {
      "solutionInstance": {
        "id": "625xxx-xxx-xxx-xxx-xxx111f",
        "name": "Gene Slack star instance 2",
        "enabled": false,
        "created": "2019-02-25T11:02:21.884Z",
        "workflows": {
          "edges": [
            {
              "node": {
                "id": "98099de2-xxx-xxx-xxx-xxxxxb8ff7",
                "triggerUrl": "https://6a4xxx-xxx-xxx-xxx-xxx-xxxe8eaa2.trayapp.io",
                "sourceWorkflowId": "378xxx-xxx-xxx-xxx-xxx-xxx4fd6"
              }
            }
          ]
        }
      }
    }
  }
}

Update solution instance (user token)

Type: Mutation

Operation: update-solution-instance

Request Examples

{
  "query": "mutation ($solutionInstanceId: ID!, $instanceName: String!, $enabled: Boolean!) {\n  updateSolutionInstance(input: {\n      solutionInstanceId: $solutionInstanceId,\n      instanceName: $instanceName, \n      enabled: $enabled\n  }) {\n    solutionInstance {\n      id\n      name\n      enabled\n      created\n    }\n  }\n}",
  "variables": {
    "solutionInstanceId": "2d38b2ec-xxxx-xxx-xxxx-b4ec68084266",
    "instanceName": "myCustomersSolutionInstanceName",
    "enabled": true
  }
}

Response Examples

{
  "data": {
    "updateSolutionInstance": {
      "solutionInstance": {
        "id": "2d38b2ec-xxxx-xxx-xxxx-b4ec68084266",
        "name": "myCustomersSolutionInstanceName",
        "enabled": true,
        "created": "2019-02-25T11:02:21.884Z"
      }
    }
  }
}

Upgrade solution instance (user token)

Type: Mutation

Operation: upgrade-solution-instance

Request Examples

{
  "query": "mutation ($solutionInstanceId: ID!, $configValues: [ConfigValue!], $authValues: [AuthValue!] ){\n  upgradeSolutionInstance (input: {\n    solutionInstanceId: $solutionInstanceId, \n    configValues: $configValues,\n    authValues: $authValues\n  }) \n    { \n solutionInstance  {\n  id\n  configValues{\n    externalId\n    value\n  }\n  authValues{\n    authId\n    externalId\n  }\n  enabled\n  created\n  }\n }\n}",
  "variables": {
    "solutionInstanceId": "625xxx-xxx-xxx-xxx-xxx111f",
    "configValues": [
      {
        "externalId": "external_support-email",
        "value": "support@example.com"
      }
    ],
    "authValues": [
      {
        "externalId": "external_slack_authentication",
        "authId": "aaa67786-XXXX-XXXX-XXXX-97dedd1519b3"
      }
    ]
  }
}

Response Examples

{
  "data": {
    "upgradeSolutionInstance": {
      "solutionInstance": {
        "id": "625xxx-xxx-xxx-xxx-xxx111f",
        "enabled": true,
        "created": "2019-02-25T11:02:21.884Z",
        "configValues": [
          {
            "externalId": "external_support-email",
            "value": "support@example.com"
          }
        ],
        "authValues": [
          {
            "externalId": "external_slack_authentication",
            "authId": "aaa67786-XXXX-XXXX-XXXX-97dedd1519b3"
          }
        ]
      }
    }
  }
}

Delete Solution Instance (user token)

Type: Mutation

Operation: delete-solution-instance

Request Examples

{
  "query": "mutation ($solutionInstanceId: ID!){\n  removeSolutionInstance(input: {solutionInstanceId: $solutionInstanceId}) {\n   clientMutationId\n }\n}",
  "variables": {
    "solutionInstanceId": "2d38b2ec-xxxx-xxx-xxxx-b4ec68084266"
  }
}

Response Examples

{
  "data": {
    "removeSolutionInstance": {
      "clientMutationId": null
    }
  }
}