{
    "type": "API Path Parameter",
    "definition": {
        "text": "A path parameter defines the unique path to your endpoint. \nFor a full description of how to identify a path parameter see the API Path Parameters page.",
        "updated": 1622774607176
    },
    "paragraphs": [
        {
            "style": "Text",
            "text": "A path parameter can be a fixed string of text defined at an API Path Parameter node, or it can be dynamically replaced by the API Fetcher Bot for a value generated at runtime.",
            "updated": 1622772709866
        },
        {
            "style": "Title",
            "text": "API Path Parameter Configuration",
            "updated": 1622895766034
        },
        {
            "style": "Subtitle",
            "text": "Properties"
        },
        {
            "style": "List",
            "text": "codeName: This property holds the value used to help build the request URL.",
            "updated": 1622773158340
        },
        {
            "style": "Important",
            "text": "Be careful to write the exact string specified in the API documentation. Extra spaces, or capital letters will break the URL and cause it to return an error.",
            "updated": 1622773133088
        },
        {
            "style": "List",
            "text": "isString: Define if the path parameter is a string or not."
        },
        {
            "style": "List",
            "text": "isOptional: Define if this path parameter is optional or not."
        },
        {
            "style": "List",
            "text": "description: Define a basic description of what this path parameter accomplishes. "
        },
        {
            "style": "List",
            "text": "replaceBy: [Optional] This property allows you to instruct the API Fetcher Bot to set a value to this parameter replacing the current default and using contextual information available only at runtime.",
            "updated": 1622863592804
        },
        {
            "style": "Text",
            "text": "Here is an example of an API Path Parameter config:"
        },
        {
            "style": "Json",
            "text": "{\n    \"codeName\": \"currentBaseAsset\",\n    \"isString\": true,\n    \"isOptional\": false,\n    \"description\": \"Get statistics for the current base asset\",\n    \"replaceBy\": \"@BaseAssetNameLowercase\"\n}",
            "updated": 1622774822924
        },
        {
            "style": "Include",
            "text": "Foundations->Concept->replaceBy Config Property->How To Use It",
            "updated": 1622477440806
        }
    ]
}