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
        method
      }
    }
  }
}

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
        fileType
        decompressionMethod
      }
    }
  }
}

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
        responseSchema
        responseMapping
      }
    }
  }
}

Configuration Management

upsertApi

Creates or updates an API configuration. Preserves existing fields unless explicitly overwritten.

mutation UpsertApi($id: ID!, $input: JSON!) {
  upsertApi(id: $id, input: $input) {
    id
    urlHost
    urlPath
    method
    headers
    queryParams
    body
    authentication
    updatedAt
  }
}

deleteApi

Deletes an API configuration. Returns true if successful.

upsertExtraction

Creates or updates an extraction configuration. Similar to upsertApi but for ExtractConfig.

deleteExtraction

Deletes an extraction configuration. Returns true if successful.

upsertTransformation

Creates or updates a transformation configuration. Similar to upsertApi but for TransformConfig.

deleteTransformation

Deletes a transformation configuration. Returns true if successful.

See also:

Was this page helpful?