Search tool templates

POST

https://api.youratlas.com/v1/api/tools/templates

POST

/v1/api/tools/templates

$ curl -X POST https://api.youratlas.com/v1/api/tools/templates \
>      -H "api-key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "@odata.context": "https://api.youratlas.com/v1/api/$metadata#tools/templates",
3   "@search.nextPageParameters": {},
4   "value": [
5     {
6       "@search.score": 1.1,
7       "PartitionKey": "ToolTemplates",
8       "RowKey": "template-12345",
9       "Timestamp": "2024-01-15T09:30:00Z",
10       "odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
11       "Name": "Customer Feedback Survey",
12       "Categories": "[\"Survey\",\"Customer Engagement\",\"Feedback\"]",
13       "TemplateSettings": "{\"language\":\"en-US\",\"maxResponses\":1000}",
14       "Placeholders": "[{\"name\":\"customerName\",\"type\":\"string\"},{\"name\":\"surveyLink\",\"type\":\"url\"}]",
15       "OptionalPlaceholders": "[\"customerName\"]",
16       "RequiredPlaceholders": "[\"surveyLink\"]",
17       "Version": "1.2.0",
18       "IsActive": true,
19       "Status": "Approved",
20       "IconUrl": "https://cdn.youratlas.com/icons/survey-template.png",
21       "DocumentationUrl": "https://docs.youratlas.com/templates/customer-feedback-survey",
22       "CreatedAt": "2023-11-20T08:00:00Z",
23       "UpdatedAt": "2024-01-10T12:00:00Z"
24     }
25   ]
26 }

Search endpoint (not a create). Returns an Azure Cognitive Search result envelope.

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Request

This endpoint expects an object.

querystringOptional

categorieslist of stringsOptional

Response

Search results

@odata.contextstringOptional

@search.nextPageParametersobjectOptional

valuelist of objectsOptional

Errors

500

Internal Server Error