27 lines
1.4 KiB
JSON
27 lines
1.4 KiB
JSON
{
|
|
"type": "API Path Parameters",
|
|
"definition": {
|
|
"text": "Path parameters are the type of parameters that are embedded as part of an URL path. They could be fixed string of texts or they could be a parameter that is replaced by the API Fetcher Bot for some value at runtime.",
|
|
"updated": 1621018106262
|
|
},
|
|
"paragraphs": [
|
|
{
|
|
"style": "Text",
|
|
"text": "When found at an API Map they define the default values for each parameter, whicle when found at a Data Mine, they define the actual values to be used, which overrides the defaults.",
|
|
"updated": 1621022867854
|
|
},
|
|
{
|
|
"style": "Title",
|
|
"text": "How to identify them?"
|
|
},
|
|
{
|
|
"style": "Text",
|
|
"text": "The API your are trying to map shold have it's API Path Parameters documented. If not, check any example provided there of how to request the data and see if there are inner folders below the folder of the API Enpoint. These folders are, each one, one API Path Parameter that needs to be defined. As everything else in Superalgos, this current node children are considered clockwise, that defines the order in which the path will be constructed at runtime."
|
|
},
|
|
{
|
|
"style": "Include",
|
|
"text": "Superalgos->Topic->Data Mining - Fetching Data From APIs->Main Workflow",
|
|
"updated": 1621951167309
|
|
}
|
|
]
|
|
} |