Skip to content

ExtractedParameter

Source code in docs_src/capo_glue/types/extracted_parameter.py 
14
15
16
17
18
19
20
21
22
23
24
class ExtractedParameter(TypedDict, closed=True):
    key: NotRequired["capo_glue.types.connector_property_key.ConnectorPropertyKey"]
    """<p>The parameter key name that will be used in subsequent requests.</p>"""
    default_value: NotRequired["capo_glue.types.default_value.DefaultValue"]
    """<p>The default value to use if the parameter cannot be extracted from the response.</p>"""
    property_location: NotRequired["capo_glue.types.property_location.PropertyLocation"]
    """<p>Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.</p>"""
    value: NotRequired[
        "capo_glue.types.response_extraction_mapping.ResponseExtractionMapping"
    ]
    """<p>The JSON path or extraction mapping that defines how to extract the parameter value from API responses.</p>"""

default_value instance-attribute 

default_value: NotRequired[DefaultValue]

The default value to use if the parameter cannot be extracted from the response.

key instance-attribute 

key: NotRequired[ConnectorPropertyKey]

The parameter key name that will be used in subsequent requests.

property_location instance-attribute 

property_location: NotRequired[PropertyLocation]

Specifies where this extracted parameter should be placed in subsequent requests, such as in headers, query parameters, or request body.

value instance-attribute 

value: NotRequired[ResponseExtractionMapping]

The JSON path or extraction mapping that defines how to extract the parameter value from API responses.