Register Connector
POST
/v2/connector/register
const url = 'http://localhost:3000/v2/connector/register';const form = new FormData();form.append('file3', 'file');
const options = {method: 'POST'};
options.body = form;
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:3000/v2/connector/register \ --header 'Content-Type: multipart/form-data' \ --form file3=@fileRegisters a connector by uploading a file.
Request Body required
Section titled “Request Body required ” Media type multipart/form-data
object
file3
Connector distribution file to upload.
string format: binary
Responses
Section titled “ Responses ”Connector registered successfully.
Media type application/json
object
id
string
ver
string
ts
string format: date-time
params
object
status
string
resmsgid
string
responseCode
string
result
object
message
string
Example
{ "id": "api.connector.register", "ver": "v2", "ts": "2024-11-19T09:28:47+00:00", "params": { "status": "SUCCESS", "resmsgid": "fc2ce24f-a333-479f-931c-024d61039801" }, "responseCode": "OK", "result": { "message": "connector registered successfully." }}Internal server error while registering the connector.
Media type application/json
object
id
string
ver
string
ts
string format: date-time
params
object
status
string
resmsgid
string
responseCode
string
error
object
code
string
message
string
trace
string
Example
{ "id": "api.connector.register", "ver": "v2", "ts": "2024-11-19T09:50:21+00:00", "params": { "status": "FAILED", "resmsgid": "ebaad9d7-c0d4-47e4-8cde-87fb25eef739" }, "responseCode": "INTERNAL_SERVER_ERROR", "error": { "code": "FAILED_TO_REGISTER_CONNECTOR", "message": "Failed to Extract the File", "trace": "" }}