Skip to main content

testInstance Mutation

Initiates execution of an Instance for the purposes of testing.

Access is permitted when any of the following condition(s) are met: 1. The signed-in User has any of the following permissions for the associated Organization: [org_manage_instances]. 2. The signed-in User has any of the following permissions for the object: [instance_edit]. 3. The signed-in User has any of the following permissions for the object's 'customer' attribute: [customer_admin_manage_instances].

Input fields (TestInstanceInput!)#

ArgumentTypeDescription
payloadStringThe payload to send with the POST request that triggers the Instance.
contentTypeStringThe content type of the payload to send with the POST request that triggers the Integration Test Instance.
idIDThe ID of the Instance to mutate.
clientMutationIdStringA unique identifier for the client performing the mutation.

Return fields (TestInstancePayload)#

testInstanceResult (TestInstanceResult)#
errors ([ErrorType])#
clientMutationId (String)#