Execute Operations

call

Executes an API call with the given configuration. Supports both one-time configurations and saved endpoints.

mutation Call($input: ApiInputRequest!, $payload: JSON, $credentials: JSON, $options: RequestOptions) {
  call(input: $input, payload: $payload, credentials: $credentials, options: $options) {
    id
    success
    error
    startedAt
    completedAt
    data
    config {
      ... on ApiConfig {
        id
        urlHost
        urlPath
        method
        instruction
        authentication
        createdAt
        updatedAt
      }
      ... on ExtractConfig {
        id
        urlHost
        urlPath
        fileType
        decompressionMethod
        instruction
        authentication
        createdAt
        updatedAt
      }
      ... on TransformConfig {
        id
        instruction
        responseSchema
        responseMapping
        createdAt
        updatedAt
      }
    }
  }
}

extract

Extracts data from a file or API response. Handles decompression and parsing of various file formats.

mutation Extract($input: ExtractInputRequest!, $payload: JSON, $credentials: JSON, $options: RequestOptions) {
  extract(input: $input, payload: $payload, credentials: $credentials, options: $options) {
    id
    success
    error
    startedAt
    completedAt
    data
    config {
      ... on ExtractConfig {
        id
        urlHost
        urlPath
        fileType
        decompressionMethod
        instruction
        authentication
        createdAt
        updatedAt
      }
    }
  }
}

transform

Transforms data using JSONata expressions and validates against a schema.

mutation Transform($input: TransformInputRequest!, $data: JSON!, $options: RequestOptions) {
  transform(input: $input, data: $data, options: $options) {
    id
    success
    error
    startedAt
    completedAt
    data
    config {
      ... on TransformConfig {
        id
        instruction
        responseSchema
        responseMapping
        createdAt
        updatedAt
      }
    }
  }
}

executeWorkflow

Executes a workflow (multiple APIs or Endpoints) in a single call.

mutation ExecuteWorkflow($input: WorkflowInputRequest!, $payload: JSON, $credentials: JSON, $options: RequestOptions) {
  executeWorkflow(input: $input, payload: $payload, credentials: $credentials, options: $options) {
    success
    data
    finalTransform
    stepResults {
      stepId
      success
      rawData
      transformedData
      error
    }
    error
    startedAt
    completedAt
  }
}

Configuration Management

upsertApi

Creates or updates an API configuration.

mutation UpsertApi($id: ID!, $input: JSON!) {
  upsertApi(id: $id, input: $input) {
    id
    urlHost
    urlPath
    method
    instruction
    headers
    queryParams
    body
    authentication
    responseSchema
    responseMapping
    pagination {
      type
      pageSize
      cursorPath
    }
    dataPath
    updatedAt
  }
}

deleteApi

Deletes an API configuration. Returns true if successful.

mutation DeleteApi($id: ID!) {
  deleteApi(id: $id)
}

upsertExtraction

Creates or updates an extraction configuration.

mutation UpsertExtraction($id: ID!, $input: JSON!) {
  upsertExtraction(id: $id, input: $input) {
    id
    urlHost
    urlPath
    instruction
    fileType
    decompressionMethod
  }
}

deleteExtraction

Deletes an extraction configuration. Returns true if successful.

mutation DeleteExtraction($id: ID!) {
  deleteExtraction(id: $id)
}

upsertTransformation

Creates or updates a transformation configuration.

mutation UpsertTransformation($id: ID!, $input: JSON!) {
  upsertTransformation(id: $id, input: $input) {
    id
    instruction
    responseSchema
    responseMapping
  }
}

deleteTransformation

Deletes a transformation configuration. Returns true if successful.

mutation DeleteTransformation($id: ID!) {
  deleteTransformation(id: $id)
}

upsertWorkflow

Creates or updates a workflow configuration.

mutation UpsertWorkflow($id: ID!, $input: JSON!) {
  upsertWorkflow(id: $id, input: $input) {
    id
    steps { id /* ... */ }
    finalTransform
  }
}

deleteWorkflow

Deletes a workflow configuration. Returns true if successful.

mutation DeleteWorkflow($id: ID!) {
  deleteWorkflow(id: $id)
}

See also: