List Operations

listRuns

Returns a paginated list of execution runs.

query ListRuns($limit: Int = 10, $offset: Int = 0, $configId: ID) {
  listRuns(limit: $limit, offset: $offset, configId: $configId) {
    items {
      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
        }
      }
    }
    total
  }
}

listApis

Returns a paginated list of API configurations.

query ListApis($limit: Int = 10, $offset: Int = 0) {
  listApis(limit: $limit, offset: $offset) {
    items {
      id
      urlHost
      urlPath
      method
      instruction
      authentication
      createdAt
      updatedAt
    }
    total
  }
}

listTransforms

Returns a paginated list of transform configurations.

query ListTransforms($limit: Int = 10, $offset: Int = 0) {
  listTransforms(limit: $limit, offset: $offset) {
    items {
      id
      instruction
      responseSchema
      responseMapping
      createdAt
      updatedAt
    }
    total
  }
}

listExtracts

Returns a paginated list of extract configurations.

query ListExtracts($limit: Int = 10, $offset: Int = 0) {
  listExtracts(limit: $limit, offset: $offset) {
    items {
      id
      urlHost
      urlPath
      fileType
      decompressionMethod
      instruction
      authentication
      createdAt
      updatedAt
    }
    total
  }
}

listWorkflows

Returns a paginated list of workflow configurations.

query ListWorkflows($limit: Int = 10, $offset: Int = 0) {
  listWorkflows(limit: $limit, offset: $offset) {
    id
    version
    createdAt
    updatedAt
    steps {
      id
      apiConfig {
        id
        urlHost
        urlPath
        method
        instruction
        authentication
      }
      executionMode
      loopSelector
      loopMaxIters
      inputMapping
      responseMapping
    }
    finalTransform
    responseSchema
  }
}

Get Operations

getRun

Retrieves a specific execution run by ID.

query GetRun($id: ID!) {
  getRun(id: $id) {
    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
      }
    }
  }
}

getApi

Retrieves a specific API configuration by ID.

query GetApi($id: ID!) {
  getApi(id: $id) {
    id
    urlHost
    urlPath
    method
    instruction
    headers
    queryParams
    authentication
    responseSchema
    responseMapping
    pagination {
      type
      pageSize
      cursorPath
    }
    dataPath
    createdAt
    updatedAt
  }
}

getTransform

Retrieves a specific transform configuration by ID.

query GetTransform($id: ID!) {
  getTransform(id: $id) {
    id
    instruction
    responseSchema
    responseMapping
    createdAt
    updatedAt
  }
}

getExtract

Retrieves a specific extract configuration by ID.

query GetExtract($id: ID!) {
  getExtract(id: $id) {
    id
    urlHost
    urlPath
    fileType
    decompressionMethod
    instruction
    authentication
    createdAt
    updatedAt
  }
}

getWorkflow

Retrieves a specific workflow configuration by ID.

query GetWorkflow($id: ID!) {
  getWorkflow(id: $id) {
    id
    version
    createdAt
    updatedAt
    steps {
      id
      apiConfig {
        id
        urlHost
        urlPath
        method
        instruction
        authentication
      }
      executionMode
      loopSelector
      loopMaxIters
      inputMapping
      responseMapping
    }
    finalTransform
    responseSchema
  }
}

generateSchema

Generates a JSON schema based on instructions and optional response data.

query GenerateSchema($instruction: String!, $responseData: String) {
  generateSchema(instruction: $instruction, responseData: $responseData)
}