Event & Records Connection API (1.0.0)
Download OpenAPI specification:Download
API powering the ingestion of Events and Records.
Create fetch URL job
Add an ingestion job that will fetch data from an URL.
Authorizations:
(appIdapiKey)
Request Body schema: application/json
| type required | string (taskType) Value: "csv" The type of the task executed. |
| uniqueIDColumn | string The name of the column that hold the unique identifier. |
required | object (postURLJobInput) The input of the job. |
required | object (postURLJobTarget) The target of the job. |
Responses
Request samples
- Payload
Content type
application/json
{- "type": "csv",
- "uniqueIDColumn": "objectID",
- "input": {
- "url": "string",
- "method": "GET",
- "auth": {
- "type": "basic",
- "login": "johndoe",
- "password": "mypassword"
}
}, - "target": {
- "type": "search",
- "indexName": "my_index_name",
- "operation": "replace"
}
}Response samples
- 200
- 400
Content type
application/json
{- "task": {
- "id": "e0f6db8a-24f5-4092-83a4-1b2c6cb6d809",
- "type": "csv"
}
}