Configure explore specifications for Self-Serve Sources (Batch SDK)

Last update: August 9, 2023

CREATED FOR:

  • Developer

Explore specifications defines the parameters required for exploring and inspecting objects contained in your source. Explore specifications also defines the response format returned when objects are explored and inspected.

TIP
Explore specifications are hard-coded and you can simply copy and paste the payload below to your connection specification.
"exploreSpec": {
  "name": "Resource",
  "type": "Resource",
  "requestSpec": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "type": "object"
  },
  "responseSpec": {
    "$schema": "http: //json-schema.org/draft-07/schema#",
    "type": "object",
    "properties": {
      "format": {
        "type": "string"
      },
      "schema": {
        "type": "object",
        "properties": {
          "columns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "data": {
        "type": "array",
        "items": {
          "type": "object"
        }
      }
    }
  }
}
Explore specificationsDescriptionExample
nameDefines the name or identifier of the explore specification.Resource
typeDefines the type of the explore specification.Resource
requestSpecContains the parameters required to explore objects in the connection.
requestSpec.typeDefines the data type of the request specification.object
responseSpecContains the parameters that define the format of the response message returned against an explore call.
responseSpec.typeDefines the data type of the response specification.object
responseSpec.propertiesContains information pertaining to how the response message is formatted.
responseSpec.properties.formatDefines the formatting of the response schema.object
responseSpec.properties.format.typeDefines the data type of properties.string
responseSpec.schemaContains information pertaining to how the response schema is formatted.
responseSpec.schema.typeDefines the data type of the schema.object
responseSpec.schema.propertiesContains information on the columns, type, and items held within a schema.
responseSpec.schema.properties.columns.items.properties.nameDisplays the name of the file.
responseSpec.schema.properties.columns.items.properties.name.typeDefines the data type of the file name.string

Next steps

With your explore specifications populated, you can proceed to create a complete connection specification using the Flow Service API. See the Self-Serve Sources (Batch SDK) API guide for more information.

Previous pageConfigure source specification
Next pageSelf-Serve Sources (Batch SDK) API overview

Experience Platform